@argos-ci/core 5.1.3 → 5.2.0

package/dist/index.d.mts

@@ -118,9 +118,9 @@ interface Config {
    */
   skipped?: boolean;
   /**
-   * Whether the environment is a merge queue.
+   * Pull request numbers aggregated by the merge queue build.
    */
-  mergeQueue?: boolean;
+  mergeQueuePrNumbers?: number[] | null;
   /**
    * Whether this build contains only a subset of screenshots.
    * This is useful when a build is created from an incomplete test suite where some tests are skipped.
@@ -152,6 +152,14 @@ declare function finalize(params: FinalizeParameters): Promise<{
   builds: {
     id: string;
     number: number;
+    head: {
+      sha: string;
+      branch: string;
+    };
+    base: {
+      sha: string;
+      branch: string;
+    } | null;
     status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
     conclusion: ("no-changes" | "changes-detected") | null;
     stats: {
@@ -278,6 +286,11 @@ interface UploadParameters {
    * @default false
    */
   subset?: boolean;
+  /**
+   * Pull request numbers aggregated by the merge queue build.
+   * Providing this enables merge queue mode for the build.
+   */
+  mergeQueuePrNumbers?: number[];
 }
 interface Screenshot {
   hash: string;

package/dist/index.mjs

@@ -167,8 +167,7 @@ const service$7 = {
 			prNumber: getPrNumber$2({ env }),
 			prHeadCommit: null,
 			prBaseBranch: null,
-			nonce: env.BITRISEIO_PIPELINE_ID || null,
-			mergeQueue: false
+			nonce: env.BITRISEIO_PIPELINE_ID || null
 		};
 	},
 	getMergeBaseCommitSha: getMergeBaseCommitSha$1,
@@ -212,8 +211,7 @@ const service$6 = {
 			prNumber: env.BUILDKITE_PULL_REQUEST ? Number(env.BUILDKITE_PULL_REQUEST) : null,
 			prHeadCommit: null,
 			prBaseBranch: null,
-			nonce: env.BUILDKITE_BUILD_ID || null,
-			mergeQueue: false
+			nonce: env.BUILDKITE_BUILD_ID || null
 		};
 	},
 	getMergeBaseCommitSha: getMergeBaseCommitSha$1,
@@ -237,8 +235,7 @@ const service$5 = {
 		prNumber: null,
 		prHeadCommit: null,
 		prBaseBranch: null,
-		nonce: env.HEROKU_TEST_RUN_ID || null,
-		mergeQueue: false
+		nonce: env.HEROKU_TEST_RUN_ID || null
 	}),
 	getMergeBaseCommitSha: getMergeBaseCommitSha$1,
 	listParentCommits: listParentCommits$1
@@ -377,6 +374,15 @@ function getMergeGroupPayload(payload) {
 	if (payload && process.env.GITHUB_EVENT_NAME === "merge_group" && "action" in payload && payload.action === "checks_requested") return payload;
 	return null;
 }
+function getMergeQueuePrNumbers(args) {
+	const { mergeGroupPayload, pullRequest } = args;
+	if (!mergeGroupPayload) return null;
+	if (pullRequest) return [pullRequest.number];
+	const headRef = mergeGroupPayload.merge_group.head_ref;
+	const prNumberFromBranch = getPRNumberFromMergeGroupBranch(headRef);
+	if (prNumberFromBranch != null) return [prNumberFromBranch];
+	return [];
+}
 /**
 * Get the branch from the local context.
 */
@@ -496,7 +502,10 @@ const service$4 = {
 			prNumber: pullRequest?.number || null,
 			prHeadCommit: pullRequest?.head.sha ?? null,
 			prBaseBranch: pullRequest?.base.ref ?? null,
-			mergeQueue: Boolean(mergeGroupPayload)
+			mergeQueuePrNumbers: getMergeQueuePrNumbers({
+				mergeGroupPayload,
+				pullRequest
+			})
 		};
 	},
 	getMergeBaseCommitSha: getMergeBaseCommitSha$1,
@@ -537,8 +546,7 @@ const service$3 = {
 			prNumber: getPrNumber$1({ env }),
 			prHeadCommit: null,
 			prBaseBranch: null,
-			nonce: env.CIRCLE_WORKFLOW_ID || env.CIRCLE_BUILD_NUM || null,
-			mergeQueue: false
+			nonce: env.CIRCLE_WORKFLOW_ID || env.CIRCLE_BUILD_NUM || null
 		};
 	},
 	getMergeBaseCommitSha: getMergeBaseCommitSha$1,
