@ckeditor/ckeditor5-dev-ci 40.3.1 → 40.5.0-alpha.0

package/bin/circle-disable-auto-cancel-builds.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const circleUpdateAutoCancelBuilds = require( '../lib/circle-update-auto-cancel-builds' );
+
+/**
+ * This script updates CircleCI settings to disable the "Auto-cancel redundant workflows" option.
+ *
+ * It's needed when triggering a release process via CI to avoid canceling the release workflow by pushing
+ * a new commit (the released one) that will trigger a new pipeline.
+ *
+ * In order to integrate the action in your pipeline, you need prepare a few environment variables:
+ *
+ *   - CKE5_CIRCLE_TOKEN - an authorization token to talk to CircleCI REST API.
+ *   - CKE5_GITHUB_ORGANIZATION - your GitHub organization.
+ *   - CKE5_GITHUB_REPOSITORY - your GitHub repository.
+ *
+ * Example usage:
+ * CKE5_CIRCLE_TOKEN=... ckeditor5-dev-ci-circle-disable-auto-cancel-builds
+ */
+
+const {
+	CKE5_CIRCLE_TOKEN,
+	CKE5_GITHUB_ORGANIZATION,
+	CKE5_GITHUB_REPOSITORY
+} = process.env;
+
+const options = {
+	circleToken: CKE5_CIRCLE_TOKEN,
+	githubOrganization: CKE5_GITHUB_ORGANIZATION,
+	githubRepository: CKE5_GITHUB_REPOSITORY,
+	newValue: false
+};
+
+circleUpdateAutoCancelBuilds( options )
+	.then( () => {
+		console.log( 'Auto-cancel redundant workflows is now disabled.' );
+	} )
+	.catch( err => {
+		console.error( err );
+
+		process.exit( 1 );
+	} );

package/bin/circle-enable-auto-cancel-builds.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const circleUpdateAutoCancelBuilds = require( '../lib/circle-update-auto-cancel-builds' );
+
+/**
+ * This script updates CircleCI settings to enable the "Auto-cancel redundant workflows" option.
+ *
+ * It should be done only if a release workflow uses the `ckeditor5-dev-ci-circle-disable-auto-cancel-builds`
+ * script to disable the same option.
+ *
+ * In order to integrate the action in your pipeline, you need prepare a few environment variables:
+ *
+ *   - CKE5_CIRCLE_TOKEN - an authorization token to talk to CircleCI REST API.
+ *   - CKE5_GITHUB_ORGANIZATION - your GitHub organization.
+ *   - CKE5_GITHUB_REPOSITORY - your GitHub repository.
+ *
+ * Example usage:
+ * CKE5_CIRCLE_TOKEN=... ckeditor5-dev-ci-circle-enable-auto-cancel-builds
+ */
+
+const {
+	CKE5_CIRCLE_TOKEN,
+	CKE5_GITHUB_ORGANIZATION,
+	CKE5_GITHUB_REPOSITORY
+} = process.env;
+
+const options = {
+	circleToken: CKE5_CIRCLE_TOKEN,
+	githubOrganization: CKE5_GITHUB_ORGANIZATION,
+	githubRepository: CKE5_GITHUB_REPOSITORY,
+	newValue: true
+};
+
+circleUpdateAutoCancelBuilds( options )
+	.then( () => {
+		console.log( 'Auto-cancel redundant workflows is now enabled.' );
+	} )
+	.catch( err => {
+		console.error( err );
+
+		process.exit( 1 );
+	} );

package/bin/is-job-triggered-by-member.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const isJobTriggeredByMember = require( '../lib/is-job-triggered-by-member' );
+
+/**
+ * This script checks if a user that approved an approval job could do that.
+ *
+ * In order to integrate the action in your pipeline, you need prepare a few environment variables:
+ *
+ *   - CIRCLE_WORKFLOW_ID - provided by default by CircleCI and keeps a unique id of the CI build.
+ *   - CKE5_CIRCLE_TOKEN - an authorization token to talk to CircleCI REST API.
+ *   - CKE5_CIRCLE_APPROVAL_JOB_NAME - a job name to verify.
+ *   - CKE5_GITHUB_TOKEN - a GitHub token used for authorization a request.
+ *   - CKE5_GITHUB_TEAM_SLUG - a GitHub team slug that defines accounts that could approve the job.
+ *   - CKE5_GITHUB_ORGANIZATION - your GitHub organization.
+ *
+ * Example usage:
+ * CKE5_CIRCLE_TOKEN=... ckeditor5-dev-ci-is-job-triggered-by-member
+ */
+
+const {
+	CIRCLE_WORKFLOW_ID,
+	CKE5_CIRCLE_TOKEN,
+	CKE5_CIRCLE_APPROVAL_JOB_NAME,
+	CKE5_GITHUB_TOKEN,
+	CKE5_GITHUB_TEAM_SLUG,
+	CKE5_GITHUB_ORGANIZATION
+} = process.env;
+
+const options = {
+	circleToken: CKE5_CIRCLE_TOKEN,
+	circleWorkflowId: CIRCLE_WORKFLOW_ID,
+	circleApprovalJobName: CKE5_CIRCLE_APPROVAL_JOB_NAME,
+	githubOrganization: CKE5_GITHUB_ORGANIZATION,
+	githubTeamSlug: CKE5_GITHUB_TEAM_SLUG,
+	githubToken: CKE5_GITHUB_TOKEN
+};
+
+isJobTriggeredByMember( options )
+	.then( result => {
+		if ( !result ) {
+			console.log( `This account cannot approve the "${ options.circleApprovalJobName }" job. Aborting.` );
+			process.exit( 1 );
+		}
+
+		console.log( `The "${ options.circleApprovalJobName }" job was approved by a team member.` );
+	} )
+	.catch( err => {
+		console.error( err );
+
+		process.exit( 1 );
+	} );

