@codedrifters/configulator 0.0.126 → 0.0.127

package/lib/index.d.mts

@@ -1586,4 +1586,17 @@ declare class AwsDeployWorkflow extends Component {
     preSynthesize(): void;
 }
 
-export { type ApproveMergeUpgradeOptions, type AwsAccount, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, type CiDeploymentConfig, type ClassTypeOptions, type DeployWorkflowOptions, type GitBranch, type IDependencyResolver, JsiiFaker, MERGE_METHODS, MIMIMUM_RELEASE_AGE, type MergeMethod, MonorepoProject, type MonorepoProjectOptions, PROD_DEPLOY_NAME, PnpmWorkspace, type PnpmWorkspaceOptions, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, ResetTask, type ResetTaskOptions, TestRunner, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, addApproveMergeUpgradeWorkflow, getLatestEligibleVersion };
+/** Name of the gate job appended to build workflows (ADR 0004). */
+declare const COMPLETE_JOB_ID = "complete";
+/**
+ * Appends the "complete" gate job to a build workflow (ADR 0004, issue #165).
+ * The job runs after all other jobs, uses {@code if: always()}, and succeeds
+ * only when the build job succeeded and every other job succeeded or was skipped.
+ * Call this for the default build workflow and for any build workflow created
+ * by Configulator (e.g. AwsDeployWorkflow).
+ *
+ * @param buildWorkflow The Projen BuildWorkflow to append the complete job to.
+ */
+declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
+
+export { type ApproveMergeUpgradeOptions, type AwsAccount, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, COMPLETE_JOB_ID, type CiDeploymentConfig, type ClassTypeOptions, type DeployWorkflowOptions, type GitBranch, type IDependencyResolver, JsiiFaker, MERGE_METHODS, MIMIMUM_RELEASE_AGE, type MergeMethod, MonorepoProject, type MonorepoProjectOptions, PROD_DEPLOY_NAME, PnpmWorkspace, type PnpmWorkspaceOptions, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, ResetTask, type ResetTaskOptions, TestRunner, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, getLatestEligibleVersion };

package/lib/index.d.ts

@@ -1635,5 +1635,18 @@ declare class AwsDeployWorkflow extends Component {
     preSynthesize(): void;
 }
 
-export { AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, JsiiFaker, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MonorepoProject, PROD_DEPLOY_NAME, PnpmWorkspace, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ResetTask, TestRunner, TurboRepo, TurboRepoTask, TypeScriptConfig, TypeScriptProject, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, Vitest, addApproveMergeUpgradeWorkflow, getLatestEligibleVersion };
+/** Name of the gate job appended to build workflows (ADR 0004). */
+declare const COMPLETE_JOB_ID = "complete";
+/**
+ * Appends the "complete" gate job to a build workflow (ADR 0004, issue #165).
+ * The job runs after all other jobs, uses {@code if: always()}, and succeeds
+ * only when the build job succeeded and every other job succeeded or was skipped.
+ * Call this for the default build workflow and for any build workflow created
+ * by Configulator (e.g. AwsDeployWorkflow).
+ *
+ * @param buildWorkflow The Projen BuildWorkflow to append the complete job to.
+ */
+declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
+
+export { AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, COMPLETE_JOB_ID, JsiiFaker, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MonorepoProject, PROD_DEPLOY_NAME, PnpmWorkspace, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ResetTask, TestRunner, TurboRepo, TurboRepoTask, TypeScriptConfig, TypeScriptProject, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, Vitest, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, getLatestEligibleVersion };
 export type { ApproveMergeUpgradeOptions, AwsAccount, AwsDeploymentTargetOptions, AwsLocalDeploymentConfig, AwsOrganization, AwsRegion, CiDeploymentConfig, ClassTypeOptions, DeployWorkflowOptions, GitBranch, IDependencyResolver, MergeMethod, MonorepoProjectOptions, PnpmWorkspaceOptions, RemoteCacheOptions, ResetTaskOptions, TurboRepoOptions, TurboRepoTaskOptions, TypeScriptProjectOptions, VersionKey, VitestConfigOptions, VitestOptions };

package/lib/index.js

@@ -178,6 +178,7 @@ __export(index_exports, {
   AwsDeployWorkflow: () => AwsDeployWorkflow,
   AwsDeploymentConfig: () => AwsDeploymentConfig,
   AwsDeploymentTarget: () => AwsDeploymentTarget,
+  COMPLETE_JOB_ID: () => COMPLETE_JOB_ID,
   JsiiFaker: () => JsiiFaker,
   MERGE_METHODS: () => MERGE_METHODS,
   MIMIMUM_RELEASE_AGE: () => MIMIMUM_RELEASE_AGE,
@@ -198,6 +199,7 @@ __export(index_exports, {
   VSCodeConfig: () => VSCodeConfig,
   Vitest: () => Vitest,
   addApproveMergeUpgradeWorkflow: () => addApproveMergeUpgradeWorkflow,
+  addBuildCompleteJob: () => addBuildCompleteJob,
   getLatestEligibleVersion: () => getLatestEligibleVersion
 });
 module.exports = __toCommonJS(index_exports);
@@ -1407,6 +1409,53 @@ function addApproveMergeUpgradeWorkflow(project, options) {
   });
 }
 
