Archive when deploying if the PR is closed/merged

Author: matt-aitken

packages/cli-v3/src/commands/deploy.ts

@@ -37,6 +37,7 @@ import { updateTriggerPackages } from "./update.js";
 import { setGithubActionsOutputAndEnvVars } from "../utilities/githubActions.js";
 import { isDirectory } from "../utilities/fileSystem.js";
 import { createGitMeta } from "../utilities/gitMeta.js";
+import { archivePreviewBranch } from "./preview.js";
 
 const DeployCommandOptions = CommonCommandOptions.extend({
   dryRun: z.boolean().default(false),
@@ -219,6 +220,18 @@ async function _deployCommand(dir: string, options: DeployCommandOptions) {
   }
 
   if (options.env === "preview" && branch) {
+    //auto-archive a branch if the PR is merged or closed
+    if (gitMeta?.pullRequestState === "merged" || gitMeta?.pullRequestState === "closed") {
+      log.message(`Pull request ${gitMeta?.pullRequestNumber} is ${gitMeta?.pullRequestState}.`);
+      const $buildSpinner = spinner();
+      $buildSpinner.start(`Archiving preview branch: "${branch}"`);
+      const result = await archivePreviewBranch(authorization, branch, resolvedConfig.project);
+      $buildSpinner.stop(
+        result ? `Successfully archived "${branch}"` : `Failed to archive "${branch}".`
+      );
+      return;
+    }
+
     logger.debug("Upserting branch", { env: options.env, branch });
     const branchEnv = await upsertBranch({
       accessToken: authorization.auth.accessToken,

packages/cli-v3/src/commands/preview.ts

@@ -13,7 +13,7 @@ import { loadConfig } from "../config.js";
 import { createGitMeta } from "../utilities/gitMeta.js";
 import { printStandloneInitialBanner } from "../utilities/initialBanner.js";
 import { logger } from "../utilities/logger.js";
-import { getProjectClient } from "../utilities/session.js";
+import { getProjectClient, LoginResultOk } from "../utilities/session.js";
 import { spinner } from "../utilities/windows.js";
 import { verifyDirectory } from "./deploy.js";
 import { login } from "./login.js";
@@ -119,17 +119,28 @@ async function _previewArchiveCommand(dir: string, options: PreviewCommandOption
     );
   }
 
-  const apiClient = new CliApiClient(authorization.auth.apiUrl, authorization.auth.accessToken);
-
   const $buildSpinner = spinner();
   $buildSpinner.start(`Archiving "${branch}"`);
+  const result = await archivePreviewBranch(authorization, branch, resolvedConfig.project);
+  $buildSpinner.stop(
+    result ? `Successfully archived "${branch}"` : `Failed to archive "${branch}".`
+  );
+  return result;
+}
+
+export async function archivePreviewBranch(
+  authorization: LoginResultOk,
+  branch: string,
+  project: string
+) {
+  const apiClient = new CliApiClient(authorization.auth.apiUrl, authorization.auth.accessToken);
 
-  const result = await apiClient.archiveBranch(resolvedConfig.project, branch);
+  const result = await apiClient.archiveBranch(project, branch);
 
   if (result.success) {
-    $buildSpinner.stop(`Successfully archived "${branch}"`);
+    return true;
   } else {
-    $buildSpinner.stop(`Failed to archive "${branch}".`);
     logger.error(result.error);
+    return false;
   }
 }