Merge pull request #287 from ckeditor/i/3710-release-via-ci

Internal: Release repository from CI.

Author: pomek

.circleci/config.yml

@@ -1,9 +1,15 @@
 version: 2.1
 
 parameters:
+  triggerCommitHash:
+    type: string
+    default: ""
   isNightly:
     type: boolean
     default: false
+  isRelease:
+    type: boolean
+    default: false
 
 commands:
   prepare_environment_command:
@@ -21,6 +27,7 @@ commands:
       - run:
           name: Install dependencies
           command: yarn install
+      - prepare_environment_variables_commands
 
   install_ssh_keys_command:
     description: "Install SSH keys"
@@ -29,6 +36,43 @@ commands:
           fingerprints:
             - "a0:41:a2:56:c8:7d:3f:29:41:d1:87:92:fd:50:2b:6b"
 
+  npm_login_command:
+    description: "Enable interacting with `npm` using an auth token"
+    steps:
+      - run:
+          name: Login to the npm registry using '.npmrc' file
+          command: echo "//registry.npmjs.org/:_authToken=\${CKE5_NPM_TOKEN}" > ~/.npmrc
+
+  git_credentials_command:
+    description: "Setup git configuration"
+    steps:
+      - run:
+          name: Setup git configuration
+          command: |
+            git config --global user.email "[email protected]"
+            git config --global user.name "CKEditorBot"
+
+  prepare_environment_variables_commands:
+    description: "Prepare non-secret environment variables"
+    steps:
+      - run:
+          name: Prepare environment variables
+          command: |
+            #!/bin/bash
+            
+            # Non-secret environment variables needed for the pipeline scripts.
+            CKE5_GITHUB_ORGANIZATION="ckeditor"
+            CKE5_GITHUB_REPOSITORY="ckeditor5-vue"
+            CKE5_CIRCLE_APPROVAL_JOB_NAME="release_approval"
+            CKE5_GITHUB_RELEASE_BRANCH="master"
+            
+            echo export CKE5_CIRCLE_APPROVAL_JOB_NAME=$CKE5_CIRCLE_APPROVAL_JOB_NAME >> $BASH_ENV
+            echo export CKE5_GITHUB_RELEASE_BRANCH=$CKE5_GITHUB_RELEASE_BRANCH >> $BASH_ENV
+            echo export CKE5_GITHUB_ORGANIZATION=$CKE5_GITHUB_ORGANIZATION >> $BASH_ENV
+            echo export CKE5_GITHUB_REPOSITORY=$CKE5_GITHUB_REPOSITORY >> $BASH_ENV
+            echo export CKE5_GITHUB_REPOSITORY_SLUG="$CKE5_GITHUB_ORGANIZATION/$CKE5_GITHUB_REPOSITORY" >> $BASH_ENV
+            echo export CKE5_COMMIT_SHA1=$CIRCLE_SHA1 >> $BASH_ENV
+
 jobs:
   notify_ci_failure:
     machine: true
@@ -58,7 +102,7 @@ jobs:
           command: yarn ckeditor5-dev-ci-circle-workflow-notifier
           no_output_timeout: 1h
 
-  main:
+  validate_and_tests:
     machine: true
     steps:
       - checkout
@@ -105,22 +149,139 @@ jobs:
                 name: Upload code coverage
                 command: cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
 
