feat: add skip-if-message-contains option

Author: JamesHenry

README.md

@@ -118,6 +118,11 @@ jobs:
     # E.g. 'ci.yml'. If not provided, current workflow id will be used
     #
     workflow-id: ''
+
+    # If an otherwise matching commit contains any of the messages in this comma separated list, do not consider the commit. Useful for conventions like [skip ci]
+    #
+    # Default: ""
+    skip-if-message-contains: ''
 ```
 
 <!-- end configuration-options -->

action.yml

@@ -29,6 +29,10 @@ inputs:
     default: '.'
   workflow-id:
     description: 'The ID of the workflow to track or name of the file name. E.g. ci.yml. Defaults to current workflow'
+  skip-if-message-contains:
+    description: 'If an otherwise matching commit contains any of the messages in this comma separated list, do not consider the commit. Useful for conventions like [skip ci]'
+    required: false
+    default: ''
 
 outputs:
   base:

dist/nx-set-shas.js

@@ -22713,6 +22713,8 @@ var workingDirectory = core.getInput("working-directory");
 var workflowId = core.getInput("workflow-id");
 var fallbackSHA = core.getInput("fallback-sha");
 var remote = core.getInput("remote");
+var skipIfMessageContains = !core.getInput("skip-if-message-contains") ? [] : core.getInput("skip-if-message-contains").split(",").map((message) => message.trim());
+var VERBOSE_LOGGING = process.env.NX_SET_SHAS_VERBOSE_LOGGING === "true";
 var defaultWorkingDirectory = ".";
 var BASE_SHA;
 (async () => {
@@ -22859,22 +22861,59 @@ async function findExistingCommit(octokit, branchName, shas) {
 }
 async function commitExists(octokit, branchName, commitSha) {
   try {
-    spawnSync("git", ["cat-file", "-e", commitSha], {
-      stdio: ["pipe", "pipe", null]
+    if (VERBOSE_LOGGING) {
+      console.log(`[Debug]: Checking if commit ${commitSha} exists in the checked out repo...`);
+    }
+    const catFileResult = spawnSync("git", ["cat-file", "-p", commitSha], {
+      stdio: ["pipe", "pipe", null],
+      encoding: "utf-8"
     });
+    if (catFileResult.status !== 0) {
+      return false;
+    }
+    if (VERBOSE_LOGGING) {
+      console.log(`[Debug]: Commit ${commitSha} exists in the checked out repo`);
+    }
+    if (skipIfMessageContains.length > 0) {
+      if (VERBOSE_LOGGING) {
+        console.log(`[Debug]: Checking if commit ${commitSha} contains the any of the following messages: ${skipIfMessageContains.join(", ")}`);
+      }
+      if (skipIfMessageContains.some((message) => catFileResult.stdout.includes(message))) {
+        if (VERBOSE_LOGGING) {
+          console.log(`[Debug]: Commit ${commitSha} contains the message: ${skipIfMessageContains}. Skipping commit.`);
+        }
+        return true;
+      }
+    }
+    if (VERBOSE_LOGGING) {
+      console.log(`[Debug]: Checking if commit ${commitSha} exists anywhere in the remote repo...`);
+    }
     await octokit.request("GET /repos/{owner}/{repo}/commits/{commit_sha}", {
       owner,
       repo,
       commit_sha: commitSha
     });
+    if (VERBOSE_LOGGING) {
+      console.log(`[Debug]:Commit ${commitSha} exists in the remote repo`);
+    }
+    if (VERBOSE_LOGGING) {
+      console.log(`[Debug]: Checking if commit ${commitSha} exists on the expected branch (${branchName})...`);
+    }
     const commits = await octokit.request("GET /repos/{owner}/{repo}/commits", {
       owner,
       repo,
       sha: branchName,
       per_page: 100
     });
+    if (VERBOSE_LOGGING) {
+      console.log(`[Debug]: Commit ${commitSha} exists on the expected branch (${branchName})`);
+    }
     return commits.data.some((commit) => commit.sha === commitSha);
-  } catch {
+  } catch (err) {
+    if (VERBOSE_LOGGING) {
+      console.log(`[Debug]: Commit ${commitSha} not found based on the previous check. Raw error:`);
+      console.log(err);
+    }
     return false;
   }
 }

nx-set-shas.ts

@@ -19,6 +19,17 @@ const workingDirectory = core.getInput('working-directory');
 const workflowId = core.getInput('workflow-id');
 const fallbackSHA = core.getInput('fallback-sha');
 const remote = core.getInput('remote');
+const skipIfMessageContains: string[] = !core.getInput(
+  'skip-if-message-contains',
+)
+  ? []
+  : core
+      .getInput('skip-if-message-contains')
+      .split(',')
+      .map((message) => message.trim());
+
+const VERBOSE_LOGGING = process.env.NX_SET_SHAS_VERBOSE_LOGGING === 'true';
+
 const defaultWorkingDirectory = '.';
 
 let BASE_SHA: string;
@@ -244,29 +255,86 @@ async function commitExists(
   commitSha: string,
 ): Promise<boolean> {
   try {
-    spawnSync('git', ['cat-file', '-e', commitSha], {
+    if (VERBOSE_LOGGING) {
+      console.log(
+        `[Debug]: Checking if commit ${commitSha} exists in the checked out repo...`,
+      );
+    }
+    const catFileResult = spawnSync('git', ['cat-file', '-p', commitSha], {
       stdio: ['pipe', 'pipe', null],
+      encoding: 'utf-8',
     });
+    if (catFileResult.status !== 0) {
+      return false;
+    }
+    if (VERBOSE_LOGGING) {
+      console.log(
+        `[Debug]: Commit ${commitSha} exists in the checked out repo`,
+      );
+    }
+    if (skipIfMessageContains.length > 0) {
+      if (VERBOSE_LOGGING) {
+        console.log(
+          `[Debug]: Checking if commit ${commitSha} contains the any of the following messages: ${skipIfMessageContains.join(', ')}`,
+        );
+      }
+      if (
+        skipIfMessageContains.some((message) =>
+          catFileResult.stdout.includes(message),
+        )
+      ) {
+        if (VERBOSE_LOGGING) {
+          console.log(
+            `[Debug]: Commit ${commitSha} contains the message: ${skipIfMessageContains}. Skipping commit.`,
+          );
+        }
+        return true;
+      }
+    }
 
     // Check the commit exists in general
+    if (VERBOSE_LOGGING) {
+      console.log(
+        `[Debug]: Checking if commit ${commitSha} exists anywhere in the remote repo...`,
+      );
+    }
     await octokit.request('GET /repos/{owner}/{repo}/commits/{commit_sha}', {
       owner,
       repo,
       commit_sha: commitSha,
     });
+    if (VERBOSE_LOGGING) {
+      console.log(`[Debug]:Commit ${commitSha} exists in the remote repo`);
+    }
 
     // Check the commit exists on the expected main branch (it will not in the case of a rebased main branch)
+    if (VERBOSE_LOGGING) {
+      console.log(
+        `[Debug]: Checking if commit ${commitSha} exists on the expected branch (${branchName})...`,
+      );
+    }
     const commits = await octokit.request('GET /repos/{owner}/{repo}/commits', {
       owner,
       repo,
       sha: branchName,
       per_page: 100,
     });
+    if (VERBOSE_LOGGING) {
+      console.log(
+        `[Debug]: Commit ${commitSha} exists on the expected branch (${branchName})`,
+      );
+    }
 
     return commits.data.some(
       (commit: { sha: string }) => commit.sha === commitSha,
     );
-  } catch {
+  } catch (err) {
+    if (VERBOSE_LOGGING) {
+      console.log(
+        `[Debug]: Commit ${commitSha} not found based on the previous check. Raw error:`,
+      );
+      console.log(err);
+    }
     return false;
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "private": true,
-  "version": "4.3.2",
+  "version": "4.4.0",
   "license": "MIT",
   "description": "This package.json is here purely to control the version of the Action, in combination with https://github.com/JamesHenry/publish-shell-action",
   "scripts": {