feat: add allow not run workflow option (#55)

* feat: add allow not run workflow option

* fix: Update src/commands/set-shas.yml

* Update custom.yml

* Update src/scripts/set-shas.sh

* Update find-successful-workflow.js

* Update find-successful-workflow.js

---------

Co-authored-by: Miroslav Jonaš <missing.manual@gmail.com>

Author: eladhaim

src/commands/set-shas.yml

@@ -25,6 +25,12 @@ parameters:
     description: |
       By default, only workflows with CircleCI status of "success" will be detected for the main branch.
       Enable this option to also detect workflows with CircleCI status of "on_hold" in case your workflow requires manual approvals.
+  allow-not-run-workflow:
+    type: boolean
+    default: false
+    description: |
+      By default, only workflows with CircleCI status of "success" will be detected for the main branch.
+      Enable this option to also detect workflows with CircleCI status of "not_run" in case your workflow requires manual approvals.
   skip-branch-filter:
     type: boolean
     default: false
@@ -39,6 +45,7 @@ steps:
         PARAM_ERROR_ON_NO_SUCCESSFUL_WORKFLOW: <<parameters.error-on-no-successful-workflow>>
         PARAM_WORKFLOW_NAME: <<parameters.workflow-name>>
         PARAM_ALLOW_ON_HOLD: <<parameters.allow-on-hold-workflow>>
+        PARAM_ALLOW_NOT_RUN: <<parameters.allow-not-run-workflow>>
         PARAM_SKIP_BRANCH_FILTER: <<parameters.skip-branch-filter>>
         PARAM_SCRIPT: <<include(scripts/find-successful-workflow.js)>>
       name: Derives SHAs for base and head for use in `nx affected` commands

src/scripts/find-successful-workflow.js

@@ -7,8 +7,9 @@ const branchName = process.argv[3];
 const mainBranchName = process.env.MAIN_BRANCH_NAME || process.argv[4];
 const errorOnNoSuccessfulWorkflow = process.argv[5] === '1';
 const allowOnHoldWorkflow = process.argv[6] === '1';
-const skipBranchFilter = process.argv[7] === '1';
-const workflowName = process.argv[8];
+const allowNotRunWorkflow = process.argv[7] == '1';
+const skipBranchFilter = process.argv[8] === '1';
+const workflowName = process.argv[9];
 const circleToken = process.env.CIRCLE_API_TOKEN;
 
 const [, host, project] = buildUrl.match(/https?:\/\/([^\/]+)\/(.*)\/\d+/);
@@ -139,11 +140,28 @@ function commitExists(commitSha) {
 
 async function isWorkflowSuccessful(pipelineId, workflowName) {
   if (!workflowName) {
-    return getJson(`https://${host}/api/v2/pipeline/${pipelineId}/workflow`)
-      .then(({ items }) => items.every(item => (item.status === 'success') || (allowOnHoldWorkflow && item.status === 'on_hold')));
+    return getJson(
+      `https://${host}/api/v2/pipeline/${pipelineId}/workflow`
+    ).then(({ items }) =>
+      items.every(
+        (item) =>
+          item.status === 'success' ||
+          (allowOnHoldWorkflow && item.status === 'on_hold') ||
+          (allowNotRunWorkflow && item.status === 'not_run')
+      )
+    );
   } else {
-    return getJson(`https://${host}/api/v2/pipeline/${pipelineId}/workflow`)
-      .then(({ items }) => items.some(item => ((item.status === 'success') || (allowOnHoldWorkflow && item.status === 'on_hold')) && item.name === workflowName));
+    return getJson(
+      `https://${host}/api/v2/pipeline/${pipelineId}/workflow`
+    ).then(({ items }) =>
+      items.some(
+        (item) =>
+          (item.status === 'success' ||
+            (allowOnHoldWorkflow && item.status === 'on_hold') ||
+            (allowNotRunWorkflow && item.status === 'not_run')) &&
+          item.name === workflowName
+      )
+    );
   }
 }
 

src/scripts/set-shas.sh

@@ -6,7 +6,7 @@ if [ -z "$CIRCLE_BRANCH" ]; then
 else
   TARGET_BRANCH=$CIRCLE_BRANCH
 fi
-RESPONSE=$(node index.cjs $CIRCLE_BUILD_URL $TARGET_BRANCH $PARAM_MAIN_BRANCH $PARAM_ERROR_ON_NO_SUCCESSFUL_WORKFLOW $PARAM_ALLOW_ON_HOLD $PARAM_SKIP_BRANCH_FILTER $PARAM_WORKFLOW_NAME)
+RESPONSE=$(node index.cjs $CIRCLE_BUILD_URL $TARGET_BRANCH $PARAM_MAIN_BRANCH $PARAM_ERROR_ON_NO_SUCCESSFUL_WORKFLOW $PARAM_ALLOW_ON_HOLD $PARAM_ALLOW_NOT_RUN $PARAM_SKIP_BRANCH_FILTER $PARAM_WORKFLOW_NAME)
 echo "$RESPONSE"
 BASE_SHA=$(echo "$RESPONSE" | grep 'Commit:' | sed 's/.*Commit: //')
 HEAD_SHA=$(git rev-parse HEAD)