@codedrifters/configulator 0.0.324 → 0.0.326

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;

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;

package/lib/index.js

@@ -35701,16 +35701,27 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen25.Compone
          * 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.
+         *
+         * The file is only created when jq returns at least one match — an
+         * empty `deploy-urls.md` would pass the downstream `hashFiles(...)`
+         * guard and then fail the sticky-comment action with
+         * "Either message or path input is required" (issue #721).
          */
         {
           name: "Render deploy summary",
           if: "hashFiles('cdk-outputs.json') != ''",
           shell: "bash",
           run: [
-            '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"'
+            '# Convention: CfnOutputs whose logical ID ends in "Endpoint" are surfaced.',
+            "# See docs/packages/@codedrifters/configulator/workflows/aws-deploy-workflow#surfacing-deploy-urls",
+            `endpoints=$(jq -r '[.[] | to_entries[] | select(.key | test("Endpoint$")) | .value] | .[] | "- [\\(.)](\\(.))"' cdk-outputs.json)`,
+            'if [ -n "$endpoints" ]; then',
+            '  echo "## Deployed endpoints" >> "$GITHUB_STEP_SUMMARY"',
+            '  echo "$endpoints" >> "$GITHUB_STEP_SUMMARY"',
+            '  echo "" >> "$GITHUB_STEP_SUMMARY"',
+            '  echo "_DNS/CloudFront may take ~1 minute to propagate._" >> "$GITHUB_STEP_SUMMARY"',
+            `  printf '%s\\n' "$endpoints" > deploy-urls.md`,
+            "fi"
           ].join("\n")
         },
         /**