feat: allow to specify ref branch & ref commit

argos-ci · Sep 17, 2023 · a6c4ee3 · a6c4ee3
1 parent d54097c
commit a6c4ee3
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -41,6 +41,14 @@ program
   )
   .option("--parallel-total <number>", "The number of parallel nodes being ran")
   .option("--parallel-nonce <string>", "A unique ID for this parallel build")
+  .option(
+    "--reference-branch <string>",
+    "Branch used as baseline for screenshot comparison",
+  )
+  .option(
+    "--reference-commit <string>",
+    "Commit used as baseline for screenshot comparison",
+  )
   .action(async (directory, options) => {
     const spinner = ora("Uploading screenshots").start();
     try {
@@ -54,6 +62,8 @@ program
         parallel: options.parallel
           ? { nonce: options.parallelNonce, total: options.parallelTotal }
           : false,
+        referenceBranch: options.referenceBranch,
+        referenceCommit: options.referenceCommit,
       });
       spinner.succeed(`Build created: ${result.build.url}`);
     } catch (error: any) {

diff --git a/packages/core/src/api-client.ts b/packages/core/src/api-client.ts
@@ -15,6 +15,8 @@ export interface CreateBuildInput {
   parallelNonce?: string | null;
   prNumber?: number | null;
   prHeadCommit?: string | null;
+  referenceBranch?: string | null;
+  referenceCommit?: string | null;
 }
 
 export interface CreateBuildOutput {

diff --git a/packages/core/src/config.ts b/packages/core/src/config.ts
@@ -83,6 +83,18 @@ const schema = {
     default: null,
     nullable: true,
   },
+  referenceBranch: {
+    env: "ARGOS_REFERENCE_BRANCH",
+    format: String,
+    default: null,
+    nullable: true,
+  },
+  referenceCommit: {
+    env: "ARGOS_REFERENCE_COMMIT",
+    format: String,
+    default: null,
+    nullable: true,
+  },
   ciService: {
     format: String,
     default: null,
@@ -119,6 +131,8 @@ export interface Config {
   parallel: boolean;
   parallelNonce: string | null;
   parallelTotal: number | null;
+  referenceBranch: string | null;
+  referenceCommit: string | null;
   owner: string | null;
   repository: string | null;
   jobId: string | null;

diff --git a/packages/core/src/upload.ts b/packages/core/src/upload.ts
@@ -41,6 +41,10 @@ export interface UploadParameters {
         total: number;
       }
     | false;
+  /** Branch used as baseline for screenshot comparison */
+  referenceBranch?: string;
+  /** Commit used as baseline for screenshot comparison */
+  referenceCommit?: string;
 }
 
 const getConfigFromOptions = (options: UploadParameters) => {
@@ -57,6 +61,10 @@ const getConfigFromOptions = (options: UploadParameters) => {
     prNumber:
       options.prNumber ?? config.get("prNumber") ?? ciEnv?.prNumber ?? null,
     prHeadCommit: config.get("prHeadCommit") ?? ciEnv?.prHeadCommit ?? null,
+    referenceBranch:
+      options.referenceBranch ?? config.get("referenceBranch") ?? null,
+    referenceCommit:
+      options.referenceCommit ?? config.get("referenceCommit") ?? null,
     ciService: ciEnv?.name ?? null,
     owner: ciEnv?.owner ?? null,
     repository: ciEnv?.repository ?? null,
@@ -123,6 +131,8 @@ export const upload = async (params: UploadParameters) => {
     ),
     prNumber: config.prNumber,
     prHeadCommit: config.prHeadCommit,
+    referenceBranch: config.referenceBranch,
+    referenceCommit: config.referenceCommit,
   });
 
   debug("Got screenshots", result);