@codedrifters/configulator 0.0.324 → 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;

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

@@ -35707,6 +35707,8 @@ var AwsDeployWorkflow = class _AwsDeployWorkflow extends import_projen25.Compone
           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"',