@@ -577,8 +585,7 @@ const service$2 = {
 			prNumber: getPrNumber(ctx),
 			prHeadCommit: null,
 			prBaseBranch: null,
-			nonce: env.TRAVIS_BUILD_ID || null,
-			mergeQueue: false
+			nonce: env.TRAVIS_BUILD_ID || null
 		};
 	},
 	getMergeBaseCommitSha: getMergeBaseCommitSha$1,
@@ -612,8 +619,7 @@ const service$1 = {
 			prNumber: null,
 			prHeadCommit: null,
 			prBaseBranch: null,
-			nonce: env.CI_PIPELINE_ID || null,
-			mergeQueue: false
+			nonce: env.CI_PIPELINE_ID || null
 		};
 	},
 	getMergeBaseCommitSha: getMergeBaseCommitSha$1,
@@ -653,8 +659,7 @@ const services = [
 				prNumber: null,
 				prHeadCommit: null,
 				prBaseBranch: null,
-				nonce: null,
-				mergeQueue: false
+				nonce: null
 			};
 		},
 		getMergeBaseCommitSha: getMergeBaseCommitSha$1,
@@ -736,6 +741,11 @@ const toInt = (value) => {
 	return num;
 };
 const toFloat = (value) => parseFloat(value);
+const toIntArray = (value) => {
+	if (Array.isArray(value)) return value;
+	if (value === "") return null;
+	return value.split(",").map(toInt);
+};
 convict.addFormat({
 	name: "parallel-total",
 	validate: minInteger(-1),
@@ -753,6 +763,15 @@ convict.addFormat({
 	},
 	coerce: toFloat
 });
+convict.addFormat({
+	name: "int-array",
+	validate: (value) => {
+		if (value === null) return;
+		if (!Array.isArray(value)) throw new Error("must be an array");
+		for (const item of value) if (!Number.isInteger(item)) throw new Error("must be an array of integers");
+	},
+	coerce: toIntArray
+});
 const schema = {
 	apiBaseUrl: {
 		env: "ARGOS_API_BASE_URL",
@@ -886,6 +905,12 @@ const schema = {
 		format: Boolean,
 		default: false
 	},
+	mergeQueuePrNumbers: {
+		env: "ARGOS_MERGE_QUEUE_PRS",
+		format: "int-array",
+		default: null,
+		nullable: true
+	},
 	mergeQueue: {
 		format: Boolean,
 		default: false
@@ -937,7 +962,7 @@ async function readConfig(options = {}) {
 		previewBaseUrl: defaultConfig.previewBaseUrl || null,
 		skipped: options.skipped ?? defaultConfig.skipped ?? false,
 		subset: options.subset ?? defaultConfig.subset ?? false,
-		mergeQueue: ciEnv?.mergeQueue ?? false
+		mergeQueuePrNumbers: options.mergeQueuePrNumbers ?? defaultConfig.mergeQueuePrNumbers ?? ciEnv?.mergeQueuePrNumbers ?? null
 	});
 	if (!config.get("branch") || !config.get("commit")) throw new Error("Argos requires a branch and a commit to be set. If you are running in a non-git environment consider setting ARGOS_BRANCH and ARGOS_COMMIT environment variables.");
 	config.validate();
@@ -1282,7 +1307,8 @@ async function upload(params) {
 		ciProvider: config.ciProvider,
 		runId: config.runId,
 		runAttempt: config.runAttempt,
-		mergeQueue: config.mergeQueue,
+		mergeQueue: Boolean(config.mergeQueuePrNumbers),
+		mergeQueuePrNumbers: config.mergeQueuePrNumbers,
 		subset: config.subset
 	} });
 	if (createBuildResponse.error) throwAPIError(createBuildResponse.error);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "5.1.3",
+  "version": "5.2.0",
   "type": "module",
   "exports": {
     ".": {
@@ -39,7 +39,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.16.1",
+    "@argos-ci/api-client": "0.17.0",
     "@argos-ci/util": "3.4.0",
     "convict": "^6.2.5",
     "debug": "^4.4.3",
@@ -67,5 +67,5 @@
     "lint": "eslint .",
     "test": "vitest"
   },
-  "gitHead": "b49d186d5eb6e1338982a4cd5c3cb29e6cb0b7af"
+  "gitHead": "82add1422f689642095d43a9e3bb0d2a008728af"
 }