feat: build for release

Author: github-actions[bot]

action.yml

@@ -9,6 +9,10 @@ inputs:
     description: Secret GitHub API token to use for making API requests.
     default: ${{ github.token }}
     required: true
+  TARGET_RUN_ID:
+    description: Target run id
+    default: ${{ github.run_id }}
+    required: true
   EXCLUDE_MERGED:
     description: Whether to exclude merge push.
     required: false
@@ -21,6 +25,13 @@ inputs:
     description: Whether to exclude tag push.
     required: false
     default: 'true'
+  CONSIDER_RE_RUN:
+    description: Whether to consider re-run.
+    required: false
+    default: 'false'
+  INTERVAL_MS:
+    description: Interval milliseconds
+    required: false
 
 branding:
   icon: 'x-circle'

build.json

@@ -1 +1 @@
-{"owner":"technote-space","repo":"auto-cancel-redundant-workflow","sha":"FETCH_HEAD","ref":"refs/heads/master","tagName":"test/v1.6.7","branch":"gh-actions","tags":["test/v1.6.7","test/v1.6","test/v1"],"updated_at":"2021-01-05T14:22:51.820Z"}
+{"owner":"technote-space","repo":"auto-cancel-redundant-workflow","sha":"FETCH_HEAD","ref":"refs/heads/master","tagName":"test/v1.6.7","branch":"gh-actions","tags":["test/v1.6.7","test/v1.6","test/v1"],"updated_at":"2021-01-05T17:22:55.525Z"}

lib/process.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.execute = void 0;
 const core_1 = require("@actions/core");
