feat: add allow not run workflow option

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>>
+        PARMA_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/examples/custom.yml

@@ -8,7 +8,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    nx: nrwl/nx@1.6.2
+    nx: nrwl/nx@1.7.2
   jobs:
     build:
       docker:

src/examples/default.yml

@@ -3,7 +3,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    nx: nrwl/nx@1.6.2
+    nx: nrwl/nx@1.7.2
   jobs:
     build:
       docker:

src/examples/private.yml

@@ -7,4 +7,4 @@ description: >
 usage:
   version: 2.1
   orbs:
-    nx: nrwl/nx@1.6.2
+    nx: nrwl/nx@1.7.2

src/examples/tags.yml

@@ -3,7 +3,7 @@ description: >
 usage:
   version: 2.1
   orbs:
-    nx: nrwl/nx@1.6.1
+    nx: nrwl/nx@1.7.2
   jobs:
     build:
       docker:

src/scripts/find-successful-workflow.js

@@ -9,6 +9,7 @@ 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[9] == '1';
 const circleToken = process.env.CIRCLE_API_TOKEN;
 
 const [, host, project] = buildUrl.match(/https?:\/\/([^\/]+)\/(.*)\/\d+/);
@@ -51,7 +52,9 @@ WARNING: Unable to find a successful workflow run on 'origin/${mainBranchName}'.
 We are therefore defaulting to use HEAD~1 on 'origin/${mainBranchName}'.
 
 NOTE: You can instead make this a hard error by settting 'error-on-no-successful-workflow' on the step in your workflow.\n\n`);
-        BASE_SHA = execSync(`git rev-parse origin/${mainBranchName}~1`, { encoding: 'utf-8' });
+        BASE_SHA = execSync(`git rev-parse origin/${mainBranchName}~1`, {
+          encoding: "utf-8",
+        });
       }
     } else {
       process.stdout.write(`
@@ -108,11 +111,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
+      )
+    );
   }
 }
 
@@ -122,8 +142,8 @@ async function getJson(url) {
 
     if (circleToken) {
       options.headers = {
-        'Circle-Token': circleToken
-      }
+        "Circle-Token": circleToken,
+      };
     }
 
     https.get(url, options, (res) => {

src/scripts/set-shas.sh

@@ -6,7 +6,7 @@ if [ -z "$CIRCLE_BRANCH" ]; then
 else
   TARGET_BRANCH=$CIRCLE_BRANCH
 fi
-RESPONSE=$(node index.js $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.js $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 $PARMA_ALLOW_NOT_RUN)
 echo "$RESPONSE"
 BASE_SHA=$(echo "$RESPONSE" | grep 'Commit:' | sed 's/.*Commit: //')
 HEAD_SHA=$(git rev-parse HEAD)