package/bin/trigger-circle-build.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const triggerCircleBuild = require( '../lib/trigger-circle-build' );
+
+/**
+ * This script triggers a new CircleCI build.
+ *
+ * In order to integrate the action in your pipeline, you need prepare a few environment variables:
+ *
+ *   - CIRCLE_BRANCH - provided by default by CircleCI and keeps the git branch of processed build.
+ *   - CKE5_COMMIT_SHA1 - a full commit identifier of the processed the build.
+ *   - CKE5_CIRCLE_TOKEN - an authorization token to talk to CircleCI REST API.
+ *   - CKE5_GITHUB_REPOSITORY_SLUG - a repository slug (org/name) where a new build will be started.
+ *   - CKE5_GITHUB_RELEASE_BRANCH - (optional) define a branch that leads the release process.
+ *   - CKE5_GITHUB_TRIGGER_REPOSITORY_SLUG - (optional) a repository slug (org/name) that triggers a new build.
+ *
+ * Example usage:
+ * CKE5_CIRCLE_TOKEN=... ckeditor5-dev-ci-trigger-circle-build
+ */
+
+const {
+	CKE5_COMMIT_SHA1,
+	CIRCLE_BRANCH,
+	CKE5_CIRCLE_TOKEN,
+	CKE5_GITHUB_RELEASE_BRANCH,
+	CKE5_GITHUB_REPOSITORY_SLUG,
+	CKE5_GITHUB_TRIGGER_REPOSITORY_SLUG
+} = process.env;
+
+const options = {
+	circleToken: CKE5_CIRCLE_TOKEN,
+	commit: CKE5_COMMIT_SHA1,
+	branch: CIRCLE_BRANCH,
+	releaseBranch: CKE5_GITHUB_RELEASE_BRANCH,
+	repositorySlug: CKE5_GITHUB_REPOSITORY_SLUG
+};
+
+if ( CKE5_GITHUB_TRIGGER_REPOSITORY_SLUG ) {
+	options.triggerRepositorySlug = CKE5_GITHUB_TRIGGER_REPOSITORY_SLUG;
+}
+
+triggerCircleBuild( options )
+	.then( () => {
+		console.log( 'CI triggered successfully.' );
+	} )
+	.catch( err => {
+		console.error( err );
+
+		process.exit( 1 );
+	} );

package/lib/circle-update-auto-cancel-builds.js

@@ -0,0 +1,43 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const fetch = require( 'node-fetch' );
+
+/**
+ * @param options
+ * @param {String} options.circleToken
+ * @param {String} options.githubOrganization
+ * @param {String} options.githubRepository
+ * @param {Boolean} options.newValue
+ * @return {Promise.<Boolean>}
+ */
+module.exports = async function circleUpdateAutoCancelBuilds( options ) {
+	const {
+		circleToken,
+		githubOrganization,
+		githubRepository,
+		newValue
+	} = options;
+
+	const circleRequestOptions = {
+		method: 'patch',
+		headers: {
+			'Content-Type': 'application/json',
+			'Circle-Token': circleToken
+		},
+		body: JSON.stringify( {
+			advanced: {
+				autocancel_builds: newValue
+			}
+		} )
+	};
+
+	const settingsUpdateUrl = `https://circleci.com/api/v2/project/github/${ githubOrganization }/${ githubRepository }/settings`;
+
+	return fetch( settingsUpdateUrl, circleRequestOptions )
+		.then( r => r.json() );
+};

package/lib/index.js

@@ -0,0 +1,11 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+module.exports = {
+	getJobApprover: require( './utils/get-job-approver' ),
+	members: require( './data/members.json' )
+};

package/lib/is-job-triggered-by-member.js

@@ -0,0 +1,44 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const { Octokit } = require( '@octokit/rest' );
+const getJobApprover = require( './utils/get-job-approver' );
+
+/**
+ * @param options
+ * @param {String} options.circleToken
+ * @param {String} options.circleWorkflowId
+ * @param {String} options.circleApprovalJobName
+ * @param {String} options.githubOrganization
+ * @param {String} options.githubTeamSlug
+ * @param {String} options.githubToken
+ * @return {Promise.<Boolean>}
+ */
+module.exports = async function isJobTriggeredByMember( options ) {
+	const {
+		circleToken,
+		circleWorkflowId,
+		circleApprovalJobName,
+		githubOrganization,
+		githubTeamSlug,
+		githubToken
+	} = options;
+
+	const login = await getJobApprover( circleToken, circleWorkflowId, circleApprovalJobName );
+	const octokit = new Octokit( { auth: githubToken } );
+	const { data } = await octokit.request( 'GET /orgs/{org}/teams/{team_slug}/members', {
+		org: githubOrganization,
+		team_slug: githubTeamSlug,
+		headers: {
+			'X-GitHub-Api-Version': '2022-11-28'
+		}
+	} );
+
+	return data
+		.map( ( { login } ) => login )
+		.includes( login );
+};