+  release_prepare:
+    machine: true
+    steps:
+      - checkout
+      - bootstrap_repository_command
+      - run:
+          name: Check if packages are ready to be released
+          command: npm run release:prepare-packages -- --verbose --compile-only
+
+  trigger_release_process:
+    machine: true
+    steps:
+      - checkout
+      - bootstrap_repository_command
+      - run:
+          name: Verify if the project is ready to release
+          command: |
+            #!/bin/bash
+
+            # Do not fail if the Node script ends with non-zero exit code.
+            set +e
+
+            node scripts/ci/is-project-ready-to-release.js
+            EXIT_CODE=$( echo $? )
+
+            if [ ${EXIT_CODE} -eq 1 ];
+            then
+              circleci-agent step halt
+            fi
+      - run:
+          name: Trigger the release pipeline
+          command: yarn ckeditor5-dev-ci-trigger-circle-build
+
+  release_project:
+    machine: true
+    steps:
+      - checkout
+      - bootstrap_repository_command
+      - run:
+          name: Verify the trigger commit from the repository
+          command: |
+            #!/bin/bash
+
+            CKE5_LATEST_COMMIT_HASH=$( git log -n 1 --pretty=format:%H origin/master )
+            CKE5_TRIGGER_COMMIT_HASH=<< pipeline.parameters.triggerCommitHash >>
+
+            if [[ "${CKE5_LATEST_COMMIT_HASH}" != "${CKE5_TRIGGER_COMMIT_HASH}" ]]; then
+              echo "There is a newer commit in the repository on the \`#master\` branch. Use its build to start the release."
+              circleci-agent step halt
+            fi
+      - npm_login_command
+      - git_credentials_command
+      - run:
+          name: Verify if a releaser triggered the job
+          command: |
+            #!/bin/bash
+            
+            # Do not fail if the Node script ends with non-zero exit code.
+            set +e
+    
+            yarn ckeditor5-dev-ci-is-job-triggered-by-member
+            EXIT_CODE=$( echo $? )
+    
+            if [ ${EXIT_CODE} -ne 0 ];
+            then
+              echo "Aborting the release due to failed verification of the approver (no rights to release)."
+              circleci-agent step halt
+            fi
+      - run:
+          name: Disable the redundant workflows option
+          command: yarn ckeditor5-dev-ci-circle-disable-auto-cancel-builds
+      - run:
+          name: Prepare the new version to release
+          command: npm run release:prepare-packages -- --verbose
+      - run:
+          name: Publish the packages
+          command: npm run release:publish-packages -- --verbose
+      - run:
+          name: Enable the redundant workflows option
+          command: yarn ckeditor5-dev-ci-circle-enable-auto-cancel-builds
+          when: always
+      - run:
+          name: Pack the "release/" directory (in case of failure)
+          command: |
+            zip -r ./release.zip ./release
+          when: always
+      - store_artifacts:
+          path: ./release.zip
+          when: always
+
 workflows:
   version: 2
   main:
-    unless: << pipeline.parameters.isNightly >>
+    when:
+      and:
+        - equal: [ false, << pipeline.parameters.isNightly >> ]
+        - equal: [ false, << pipeline.parameters.isRelease >> ]
     jobs:
-      - main
+      - validate_and_tests
+      - release_prepare
+      - trigger_release_process:
+          requires:
+            - validate_and_tests
+            - release_prepare
+          filters:
+            branches:
+              only:
+                - master
       - notify_ci_failure:
           filters:
             branches:
               only:
                 - master
 
+  release:
+    when:
+      and:
+        - equal: [ false, << pipeline.parameters.isNightly >> ]
+        - equal: [ true, << pipeline.parameters.isRelease >> ]
+    jobs:
+      - release_approval:
+          type: approval
+      - release_project:
+          requires:
+            - release_approval
+
   nightly:
-    when: << pipeline.parameters.isNightly >>
+    when:
+      and:
+        - equal: [ true, << pipeline.parameters.isNightly >> ]
+        - equal: [ false, << pipeline.parameters.isRelease >> ]
     jobs:
-      - main
+      - validate_and_tests
       - notify_ci_failure:
           hideAuthor: "true"
           filters:

README.md

@@ -71,31 +71,15 @@ Before releasing a new version, run a demo project to confirm that the integrati
 3. Run `npm run test` to see if the project passes all automated tests.
 4. Run `npm run build` to see if the project with the integration builds without errors.
 
