projen-pipelines 0.3.6 → 0.3.8

package/.jsii

@@ -1827,6 +1827,120 @@
       "name": "CdkDiffType",
       "symbolId": "src/awscdk/base:CdkDiffType"
     },
+    "projen-pipelines.CdkOutputsSummaryStep": {
+      "assembly": "projen-pipelines",
+      "base": "projen-pipelines.PipelineStep",
+      "docs": {
+        "remarks": "For GitHub Actions: Writes outputs as a markdown table to the job summary.\nFor GitLab CI: Displays outputs in a collapsible section in the job log.\n\nThis step reads the outputs JSON file generated by CDK deploy and formats\nit for display in the respective CI/CD platform.",
+        "stability": "stable",
+        "summary": "A pipeline step that writes CDK stack outputs to the CI/CD job summary."
+      },
+      "fqn": "projen-pipelines.CdkOutputsSummaryStep",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/steps/github-summary.step.ts",
+          "line": 23
+        },
+        "parameters": [
+          {
+            "docs": {
+              "summary": "- The projen project reference."
+            },
+            "name": "project",
+            "type": {
+              "fqn": "projen.Project"
+            }
+          },
+          {
+            "name": "options",
+            "type": {
+              "fqn": "projen-pipelines.CdkOutputsSummaryStepOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/steps/github-summary.step.ts",
+        "line": 21
+      },
+      "methods": [
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Converts the step into a GitHub Actions step configuration."
+          },
+          "locationInModule": {
+            "filename": "src/steps/github-summary.step.ts",
+            "line": 33
+          },
+          "name": "toGithub",
+          "overrides": "projen-pipelines.PipelineStep",
+          "returns": {
+            "type": {
+              "fqn": "projen-pipelines.GithubStepConfig"
+            }
+          }
+        },
+        {
+          "docs": {
+            "remarks": "Creates a collapsible section in the job log to display CDK outputs.",
+            "stability": "stable",
+            "summary": "Converts the step into a GitLab CI step configuration."
+          },
+          "locationInModule": {
+            "filename": "src/steps/github-summary.step.ts",
+            "line": 81
+          },
+          "name": "toGitlab",
+          "overrides": "projen-pipelines.PipelineStep",
+          "returns": {
+            "type": {
+              "fqn": "projen-pipelines.GitlabStepConfig"
+            }
+          }
+        }
+      ],
+      "name": "CdkOutputsSummaryStep",
+      "symbolId": "src/steps/github-summary.step:CdkOutputsSummaryStep"
+    },
+    "projen-pipelines.CdkOutputsSummaryStepOptions": {
+      "assembly": "projen-pipelines",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Options for the CDK outputs summary step."
+      },
+      "fqn": "projen-pipelines.CdkOutputsSummaryStepOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/steps/github-summary.step.ts",
+        "line": 7
+      },
+      "name": "CdkOutputsSummaryStepOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The stage name used to identify the outputs file."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/steps/github-summary.step.ts",
+            "line": 9
+          },
+          "name": "stageName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/steps/github-summary.step:CdkOutputsSummaryStepOptions"
+    },
     "projen-pipelines.CloudFormationOnlyOptions": {
       "assembly": "projen-pipelines",
       "datatype": true,
@@ -4020,7 +4134,7 @@
         },
         "locationInModule": {
           "filename": "src/awscdk/github.ts",
-          "line": 73
+          "line": 74
         },
         "parameters": [
           {
@@ -4046,7 +4160,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/awscdk/github.ts",
-        "line": 55
+        "line": 56
       },
       "methods": [
         {
@@ -4056,7 +4170,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 304
+            "line": 306
           },
           "name": "createAssetUpload",
           "parameters": [
@@ -4076,7 +4190,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 359
+            "line": 361
           },
           "name": "createDeployment",
           "parameters": [
@@ -4105,7 +4219,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 139
+            "line": 140
           },
           "name": "createFeatureWorkflows",
           "protected": true
@@ -4117,7 +4231,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 479
+            "line": 483
           },
           "name": "createIndependentDeployment",
           "parameters": [
@@ -4139,7 +4253,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 132
+            "line": 133
           },
           "name": "engineType",
           "overrides": "projen-pipelines.CDKPipeline",
@@ -4160,7 +4274,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 58
+            "line": 59
           },
           "name": "needsVersionedArtifacts",
           "type": {
@@ -4173,7 +4287,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 65
+            "line": 66
           },
           "name": "useGithubPackages",
           "protected": true,
@@ -4187,7 +4301,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 66
+            "line": 67
           },
           "name": "minNodeVersion",
           "optional": true,