package/lib/trigger-circle-build.js

@@ -0,0 +1,61 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/* eslint-env node */
+
+const fetch = require( 'node-fetch' );
+
+/**
+ * @param options
+ * @param {String} options.circleToken
+ * @param {String} options.commit
+ * @param {String} options.branch
+ * @param {String} options.repositorySlug A repository slug (org/name) where a new build will be started.
+ * @param {String|null} [options.releaseBranch=null] Define a branch that leads the release process.
+ * @param {String|null} [options.triggerRepositorySlug=null] A repository slug (org/name) that triggers a new build.
+ * @return {Promise}
+ */
+module.exports = async function triggerCircleBuild( options ) {
+	const {
+		circleToken,
+		commit,
+		branch,
+		repositorySlug,
+		releaseBranch = null,
+		triggerRepositorySlug = null
+	} = options;
+
+	const requestUrl = `https://circleci.com/api/v2/project/github/${ repositorySlug }/pipeline`;
+
+	const parameters = {
+		triggerCommitHash: commit
+	};
+
+	if ( releaseBranch ) {
+		parameters.isRelease = branch === releaseBranch;
+	}
+
+	if ( triggerRepositorySlug ) {
+		parameters.triggerRepositorySlug = triggerRepositorySlug;
+	}
+
+	const requestOptions = {
+		method: 'post',
+		headers: {
+			'Content-Type': 'application/json',
+			'Accept': 'application/json',
+			'Circle-Token': circleToken
+		},
+		body: JSON.stringify( { branch, parameters } )
+	};
+
+	return fetch( requestUrl, requestOptions )
+		.then( res => res.json() )
+		.then( response => {
+			if ( response.error_message ) {
+				throw new Error( `CI trigger failed: "${ response.error_message }".` );
+			}
+		} );
+};

package/lib/utils/get-job-approver.js

@@ -0,0 +1,38 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const fetch = require( 'node-fetch' );
+
+/**
+ * Returns a promise that resolves to GitHub name of a developer who approved the `jobName` job.
+ *
+ * @param {String} circleCiToken
+ * @param {String} workflowId
+ * @param {String} jobName
+ * @returns {Promise.<String>}
+ */
+module.exports = async function getJobApprover( circleCiToken, workflowId, jobName ) {
+	const circleRequestOptions = {
+		method: 'get',
+		headers: {
+			'Content-Type': 'application/json',
+			'Accept': 'application/json',
+			'Circle-Token': circleCiToken
+		}
+	};
+
+	// Find an identifier of a developer who approved an approval job.
+	const workflowJobsUrl = `https://circleci.com/api/v2/workflow/${ workflowId }/job`;
+	const workflowJobs = await fetch( workflowJobsUrl, circleRequestOptions ).then( r => r.json() );
+	const { approved_by: approvedBy } = workflowJobs.items.find( job => job.name === jobName );
+
+	// Find a username based on the identifier.
+	const userDetailsUrl = `https://circleci.com/api/v2/user/${ approvedBy }`;
+	const { login } = await fetch( userDetailsUrl, circleRequestOptions ).then( r => r.json() );
+
+	return login;
+};

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@ckeditor/ckeditor5-dev-ci",
-  "version": "40.3.1",
+  "version": "40.5.0-alpha.0",
   "description": "Utils used on various Continuous Integration services.",
   "keywords": [],
+  "main": "lib/index.js",
   "dependencies": {
     "minimist": "^1.2.5",
     "node-fetch": "^2.6.7",
@@ -21,7 +22,11 @@
     "ckeditor5-dev-ci-notify-circle-status": "bin/notify-circle-status.js",
     "ckeditor5-dev-ci-circle-workflow-notifier": "bin/circle-workflow-notifier.js",
     "ckeditor5-dev-ci-allocate-swap-memory": "bin/allocate-swap-memory.sh",
-    "ckeditor5-dev-ci-install-latest-chrome": "bin/install-latest-chrome.sh"
+    "ckeditor5-dev-ci-install-latest-chrome": "bin/install-latest-chrome.sh",
+    "ckeditor5-dev-ci-is-job-triggered-by-member": "bin/is-job-triggered-by-member.js",
+    "ckeditor5-dev-ci-trigger-circle-build": "bin/trigger-circle-build.js",
+    "ckeditor5-dev-ci-circle-disable-auto-cancel-builds": "bin/circle-disable-auto-cancel-builds.js",
+    "ckeditor5-dev-ci-circle-enable-auto-cancel-builds": "bin/circle-enable-auto-cancel-builds.js"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",