@ckeditor/ckeditor5-dev-ci 44.0.0-alpha.5 → 44.1.0

package/bin/circle-workflow-notifier.js

@@ -118,10 +118,10 @@ async function getOtherJobsData() {
 }
 
 /**
- * @param {Array.<String>} args
- * @returns {Object} result
- * @returns {String} result.task
- * @returns {Array<String>} result.ignore
+ * @param {Array.<string>} args
+ * @returns {object} result
+ * @returns {string} result.task
+ * @returns {Array.<string>} result.ignore
  */
 function parseArguments( args ) {
 	const config = {

package/bin/is-workflow-restarted.js

@@ -0,0 +1,46 @@
+#!/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 */
+
+/**
+ * This script checks if the provided workflow has been restarted. If so, it exits with a zero error code.
+ *
+ * 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 the workflow id.
+ *   - CKE5_CIRCLE_TOKEN - an authorization token to talk to CircleCI REST API.
+ *
+ * Example usage:
+ * CKE5_CIRCLE_TOKEN=... ckeditor5-dev-ci-is-workflow-restarted
+ */
+
+const {
+	CKE5_CIRCLE_TOKEN,
+	CIRCLE_WORKFLOW_ID
+} = process.env;
+
+const requestUrl = `https://circleci.com/api/v2/workflow/${ CIRCLE_WORKFLOW_ID }`;
+
+const requestOptions = {
+	method: 'GET',
+	headers: {
+		'Circle-Token': CKE5_CIRCLE_TOKEN
+	}
+};
+
+fetch( requestUrl, requestOptions )
+	.then( res => res.json() )
+	.then( response => {
+		const { tag = '' } = response;
+
+		if ( tag.startsWith( 'rerun' ) ) {
+			return process.exit( 0 );
+		}
+
+		return process.exit( 1 );
+	} );

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

@@ -5,11 +5,11 @@
 
 /**
  * @param options
- * @param {String} options.circleToken
- * @param {String} options.githubOrganization
- * @param {String} options.githubRepository
- * @param {Boolean} options.newValue
- * @return {Promise.<Boolean>}
+ * @param {string} options.circleToken
+ * @param {string} options.githubOrganization
+ * @param {string} options.githubRepository
+ * @param {boolean} options.newValue
+ * @returns {Promise.<boolean>}
  */
 export default async function circleUpdateAutoCancelBuilds( options ) {
 	const {

package/lib/format-message.js

@@ -10,20 +10,20 @@ import { bots, members } from './data/index.js';
 const REPOSITORY_REGEXP = /github\.com\/([^/]+)\/([^/]+)/;
 
 /**
- * @param {Object} options
- * @param {String} options.slackMessageUsername
- * @param {String} options.iconUrl
- * @param {String} options.repositoryOwner
- * @param {String} options.repositoryName
- * @param {String} options.branch
- * @param {String} options.buildTitle
- * @param {String} options.buildUrl
- * @param {String} options.buildId
- * @param {String} options.githubToken
- * @param {String} options.triggeringCommitUrl
- * @param {Number} options.startTime
- * @param {Number} options.endTime
- * @param {Boolean} options.shouldHideAuthor
+ * @param {object} options
+ * @param {string} options.slackMessageUsername
+ * @param {string} options.iconUrl
+ * @param {string} options.repositoryOwner
+ * @param {string} options.repositoryName
+ * @param {string} options.branch
+ * @param {string} options.buildTitle
+ * @param {string} options.buildUrl
+ * @param {string} options.buildId
+ * @param {string} options.githubToken
+ * @param {string} options.triggeringCommitUrl
+ * @param {number} options.startTime
+ * @param {number} options.endTime
+ * @param {boolean} options.shouldHideAuthor
  */
 export default async function formatMessage( options ) {
 	const commitDetails = await getCommitDetails( options.triggeringCommitUrl, options.githubToken );
@@ -64,11 +64,11 @@ export default async function formatMessage( options ) {
 /**
  * Returns the additional message that will be added to the notifier post.
  *
- * @param {Object} options
- * @param {Boolean} options.shouldHideAuthor
- * @param {String|null} options.githubAccount
- * @param {String} options.commitAuthor
- * @returns {String}
+ * @param {object} options
+ * @param {boolean} options.shouldHideAuthor
+ * @param {string|null} options.githubAccount
+ * @param {string} options.commitAuthor
+ * @returns {string}
  */
 function getNotifierMessage( options ) {
 	if ( options.shouldHideAuthor ) {
@@ -95,8 +95,8 @@ function getNotifierMessage( options ) {
 }
 
 /**
- * @param {String|null} githubAccount
- * @returns {String|null}
+ * @param {string|null} githubAccount
+ * @returns {string|null}
  */
 function findSlackAccount( githubAccount ) {
 	if ( !githubAccount ) {
@@ -116,9 +116,9 @@ function findSlackAccount( githubAccount ) {
  * Returns string representing amount of time passed between two timestamps.
  * Timestamps should be in seconds instead of milliseconds.
  *
- * @param {Number} startTime
- * @param {Number} endTime
- * @returns {String}
+ * @param {number} startTime
+ * @param {number} endTime
+ * @returns {string}
  */
 function getExecutionTime( startTime, endTime ) {
 	if ( !startTime || !endTime ) {
@@ -155,8 +155,8 @@ function getExecutionTime( startTime, endTime ) {
 /**
  * Replaces `#Id` and `Repo/Owner#Id` with URls to Github Issues.
  *
- * @param {String} commitMessage
- * @param {String} triggeringCommitUrl
+ * @param {string} commitMessage
+ * @param {string} triggeringCommitUrl
  * @returns {string}
  */
 function getFormattedMessage( commitMessage, triggeringCommitUrl ) {
@@ -178,9 +178,9 @@ function getFormattedMessage( commitMessage, triggeringCommitUrl ) {
 /**
  * Returns a promise that resolves the commit details (author and message) based on the specified GitHub URL.
  *
- * @param {String} triggeringCommitUrl The URL to the commit on GitHub.
- * @param {String} githubToken Github token used for authorization a request,
- * @returns {Promise.<Object>}
+ * @param {string} triggeringCommitUrl The URL to the commit on GitHub.
+ * @param {string} githubToken Github token used for authorization a request,
+ * @returns {Promise.<object>}
  */
 function getCommitDetails( triggeringCommitUrl, githubToken ) {
 	const apiGithubUrlCommit = getGithubApiUrl( triggeringCommitUrl );
@@ -205,8 +205,8 @@ function getCommitDetails( triggeringCommitUrl, githubToken ) {
 /**
  * Returns a URL to GitHub API which returns details of the commit that caused the CI to fail its job.
  *
- * @param {String} triggeringCommitUrl The URL to the commit on GitHub.
- * @returns {String}
+ * @param {string} triggeringCommitUrl The URL to the commit on GitHub.
+ * @returns {string}
  */
 function getGithubApiUrl( triggeringCommitUrl ) {
 	return triggeringCommitUrl.replace( 'github.com/', 'api.github.com/repos/' ).replace( '/commit/', '/commits/' );

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

@@ -8,13 +8,13 @@ import getJobApprover from './utils/get-job-approver.js';
 
 /**
  * @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>}
+ * @param {string} options.circleToken
+ * @param {string} options.circleWorkflowId
+ * @param {string} options.circleApprovalJobName
+ * @param {string} options.githubOrganization
+ * @param {string} options.githubTeamSlug
+ * @param {string} options.githubToken
+ * @returns {Promise.<boolean>}
  */
 export default async function isJobTriggeredByMember( options ) {
 	const {

package/lib/process-job-statuses.js

@@ -57,7 +57,7 @@ export default function processJobStatuses( jobs ) {
 
 /**
  * @param {WorkflowJob} job
- * @returns {Boolean}
+ * @returns {boolean}
  */
 function isJobFailed( job ) {
 	if ( job.status === 'failed' ) {
@@ -81,11 +81,11 @@ function clone( obj ) {
 }
 
 /**
- * @typedef {Object} WorkflowJob
+ * @typedef {object} WorkflowJob
  *
- * @property {String} id
+ * @property {string} id
  *
  * @property {'blocked'|'running'|'failed'|'failed_parent'|'success'} status
  *
- * @property {Array.<String>} dependencies
+ * @property {Array.<string>} dependencies
  */

package/lib/trigger-circle-build.js

@@ -7,13 +7,13 @@
 
 /**
  * @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}
+ * @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.
+ * @returns {Promise}
  */
 export default async function triggerCircleBuild( options ) {
 	const {

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

@@ -6,10 +6,10 @@
 /**
  * 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>}
+ * @param {string} circleCiToken
+ * @param {string} workflowId
+ * @param {string} jobName
+ * @returns {Promise.<string>}
  */
 export default async function getJobApprover( circleCiToken, workflowId, jobName ) {
 	const circleRequestOptions = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-ci",
-  "version": "44.0.0-alpha.5",
+  "version": "44.1.0",
   "description": "Utils used on various Continuous Integration services.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -29,6 +29,7 @@
     "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-is-job-triggered-by-member": "bin/is-job-triggered-by-member.js",
+    "ckeditor5-dev-ci-is-workflow-restarted": "bin/is-workflow-restarted.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"