+const github_action_helper_1 = require("@technote-space/github-action-helper");
 const misc_1 = require("./utils/misc");
 const workflow_1 = require("./utils/workflow");
 const execute = async (logger, octokit, context) => {
@@ -10,9 +11,9 @@ const execute = async (logger, octokit, context) => {
         core_1.setOutput('ids', '');
         return;
     }
-    const runId = misc_1.getRunId();
+    const runId = misc_1.getTargetRunId(context);
     logger.info('run id: %d', runId);
-    const run = await workflow_1.getWorkflowRun(octokit, context);
+    const run = await workflow_1.getWorkflowRun(runId, octokit, context);
     logger.startProcess('run:');
     console.log(misc_1.getFilteredRun(run));
     logger.endProcess();
@@ -22,22 +23,25 @@ const execute = async (logger, octokit, context) => {
     logger.startProcess('workflow runs:');
     console.log(runs.map(run => misc_1.getFilteredRun(run)));
     logger.endProcess();
+    // cancel all workflows except latest one (consider re-run)
+    const runsWithUpdatedAt = runs.map(run => ({ ...run, updatedAt: workflow_1.getWorkflowRunUpdatedAt(run) }));
+    const latestRunNumber = Math.max(...runsWithUpdatedAt.map(run => workflow_1.getWorkflowRunNumber(run)));
+    const latestUpdatedAt = Math.max(...runsWithUpdatedAt.map(run => run.updatedAt));
+    const targetRuns = runsWithUpdatedAt.filter(run => workflow_1.getWorkflowRunNumber(run) < latestRunNumber && // not latest run
+        (!misc_1.isConsiderReRun() || run.updatedAt < latestUpdatedAt));
     logger.log();
-    const runsWithCreatedAtTime = runs.filter(run => run.id !== runId).map(run => ({ ...run, createdAt: Date.parse(workflow_1.getWorkflowRunCreatedAt(run)) }));
-    const createdAt = Date.parse(workflow_1.getWorkflowRunCreatedAt(run));
-    const runNumber = workflow_1.getWorkflowRunNumber(run);
-    if (runsWithCreatedAtTime.find(run => run.createdAt > createdAt || (run.createdAt === createdAt && workflow_1.getWorkflowRunNumber(run) > runNumber))) {
-        logger.info(logger.c('newer job exists', { color: 'yellow' }));
-        core_1.setOutput('ids', '');
-        return;
-    }
     logger.startProcess('Cancelling...');
-    await Promise.all(runsWithCreatedAtTime.map(run => {
+    const interval = misc_1.getIntervalMs();
+    await targetRuns.reduce(async (prev, run) => {
+        await prev;
         logger.log('cancel: %d', run.id);
-        return workflow_1.cancelWorkflowRun(run.id, octokit, context);
-    }));
-    logger.info('total: %d', runsWithCreatedAtTime.length);
-    core_1.setOutput('ids', runsWithCreatedAtTime.map(run => run.id).join(','));
+        await workflow_1.cancelWorkflowRun(run.id, octokit, context);
+        if (interval) {
+            await github_action_helper_1.Utils.sleep(interval);
+        }
+    }, Promise.resolve());
+    logger.info('total: %d', targetRuns.length);
+    core_1.setOutput('ids', targetRuns.map(run => run.id).join(','));
     logger.endProcess();
 };
 exports.execute = execute;

lib/utils/misc.js

@@ -1,20 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFilteredRun = exports.getTargetBranch = exports.getRunId = exports.isNotExcludeRun = exports.isExcludeContext = void 0;
+exports.getFilteredRun = exports.getTargetBranch = exports.getTargetRunId = exports.isNotExcludeRun = exports.isExcludeContext = exports.getIntervalMs = exports.isConsiderReRun = void 0;
 const core_1 = require("@actions/core");
 const github_action_helper_1 = require("@technote-space/github-action-helper");
 const constant_1 = require("../constant");
 const getMergeMessagePrefix = () => github_action_helper_1.Utils.getPrefixRegExp(core_1.getInput('MERGE_MESSAGE_PREFIX'));
 const isExcludeMerged = () => github_action_helper_1.Utils.getBoolValue(core_1.getInput('EXCLUDE_MERGED'));
 const isExcludeTagPush = () => github_action_helper_1.Utils.getBoolValue(core_1.getInput('EXCLUDE_TAG_PUSH'));
+const parseNumber = (value, defaultValue) => {
+    if (value && /^\d+$/.test(value)) {
+        return Number(value);
+    }
+    return defaultValue;
+};
+const isConsiderReRun = () => github_action_helper_1.Utils.getBoolValue(core_1.getInput('CONSIDER_RE_RUN'));
+exports.isConsiderReRun = isConsiderReRun;
+const getIntervalMs = () => parseNumber(core_1.getInput('INTERVAL_MS'), undefined);
+exports.getIntervalMs = getIntervalMs;
 const isExcludeContext = (context) => github_action_helper_1.ContextHelper.isPush(context) && ((isExcludeTagPush() && github_action_helper_1.Utils.isTagRef(context)) ||
     (isExcludeMerged() && getMergeMessagePrefix().test(context.payload.head_commit.message)));
 exports.isExcludeContext = isExcludeContext;
 const isNotExcludeRun = (run) => !isExcludeMerged() || !getMergeMessagePrefix().test(run.head_commit.message);
 exports.isNotExcludeRun = isNotExcludeRun;
-const getRunId = () => Number(process.env.GITHUB_RUN_ID);
-exports.getRunId = getRunId;
-const getTargetBranch = async (octokit, context) => {
+const getTargetRunId = (context) => parseNumber(core_1.getInput('TARGET_RUN_ID'), context.runId);
+exports.getTargetRunId = getTargetRunId;
+const getTargetBranch = async (context) => {
     if (context.payload.pull_request) {
         return context.payload.pull_request.head.ref;
     }

lib/utils/workflow.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cancelWorkflowRun = exports.getWorkflowRuns = exports.getWorkflowRunNumber = exports.getWorkflowRunCreatedAt = exports.getWorkflowId = exports.getWorkflowRun = void 0;
+exports.cancelWorkflowRun = exports.getWorkflowRuns = exports.getWorkflowRunNumber = exports.getWorkflowRunUpdatedAt = exports.getWorkflowId = exports.getWorkflowRun = void 0;
 const github_action_helper_1 = require("@technote-space/github-action-helper");
 const misc_1 = require("./misc");
-const getWorkflowRun = async (octokit, context) => {
+const getWorkflowRun = async (runId, octokit, context) => {
     return (await octokit.actions.getWorkflowRun({
         owner: context.repo.owner,
         repo: context.repo.repo,
-        'run_id': Number(process.env.GITHUB_RUN_ID),
+        'run_id': runId,
     })).data;
 };
 exports.getWorkflowRun = getWorkflowRun;
@@ -19,8 +19,8 @@ const getWorkflowId = (run) => {
     return Number(matches[0]);
 };
 exports.getWorkflowId = getWorkflowId;
-const getWorkflowRunCreatedAt = (run) => github_action_helper_1.Utils.ensureNotNull(run.created_at);
-exports.getWorkflowRunCreatedAt = getWorkflowRunCreatedAt;
+const getWorkflowRunUpdatedAt = (run) => Date.parse(github_action_helper_1.Utils.ensureNotNull(run.updated_at));
+exports.getWorkflowRunUpdatedAt = getWorkflowRunUpdatedAt;
 const getWorkflowRunNumber = (run) => run.run_number;
 exports.getWorkflowRunNumber = getWorkflowRunNumber;
 const getWorkflowRuns = async (workflowId, logger, octokit, context) => {
@@ -29,7 +29,7 @@ const getWorkflowRuns = async (workflowId, logger, octokit, context) => {
         'workflow_id': workflowId,
         status: 'in_progress',
     };
-    const branch = await misc_1.getTargetBranch(octokit, context);
+    const branch = await misc_1.getTargetBranch(context);
     logger.log('target event: %s', logger.c(context.eventName, { color: 'green' }));
     if (branch) {
         logger.log('target branch: %s', logger.c(branch, { color: 'green' }));
@@ -43,7 +43,6 @@ const getWorkflowRuns = async (workflowId, logger, octokit, context) => {
     options)).map(run => run).filter(run => run.event === context.eventName).filter(misc_1.isNotExcludeRun);
 };
 exports.getWorkflowRuns = getWorkflowRuns;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const cancelWorkflowRun = async (runId, octokit, context) => octokit.actions.cancelWorkflowRun({
     ...context.repo,
     'run_id': runId,