@codedrifters/configulator 0.0.323 → 0.0.325

package/lib/index.d.mts

@@ -11044,6 +11044,16 @@ interface DeployWorkflowOptions {
      */
     readonly deployAfterTargets?: Array<AwsDeploymentTarget>;
 }
+/**
+ * Adds a build + deploy GitHub Actions workflow for an AwsCdkTypeScriptApp.
+ *
+ * Deploy URLs are surfaced via a naming convention: any CfnOutput whose
+ * logical ID ends in `Endpoint` is rendered into the PR sticky comment and
+ * the job summary. See the docs page for the full convention and naming
+ * guidance.
+ *
+ * @see docs/packages/@codedrifters/configulator/workflows/aws-deploy-workflow.md
+ */
 declare class AwsDeployWorkflow extends Component {
     project: AwsCdkTypeScriptApp;
     options: DeployWorkflowOptions;
@@ -11082,6 +11092,13 @@ declare class AwsDeployWorkflow extends Component {
     constructor(project: AwsCdkTypeScriptApp, options?: DeployWorkflowOptions);
     setupNode: () => Array<JobStep>;
     setupPnpm: () => Array<JobStep>;
+    /**
+     * Build the deterministic GitHub Actions job name for a deploy target.
+     *
+     * Used both to register the post-build job and as the sticky-PR-comment
+     * header so dev/stage/prod comments don't collide on the same PR.
+     */
+    private buildJobName;
     /**
      * Builds a GitHub Actions condition string that checks if the current branch
      * matches any of the provided branch patterns.

package/lib/index.d.ts

@@ -11093,6 +11093,16 @@ interface DeployWorkflowOptions {
      */
     readonly deployAfterTargets?: Array<AwsDeploymentTarget>;
 }
+/**
+ * Adds a build + deploy GitHub Actions workflow for an AwsCdkTypeScriptApp.
+ *
+ * Deploy URLs are surfaced via a naming convention: any CfnOutput whose
+ * logical ID ends in `Endpoint` is rendered into the PR sticky comment and
+ * the job summary. See the docs page for the full convention and naming
+ * guidance.
+ *
+ * @see docs/packages/@codedrifters/configulator/workflows/aws-deploy-workflow.md
+ */
 declare class AwsDeployWorkflow extends Component {
     project: AwsCdkTypeScriptApp;
     options: DeployWorkflowOptions;
@@ -11131,6 +11141,13 @@ declare class AwsDeployWorkflow extends Component {
     constructor(project: AwsCdkTypeScriptApp, options?: DeployWorkflowOptions);
     setupNode: () => Array<JobStep>;
     setupPnpm: () => Array<JobStep>;
+    /**
+     * Build the deterministic GitHub Actions job name for a deploy target.
+     *
+     * Used both to register the post-build job and as the sticky-PR-comment
+     * header so dev/stage/prod comments don't collide on the same PR.
+     */
+    private buildJobName;
     /**
      * Builds a GitHub Actions condition string that checks if the current branch
      * matches any of the provided branch patterns.

package/lib/index.js

@@ -35607,6 +35607,22 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen25.Compone
         }
       ];
     };
+    /**
+     * Build the deterministic GitHub Actions job name for a deploy target.
+     *
+     * Used both to register the post-build job and as the sticky-PR-comment
+     * header so dev/stage/prod comments don't collide on the same PR.
+     */
+    this.buildJobName = (target) => {
+      return [
+        target.awsStageType,
+        target.deploymentTargetRole,
+        "deploy",
+        target.project.name,
+        target.account,
+        target.region
+      ].join("-");
+    };
     /**
      * Builds a GitHub Actions condition string that checks if the current branch
      * matches any of the provided branch patterns.
@@ -35646,6 +35662,7 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen25.Compone
       } = target;
       const { roleArn, stackPattern } = ciDeploymentConfig ?? {};
       const { rootCdkOut } = awsDeploymentConfig;
+      const deployJobName = this.buildJobName(target);
       return [
         ...this.setupPnpm(),
         ...this.setupNode(),
@@ -35678,7 +35695,39 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen25.Compone
             ...awsDeploymentConfig.cdkCli.deployOptionsFor(target),
             app: rootCdkOut,
             stackPatterns: stackPattern ? [stackPattern] : void 0
-          })}`
+          })} --outputs-file cdk-outputs.json`
+        },
+        /**
+         * Render a job-summary table listing every `*Endpoint` output emitted
+         * by the deploy. Also writes the same list to `deploy-urls.md` so the
+         * follow-up sticky-PR-comment step can reuse it.
+         */
+        {
+          name: "Render deploy summary",
+          if: "hashFiles('cdk-outputs.json') != ''",
+          shell: "bash",
+          run: [
+            '# Convention: CfnOutputs whose logical ID ends in "Endpoint" are surfaced.',
+            "# See docs/packages/@codedrifters/configulator/workflows/aws-deploy-workflow#surfacing-deploy-urls",
+            'echo "## Deployed endpoints" >> "$GITHUB_STEP_SUMMARY"',
+            `jq -r '[.[] | to_entries[] | select(.key | test("Endpoint$")) | .value] | .[] | "- [\\(.)](\\(.))"' cdk-outputs.json | tee deploy-urls.md >> "$GITHUB_STEP_SUMMARY"`,
+            'echo "" >> "$GITHUB_STEP_SUMMARY"',
+            'echo "_DNS/CloudFront may take ~1 minute to propagate._" >> "$GITHUB_STEP_SUMMARY"'
+          ].join("\n")
+        },
+        /**
+         * Post a sticky PR comment listing each deployed endpoint. The
+         * comment is keyed by the deploy job name so dev/stage/prod comments
+         * don't collide on the same PR.
+         */
+        {
+          name: "Sticky PR comment with deploy endpoints",
+          if: "github.event_name == 'pull_request' && hashFiles('deploy-urls.md') != ''",
+          uses: "marocchino/sticky-pull-request-comment@v2",
+          with: {
+            header: deployJobName,
+            path: "deploy-urls.md"
+          }
         }
       ];
     };
@@ -35773,18 +35822,8 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen25.Compone
         ...buildWorkflowOptions?.preBuildSteps ?? []
       ]
     });
-    const buildJobName = (target) => {
-      return [
-        target.awsStageType,
-        target.deploymentTargetRole,
-        "deploy",
-        target.project.name,
-        target.account,
-        target.region
-      ].join("-");
-    };
     this.awsDeploymentTargets.forEach((target) => {
-      const deployJobName = buildJobName(target);
+      const deployJobName = this.buildJobName(target);
       const branchFilterCondition = this.buildBranchFilterCondition(
         target.branches
       );
@@ -35797,13 +35836,14 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen25.Compone
         needs: [
           "build",
           ...this.deployAfterTargets.map((p) => {
-            return buildJobName(p);
+            return this.buildJobName(p);
           })
         ],
         runsOn: ["ubuntu-latest"],
         permissions: {
           contents: import_workflows_model5.JobPermission.READ,
-          idToken: import_workflows_model5.JobPermission.WRITE
+          idToken: import_workflows_model5.JobPermission.WRITE,
+          pullRequests: import_workflows_model5.JobPermission.WRITE
         },
         concurrency: deployJobName,
         if: jobCondition,