release-ckeditor5.js 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. #!/usr/bin/env node
  2. /**
  3. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  4. * For licensing, see LICENSE.md.
  5. */
  6. /* eslint-env node */
  7. 'use strict';
  8. const path = require( 'path' );
  9. const { tools, logger } = require( '@ckeditor/ckeditor5-dev-utils' );
  10. const versionUtils = require( '@ckeditor/ckeditor5-dev-env/lib/release-tools/utils/versions' );
  11. const cli = require( '@ckeditor/ckeditor5-dev-env/lib/release-tools/utils/cli' );
  12. const createGithubRelease = require( '@ckeditor/ckeditor5-dev-env/lib/release-tools/utils/creategithubrelease' );
  13. const validatePackageToRelease = require( '@ckeditor/ckeditor5-dev-env/lib/release-tools/utils/validatepackagetorelease' );
  14. const { getChangesForVersion } = require( '@ckeditor/ckeditor5-dev-env/lib/release-tools/utils/changelog' );
  15. const log = logger();
  16. const packageJsonPath = path.resolve( __dirname, '..', '..', 'package.json' );
  17. let packageJsonCopy;
  18. cli.provideToken()
  19. .then( token => {
  20. const gitVersion = versionUtils.getLastTagFromGit();
  21. const changelogVersion = versionUtils.getLastFromChangelog();
  22. log.info( 'Comparing versions - saved in changelog and as a tag...' );
  23. // If the last tag is equal to version saved in changelog, we don't have new version for release.
  24. if ( gitVersion === changelogVersion ) {
  25. return reject( 'Before starting the release process, you should generate the changelog.' );
  26. }
  27. const releaseDescription = getChangesForVersion( changelogVersion );
  28. log.info( 'Validating the repository for the release...' );
  29. const errors = validatePackageToRelease( {
  30. version: changelogVersion,
  31. changes: releaseDescription
  32. } );
  33. // Abort due to errors during validation.
  34. if ( errors.length ) {
  35. const log = logger();
  36. log.error( 'Unexpected errors occured:' );
  37. errors.map( err => '* ' + err ).forEach( log.error.bind( log ) );
  38. return reject( 'Releasing has been aborted due to errors.' );
  39. }
  40. log.info( 'Bumping the version...' );
  41. // Bump the version.
  42. tools.shExec( `npm version ${ changelogVersion } --message "Release: v${ changelogVersion }."`, { verbosity: 'error' } );
  43. log.info( 'Updating the package.json...' );
  44. // Update the `package.json`. Published package shouldn't have any dependencies and devDependencies.
  45. // Also, we should omit our environment scripts and their configs.
  46. tools.updateJSONFile( packageJsonPath, packageJson => {
  47. // Save the original file. It will be restored after publishing the package.
  48. packageJsonCopy = Object.assign( {}, packageJson );
  49. // Remove unnecessary things.
  50. delete packageJson.dependencies;
  51. delete packageJson.devDependencies;
  52. delete packageJson.scripts;
  53. delete packageJson[ 'lint-staged' ];
  54. delete packageJson.eslintIgnore;
  55. // Update the package's description.
  56. // eslint-disable-next-line max-len
  57. packageJson.description = 'A set of ready-to-use rich text editors created with a powerful framework. Made with real-time collaborative editing in mind.';
  58. // The files listed below will be published even if they won't be specified under the `files` key in package.json.
  59. // However, instead of creating the `.npmignore` file and specifying everything here, we can list files that we want to publish.
  60. packageJson.files = [
  61. 'CHANGELOG.md',
  62. 'LICENSE.md',
  63. 'README.md',
  64. 'package.json'
  65. ];
  66. return packageJson;
  67. } );
  68. log.info( 'Publishing on npm...' );
  69. // Publish the package on npm.
  70. tools.shExec( 'npm publish' );
  71. log.info( 'Creating a release on GitHub...' );
  72. // Create a release on GitHub.
  73. return createGithubRelease( token, {
  74. repositoryOwner: 'ckeditor',
  75. repositoryName: 'ckeditor5',
  76. version: changelogVersion,
  77. description: releaseDescription
  78. } );
  79. } )
  80. .then( () => {
  81. log.info( 'Restoring the package.json...' );
  82. // Restore the `package.json` to state before the publishing process.
  83. tools.updateJSONFile( packageJsonPath, () => packageJsonCopy );
  84. const url = `https://github.com/ckeditor/ckeditor5/releases/tag/v${ packageJsonCopy.version }`;
  85. log.info( `Created the release: ${ url }` );
  86. } )
  87. .catch( err => {
  88. log.error( err.stack );
  89. } );
  90. function reject( message ) {
  91. return Promise.reject( new Error( message ) );
  92. }