@@ -4213,7 +4327,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/awscdk/github.ts",
-        "line": 17
+        "line": 18
       },
       "name": "GithubCDKPipelineOptions",
       "properties": [
@@ -4227,7 +4341,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 24
+            "line": 25
           },
           "name": "runnerTags",
           "optional": true,
@@ -4251,7 +4365,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 36
+            "line": 37
           },
           "name": "useGithubEnvironments",
           "optional": true,
@@ -4270,7 +4384,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 48
+            "line": 49
           },
           "name": "useGithubEnvironmentsForAssetUpload",
           "optional": true,
@@ -4288,7 +4402,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 27
+            "line": 28
           },
           "name": "useGithubPackagesForAssembly",
           "optional": true,
@@ -4511,7 +4625,7 @@
         },
         "locationInModule": {
           "filename": "src/awscdk/gitlab.ts",
-          "line": 61
+          "line": 62
         },
         "parameters": [
           {
@@ -4537,7 +4651,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/awscdk/gitlab.ts",
-        "line": 40
+        "line": 41
       },
       "methods": [
         {
@@ -4548,7 +4662,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 169
+            "line": 170
           },
           "name": "createAssetUpload",
           "protected": true
@@ -4561,7 +4675,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 202
+            "line": 203
           },
           "name": "createDeployment",
           "parameters": [
@@ -4583,7 +4697,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 132
+            "line": 133
           },
           "name": "createFeatureWorkflows",
           "protected": true
@@ -4595,7 +4709,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 261
+            "line": 263
           },
           "name": "createIndependentDeployment",
           "parameters": [
@@ -4618,7 +4732,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 142
+            "line": 143
           },
           "name": "createSynth",
           "protected": true
@@ -4629,7 +4743,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 291
+            "line": 294
           },
           "name": "engineType",
           "overrides": "projen-pipelines.CDKPipeline",
@@ -4647,7 +4761,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 97
+            "line": 98
           },
           "name": "setupSnippets",
           "protected": true
@@ -4663,7 +4777,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 49
+            "line": 50
           },
           "name": "config",
           "type": {
@@ -4679,7 +4793,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 46
+            "line": 47
           },
           "name": "jobImage",
           "type": {
@@ -4695,7 +4809,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 43
+            "line": 44
           },
           "name": "needsVersionedArtifacts",
           "type": {
@@ -4719,7 +4833,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/awscdk/gitlab.ts",
-        "line": 26
+        "line": 27
       },
       "name": "GitlabCDKPipelineOptions",
       "properties": [
@@ -4732,7 +4846,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 30
+            "line": 31
           },
           "name": "image",
           "optional": true,
@@ -4749,7 +4863,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 28
+            "line": 29
           },
           "name": "runnerTags",
           "optional": true,
@@ -4772,7 +4886,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/awscdk/gitlab.ts",
-        "line": 10
+        "line": 11
       },
       "name": "GitlabRunnerTags",
       "properties": [
@@ -4785,7 +4899,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 16
+            "line": 17
           },
           "name": "assetPublishing",
           "optional": true,
@@ -4807,7 +4921,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 12
+            "line": 13
           },
           "name": "default",
           "optional": true,
@@ -4829,7 +4943,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 20
+            "line": 21
           },
           "name": "deployment",
           "optional": true,
@@ -4856,7 +4970,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 18
+            "line": 19
           },
           "name": "diff",
           "optional": true,
@@ -4883,7 +4997,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 14
+            "line": 15
           },
           "name": "synth",
           "optional": true,
@@ -8743,6 +8857,6 @@
       "symbolId": "src/versioning/types:VersioningStrategyComponents"
     }
   },
-  "version": "0.3.6",
-  "fingerprint": "5DKqc/qvzfw2QJHHe4eO8hXAny1M0Wy/28gEO+NBMfA="
+  "version": "0.3.8",
+  "fingerprint": "LzKWh1Ov6K+31G5Xr8sJELvMYdtpdKvzf63Tl+61/hg="
 }

package/API.md

@@ -2965,6 +2965,38 @@ public readonly prefix: string;
 
 ---
 
