| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112 |
- #!/usr/bin/env node
- /**
- * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /* eslint-env node */
- 'use strict';
- /*
- This script is to be used on CI to automatically update https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/.
- */
- // Build the documentation only when master branch is updated.
- if ( process.env.TRAVIS_BRANCH !== 'master' ) {
- process.exit();
- }
- // Build the documentation only when a cron task triggered the CI.
- if ( process.env.TRAVIS_EVENT_TYPE !== 'cron' ) {
- process.exit();
- }
- const path = require( 'path' );
- const ROOT_PATH = process.cwd();
- const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
- const mainRepoUrl = 'https://github.com/CKEditor5/ckeditor5.github.io';
- // The assumption here is that the script is called from ckeditor5/.
- const projectVersion = require( path.join( process.cwd(), 'package.json' ) ).version;
- // Clone the CKEditor 5 page.
- console.log( 'Cloning ckeditor5.github.io repository...' );
- exec( `git clone ${ mainRepoUrl }.git` );
- // Build the documentation.
- console.log( 'Building documentation...' );
- exec( 'yarn run docs --production' );
- console.log( 'Copying files...' );
- // Remove existing documentation.
- exec( `rm -rf ckeditor5.github.io/docs/nightly/ckeditor5/${ projectVersion }` );
- exec( 'rm -rf ckeditor5.github.io/docs/nightly/ckeditor5/latest' );
- // Copy built documentation to the new destination.
- exec( 'cp -R build/docs/* ckeditor5.github.io/docs/nightly/' );
- // Umberto makes a symlink between the latest version (`projectVersion`) and "latest/" directory.
- // The symlink must be deleted in order to copy a documentation for `projectVersion` as `latest`.
- exec( 'rm -rf ckeditor5.github.io/docs/nightly/ckeditor5/latest' );
- // Copy the versioned documentation to latest/.
- exec( `cp -R ckeditor5.github.io/docs/nightly/ckeditor5/${ projectVersion } ckeditor5.github.io/docs/nightly/ckeditor5/latest` );
- // Change work directory in order to make a commit in CKEditor 5 page's repository.
- process.chdir( path.join( ROOT_PATH, 'ckeditor5.github.io' ) );
- exec( `echo "https://${ process.env.GITHUB_TOKEN }:@github.com" > .git/credentials 2> /dev/null` );
- exec( 'git config credential.helper "store --file=.git/credentials"' );
- // Commit the documentation.
- if ( exec( 'git diff --name-only docs/' ).trim().length ) {
- exec( 'git add docs/' );
- exec( 'git commit -m "Documentation build."' );
- exec( 'git push origin master --quiet' );
- const lastCommit = exec( 'git log -1 --format="%h"' );
- console.log( `Successfully published the documentation under ${ mainRepoUrl }/commit/${ lastCommit }` );
- } else {
- console.log( 'Nothing to commit. Documentation is up to date.' );
- }
- // Every 10th day of the month, we would like to clean the history of the documentation repository.
- if ( new Date().getDate() === 10 ) {
- // Copy a commit which will be a new root in the repository.
- const commit = exec( 'git log --oneline --reverse -5 --format="%h" | head -n 1' ).trim();
- // Checkout to the status of the git repo at commit. Create a temporary branch.
- exec( `git checkout --orphan temp ${ commit }` );
- // Create a new commit that is to be the new root commit.
- exec( 'git commit -m "Documentation build."' );
- // Rebase the part of history from <commit> to master on the temporary branch.
- exec( `git rebase --onto temp ${ commit } master` );
- // Remove the temporary branch.
- exec( 'git branch -D temp' );
- // Pray.
- exec( 'git push -f' );
- }
- // Change work directory to the previous value.
- process.chdir( ROOT_PATH );
- function exec( command ) {
- try {
- return tools.shExec( command, { verbosity: 'error' } );
- }
- catch ( error ) {
- console.error( error );
- process.exit( 1 );
- }
- }
|