-### Changelog
-
-Before starting the release process, you need to generate the changelog:
-
-```bash
-npm run changelog
-```
-
-### Publishing
-
-After generating the changelog, you are able to release the package.
-
-First, you need to bump the version:
-
-```bash
-npm run release:prepare-packages
-```
-
-After bumping the version, you can publish the changes:
-
-```bash
-npm run release:publish-packages
-```
-
-Note: The `release/` directory will be published.
+This package's release process is automated via CircleCI. Before you start a new release, you'll need to prepare the changelog entries.
+
+1. Make sure the `#master` branch is up-to-date: `git fetch && git checkout master && git pull`.
+1. Prepare a release branch: `git checkout -b release-[YYYY-MM-DD]` where `YYYY-MM-DD` is the current day.
+1. Generate the changelog entries: `yarn run changelog --branch release-[YYYY-MM-DD]`.
+   * This task checks what changed in each package and bumps the version accordingly. If nothing changes at all, it won't create a new changelog entry. If changes were irrelevant (e.g., only dependencies), it would make an "internal changes" entry.
+   * Scan the logs printed by the tool to search for errors (incorrect changelog entries). Incorrect entries (e.g., ones without the type) should be addressed. You may need to create entries for them manually. This is done directly in CHANGELOG.md (in the root directory). Make sure to verify the proposed version after you modify the changelog.
+1. Commit all changes and prepare a new pull request targeting the `#master` branch.
+1. Ping the @ckeditor/ckeditor-5-devops team to review the pull request and trigger the release process.
 
 ## License
 

package.json

@@ -52,6 +52,7 @@
     "lint-staged": "^10.2.11",
     "listr2": "^6.5.0",
     "minimist": "^1.2.5",
+    "semver": "^7.6.2",
     "typescript": "~5.4.5",
     "vite": "^5.3.1",
     "vitest": "^2.0.0",
@@ -60,6 +61,11 @@
     "vue-tsc": "^2.0.22",
     "webdriverio": "^8.39.0"
   },
+  "resolutions": {
+    "wrap-ansi": "7.0.0",
+    "string-width": "4.1.0",
+    "semver": "^7.0.0"
+  },
   "engines": {
     "node": ">=18.0.0"
   },

scripts/changelog.js

@@ -7,10 +7,16 @@
 
 /* eslint-env node */
 
+import parseArguments from './utils/parsearguments.js';
+
 /**
  * Scripts for generating the changelog before starting the release process.
  */
 
+const cliArguments = parseArguments( process.argv.slice( 2 ) );
+
 import { generateChangelogForSinglePackage } from '@ckeditor/ckeditor5-dev-release-tools';
 
-await generateChangelogForSinglePackage();
+await generateChangelogForSinglePackage( {
+	releaseBranch: cliArguments.branch
+} );

scripts/ci/is-project-ready-to-release.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* eslint-env node */
+
+import { createRequire } from 'module';
+import releaseTools from '@ckeditor/ckeditor5-dev-release-tools';
+import { execSync } from 'child_process';
+import semver from 'semver';
+
+const require = createRequire( import.meta.url );
+const { name } = require( '../../package.json' );
+
+const latestPublishedVersion = execSync( `npm view ${ name }@latest version`, { encoding: 'utf-8' } ).trim();
+const changelogVersion = releaseTools.getLastFromChangelog();
+
+if ( getVersionTag( changelogVersion ) !== 'latest' ) {
+	console.log( `Aborting due non-latest changelog version (${ changelogVersion }).` );
+	process.exit( 1 );
+}
+
+if ( semver.lte( changelogVersion, latestPublishedVersion ) ) {
+	console.log(
+		`The proposed changelog (${ changelogVersion }) version is not greater than the published one (${ latestPublishedVersion }).`
+	);
+	process.exit( 1 );
+}
+
+console.log( 'The project is ready to release.' );
+
+/**
+ * Returns an npm tag based on the specified release version.
+ *
+ * @param {String} version
+ * @returns {String}
+ */
+function getVersionTag( version ) {
+	const [ versionTag ] = semver.prerelease( version ) || [ 'latest' ];
+
+	return versionTag;
+}

scripts/postinstall.js

@@ -14,10 +14,17 @@ const ROOT_DIRECTORY = join(
 	'..'
 );
 
-// When installing a repository as a dependency, the `.git` directory does not exist.
-// In such a case, husky should not attach its hooks as npm treats it as a package, not a git repository.
-if ( existsSync( join( ROOT_DIRECTORY, '.git' ) ) ) {
-	const { install } = await import( 'husky' );
+main()
+	.catch( err => {
+		console.error( err );
+	} );
 
-	install();
+async function main() {
+	// When installing a repository as a dependency, the `.git` directory does not exist.
+	// In such a case, husky should not attach its hooks as npm treats it as a package, not a git repository.
+	if ( existsSync( join( ROOT_DIRECTORY, '.git' ) ) ) {
+		const { install } = await import( 'husky' );
+
+		install();
+	}
 }