+### CdkOutputsSummaryStepOptions <a name="CdkOutputsSummaryStepOptions" id="projen-pipelines.CdkOutputsSummaryStepOptions"></a>
+
+Options for the CDK outputs summary step.
+
+#### Initializer <a name="Initializer" id="projen-pipelines.CdkOutputsSummaryStepOptions.Initializer"></a>
+
+```typescript
+import { CdkOutputsSummaryStepOptions } from 'projen-pipelines'
+
+const cdkOutputsSummaryStepOptions: CdkOutputsSummaryStepOptions = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#projen-pipelines.CdkOutputsSummaryStepOptions.property.stageName">stageName</a></code> | <code>string</code> | The stage name used to identify the outputs file. |
+
+---
+
+##### `stageName`<sup>Required</sup> <a name="stageName" id="projen-pipelines.CdkOutputsSummaryStepOptions.property.stageName"></a>
+
+```typescript
+public readonly stageName: string;
+```
+
+- *Type:* string
+
+The stage name used to identify the outputs file.
+
+---
+
 ### CDKPipelineOptions <a name="CDKPipelineOptions" id="projen-pipelines.CDKPipelineOptions"></a>
 
 The CDKPipelineOptions interface is designed to provide configuration options for a CDK (Cloud Development Kit) pipeline.
@@ -6510,6 +6542,97 @@ Should be implemented by subclasses.
 
 
 
+### CdkOutputsSummaryStep <a name="CdkOutputsSummaryStep" id="projen-pipelines.CdkOutputsSummaryStep"></a>
+
+A pipeline step that writes CDK stack outputs to the CI/CD job summary.
+
+For GitHub Actions: Writes outputs as a markdown table to the job summary.
+For GitLab CI: Displays outputs in a collapsible section in the job log.
+
+This step reads the outputs JSON file generated by CDK deploy and formats
+it for display in the respective CI/CD platform.
+
+#### Initializers <a name="Initializers" id="projen-pipelines.CdkOutputsSummaryStep.Initializer"></a>
+
+```typescript
+import { CdkOutputsSummaryStep } from 'projen-pipelines'
+
+new CdkOutputsSummaryStep(project: Project, options: CdkOutputsSummaryStepOptions)
+```
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#projen-pipelines.CdkOutputsSummaryStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
+| <code><a href="#projen-pipelines.CdkOutputsSummaryStep.Initializer.parameter.options">options</a></code> | <code><a href="#projen-pipelines.CdkOutputsSummaryStepOptions">CdkOutputsSummaryStepOptions</a></code> | *No description.* |
+
+---
+
+##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.CdkOutputsSummaryStep.Initializer.parameter.project"></a>
+
+- *Type:* projen.Project
+
+The projen project reference.
+
+---
+
+##### `options`<sup>Required</sup> <a name="options" id="projen-pipelines.CdkOutputsSummaryStep.Initializer.parameter.options"></a>
+
+- *Type:* <a href="#projen-pipelines.CdkOutputsSummaryStepOptions">CdkOutputsSummaryStepOptions</a>
+
+---
+
+#### Methods <a name="Methods" id="Methods"></a>
+
+| **Name** | **Description** |
+| --- | --- |
+| <code><a href="#projen-pipelines.CdkOutputsSummaryStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
+| <code><a href="#projen-pipelines.CdkOutputsSummaryStep.toCodeCatalyst">toCodeCatalyst</a></code> | Generates a configuration for a CodeCatalyst Actions step. |
+| <code><a href="#projen-pipelines.CdkOutputsSummaryStep.toGithub">toGithub</a></code> | Converts the step into a GitHub Actions step configuration. |
+| <code><a href="#projen-pipelines.CdkOutputsSummaryStep.toGitlab">toGitlab</a></code> | Converts the step into a GitLab CI step configuration. |
+
+---
+
+##### `toBash` <a name="toBash" id="projen-pipelines.CdkOutputsSummaryStep.toBash"></a>
+
+```typescript
+public toBash(): BashStepConfig
+```
+
+Generates a configuration for a bash script step.
+
+Should be implemented by subclasses.
+
+##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.CdkOutputsSummaryStep.toCodeCatalyst"></a>
+
+```typescript
+public toCodeCatalyst(): CodeCatalystStepConfig
+```
+
+Generates a configuration for a CodeCatalyst Actions step.
+
+Should be implemented by subclasses.
+
+##### `toGithub` <a name="toGithub" id="projen-pipelines.CdkOutputsSummaryStep.toGithub"></a>
+
+```typescript
+public toGithub(): GithubStepConfig
+```
+
+Converts the step into a GitHub Actions step configuration.
+
+##### `toGitlab` <a name="toGitlab" id="projen-pipelines.CdkOutputsSummaryStep.toGitlab"></a>
+
+```typescript
+public toGitlab(): GitlabStepConfig
+```
+
+Converts the step into a GitLab CI step configuration.
+
+Creates a collapsible section in the job log to display CDK outputs.
+
+
+
+
 ### CloudFormationOutput <a name="CloudFormationOutput" id="projen-pipelines.CloudFormationOutput"></a>
 
 CloudFormation output configuration.