Allow overriding of head commit

action.yml

@@ -60,6 +60,10 @@ inputs:
   additional-ports:
     description: Ports the client needs to access the application in addition to the one in the app URL, as a list of comma-separated values
     required: false
+  head-sha:
+    description: |
+      Override the head commit SHA that we are analysing instead of using the one inferred automatically by Meticulous. This normally should not be set, but is useful in some scenarios.
+    required: false
 
 outputs: {}
 runs:
@@ -80,6 +84,7 @@ runs:
     TEST_SUITE_ID: ${{ inputs.test-suite-id }}
     METICULOUS_TELEMETRY_SAMPLE_RATE: "0.01"
     ADDITIONAL_PORTS: ${{ inputs.additional-ports }}
+    HEAD_SHA: ${{ inputs.head-sha }}
 branding:
   color: purple
   icon: camera

cloud-compute/action.yml

@@ -12,6 +12,10 @@ inputs:
     description: |
       The URL to execute the tests against. This URL should serve the code from the current commit (e.g. a localhost URL served up by a local server).
     required: true
+  head-sha:
+    description: |
+      Override the head commit SHA that we are analysing instead of using the one inferred automatically by Meticulous. This normally should not be set, but is useful in some scenarios.
+    required: false
 
 outputs: {}
 runs:

src/actions/cloud-compute/cloud-compute.ts

@@ -42,7 +42,7 @@ export const runMeticulousTestsCloudComputeAction = async (): Promise<void> => {
     setLogLevel("trace");
   }
 
-  const { apiToken, githubToken, appUrl } = getInCloudActionInputs();
+  const { apiToken, githubToken, appUrl, headSha } = getInCloudActionInputs();
   const { payload } = context;
   const event = getCodeChangeEvent(context.eventName, payload);
   const { owner, repo } = context.repo;
@@ -61,6 +61,7 @@ export const runMeticulousTestsCloudComputeAction = async (): Promise<void> => {
 
   const { base, head } = await getBaseAndHeadCommitShas(event, {
     useDeploymentUrl: false,
+    headSha,
   });
 
   const { shaToCompareAgainst } = await safeEnsureBaseTestsExists({

src/actions/cloud-compute/get-inputs.ts

@@ -5,10 +5,12 @@ export const getInCloudActionInputs = () => {
   const apiToken = getInput("api-token", { required: true });
   const githubToken = getInput("github-token", { required: true });
   const appUrl = getInput("app-url", { required: true });
+  const headSha = getInput("head-sha");
 
   return {
     apiToken,
     githubToken,
     appUrl,
+    headSha,
   };
 };

src/actions/main/__tests__/get-inputs.spec.ts

@@ -14,6 +14,7 @@ const keys = [
   "USE_DEPLOYMENT_URL",
   "ALLOWED_ENVIRONMENTS",
   "ADDITIONAL_PORTS",
+  "HEAD_SHA",
 ];
 
 const EXPECTED_DEFAULT_VALUES = {
@@ -30,6 +31,7 @@ const EXPECTED_DEFAULT_VALUES = {
   testsFile: null,
   testSuiteId: null,
   additionalPorts: null,
+  headSha: null,
 };
 
 describe("getMainActionInputs", () => {

src/actions/main/get-inputs.ts

@@ -67,6 +67,11 @@ export const getMainActionInputs = () => {
     required: false,
     type: "string",
   });
+  const headSha = getInputFromEnv({
+    name: "head-sha",
+    required: false,
+    type: "string",
+  });
 
   if (appUrl != null && appUrl != "" && useDeploymentUrl === true) {
     throw new Error("Cannot use both app-url and use-deployment-url");
@@ -99,5 +104,6 @@ export const getMainActionInputs = () => {
     testSuiteId,
     allowedEnvironments,
     additionalPorts,
+    headSha,
   };
 };

src/actions/main/main.ts

@@ -61,6 +61,7 @@ export const runMeticulousTestsAction = async (): Promise<void> => {
     allowedEnvironments,
     testSuiteId,
     additionalPorts,
+    headSha,
   } = getMainActionInputs();
   const { payload } = context;
   const event = getCodeChangeEvent(context.eventName, payload);
@@ -79,6 +80,7 @@ export const runMeticulousTestsAction = async (): Promise<void> => {
 
   const { base, head } = await getBaseAndHeadCommitShas(event, {
     useDeploymentUrl,
+    headSha,
   });
   const environment = getEnvironment({ event, head });
 

src/common/get-base-and-head-commit-shas.ts

@@ -11,10 +11,13 @@ interface BaseAndHeadCommitShas {
 
 export const getBaseAndHeadCommitShas = async (
   event: CodeChangeEvent,
-  options: { useDeploymentUrl: boolean }
+  options: {
+    useDeploymentUrl: boolean;
+    headSha: string | null;
+  }
 ): Promise<BaseAndHeadCommitShas> => {
   if (event.type === "pull_request") {
-    const head = event.payload.pull_request.head.sha;
+    const head = options.headSha || event.payload.pull_request.head.sha;
     const base = event.payload.pull_request.base.sha;
     const baseRef = event.payload.pull_request.base.ref;
     if (options.useDeploymentUrl) {
@@ -34,13 +37,13 @@ export const getBaseAndHeadCommitShas = async (
   if (event.type === "push") {
     return {
       base: event.payload.before,
-      head: event.payload.after,
+      head: options.headSha || event.payload.after,
     };
   }
   if (event.type === "workflow_dispatch") {
     return {
       base: null,
-      head: context.sha,
+      head: options.headSha || context.sha,
     };
   }
   return assertNever(event);