+// src/workflows/build-complete-job.ts
+var import_workflows_model3 = require("projen/lib/github/workflows-model");
+var BUILD_JOB_ID = "build";
+var COMPLETE_JOB_ID = "complete";
+function buildCompleteJobRunScript(jobIds) {
+  const lines = [];
+  for (const id of jobIds) {
+    const expr = "${{ needs." + id + ".result }}";
+    if (id === BUILD_JOB_ID) {
+      lines.push(
+        `if [ "${expr}" != "success" ]; then echo "Job ${id} must succeed"; exit 1; fi`
+      );
+    } else {
+      lines.push(
+        `if [ "${expr}" != "success" ] && [ "${expr}" != "skipped" ]; then echo "Job ${id} must succeed or be skipped"; exit 1; fi`
+      );
+    }
+  }
+  return lines.join("\n");
+}
+function addBuildCompleteJob(buildWorkflow) {
+  const w = buildWorkflow.workflow;
+  if (!w?.jobs || typeof w.addJob !== "function") {
+    return;
+  }
+  const jobIds = Object.keys(w.jobs).filter((id) => id !== COMPLETE_JOB_ID);
+  if (jobIds.length === 0) {
+    return;
+  }
+  const runScript = buildCompleteJobRunScript(jobIds);
+  w.addJob(COMPLETE_JOB_ID, {
+    name: "Complete",
+    needs: jobIds,
+    if: "always()",
+    runsOn: ["ubuntu-latest"],
+    permissions: {
+      contents: import_workflows_model3.JobPermission.NONE
+    },
+    steps: [
+      {
+        name: "Verify all jobs succeeded or were skipped",
+        run: runScript
+      }
+    ]
+  });
+}
+
 // src/projects/monorepo-project.ts
 var postInstallDependenciesMap = /* @__PURE__ */ new WeakMap();
 var MonorepoProject = class extends import_typescript.TypeScriptAppProject {
@@ -1644,6 +1693,9 @@ var MonorepoProject = class extends import_typescript.TypeScriptAppProject {
     if (options.approveMergeUpgradeOptions) {
       addApproveMergeUpgradeWorkflow(this, options.approveMergeUpgradeOptions);
     }
+    if (this.buildWorkflow) {
+      addBuildCompleteJob(this.buildWorkflow);
+    }
     this.tasks.tryFind("post-upgrade")?.exec("pnpm upgrade -r");
     this.tasks.tryFind("post-upgrade")?.spawn(this.defaultTask);
   }
@@ -1710,7 +1762,7 @@ var import_utils3 = __toESM(require_lib());
 var import_projen10 = require("projen");
 var import_build = require("projen/lib/build");
 var import_github = require("projen/lib/github");
-var import_workflows_model3 = require("projen/lib/github/workflows-model");
+var import_workflows_model4 = require("projen/lib/github/workflows-model");
 var PROD_DEPLOY_NAME = "prod-deploy";
 var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen10.Component {
   constructor(project, options = {}) {
@@ -1939,14 +1991,15 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen10.Compone
         ],
         runsOn: ["ubuntu-latest"],
         permissions: {
-          contents: import_workflows_model3.JobPermission.READ,
-          idToken: import_workflows_model3.JobPermission.WRITE
+          contents: import_workflows_model4.JobPermission.READ,
+          idToken: import_workflows_model4.JobPermission.WRITE
         },
         concurrency: deployJobName,
         if: jobCondition,
         steps: [...this.deploySteps(target)]
       });
     });
+    addBuildCompleteJob(this.buildWorkflow);
   }
   static of(project, buildWorkflow) {
     const isDefined = (c) => c instanceof _AwsDeployWorkflow && c.buildWorkflow === buildWorkflow;
@@ -1979,6 +2032,7 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen10.Compone
   AwsDeployWorkflow,
   AwsDeploymentConfig,
   AwsDeploymentTarget,
+  COMPLETE_JOB_ID,
   JsiiFaker,
   MERGE_METHODS,
   MIMIMUM_RELEASE_AGE,
@@ -1999,6 +2053,7 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen10.Compone
   VSCodeConfig,
   Vitest,
   addApproveMergeUpgradeWorkflow,
+  addBuildCompleteJob,
   getLatestEligibleVersion
 });
 //# sourceMappingURL=index.js.map