projen-pipelines 0.0.69 → 0.0.71

package/.jsii

@@ -159,7 +159,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/bash.ts",
-            "line": 78
+            "line": 79
           },
           "name": "engineType",
           "overrides": "projen-pipelines.CDKPipeline",
@@ -276,7 +276,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 273
+            "line": 276
           },
           "name": "createApplicationEntrypoint",
           "protected": true
@@ -288,7 +288,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 439
+            "line": 442
           },
           "name": "createFeatureStage",
           "protected": true
@@ -300,7 +300,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 478
+            "line": 481
           },
           "name": "createIndependentStage",
           "parameters": [
@@ -323,7 +323,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 419
+            "line": 422
           },
           "name": "createPersonalStage",
           "protected": true
@@ -335,7 +335,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 459
+            "line": 462
           },
           "name": "createPipelineStage",
           "parameters": [
@@ -358,7 +358,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 371
+            "line": 374
           },
           "name": "createReleaseTasks",
           "protected": true
@@ -369,7 +369,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 259
+            "line": 262
           },
           "name": "createSafeStageName",
           "parameters": [
@@ -409,18 +409,34 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 237
+            "line": 496
           },
-          "name": "getAssetUploadCommands",
+          "name": "getCliStackPattern",
           "parameters": [
             {
-              "name": "needsVersionedArtifacts",
+              "name": "stage",
               "type": {
-                "primitive": "boolean"
+                "primitive": "string"
               }
             }
           ],
           "protected": true,
+          "returns": {
+            "type": {
+              "primitive": "string"
+            }
+          }
+        },
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "locationInModule": {
+            "filename": "src/awscdk/base.ts",
+            "line": 243
+          },
+          "name": "renderAssemblyUploadCommands",
+          "protected": true,
           "returns": {
             "type": {
               "collection": {
@@ -438,12 +454,13 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 493
+            "line": 237
           },
-          "name": "getCliStackPattern",
+          "name": "renderAssetUploadCommands",
           "parameters": [
             {
-              "name": "stage",
+              "name": "stageName",
+              "optional": true,
               "type": {
                 "primitive": "string"
               }
@@ -452,7 +469,12 @@
           "protected": true,
           "returns": {
             "type": {
-              "primitive": "string"
+              "collection": {
+                "elementtype": {
+                  "primitive": "string"
+                },
+                "kind": "array"
+              }
             }
           }
         },
@@ -462,7 +484,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 247
+            "line": 250
           },
           "name": "renderDeployCommands",
           "parameters": [
@@ -491,7 +513,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/base.ts",
-            "line": 253
+            "line": 256
           },
           "name": "renderDiffCommands",
           "parameters": [
@@ -1039,7 +1061,7 @@
         },
         "locationInModule": {
           "filename": "src/awscdk/github.ts",
-          "line": 67
+          "line": 78
         },
         "parameters": [
           {
@@ -1065,7 +1087,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/awscdk/github.ts",
-        "line": 50
+        "line": 61
       },
       "methods": [
         {
@@ -1075,7 +1097,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 169
+            "line": 180
           },
           "name": "createAssetUpload"
         },
@@ -1086,7 +1108,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 217
+            "line": 247
           },
           "name": "createDeployment",
           "parameters": [
@@ -1108,7 +1130,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 324
+            "line": 360
           },
           "name": "createIndependentDeployment",
           "parameters": [
@@ -1130,7 +1152,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 111
+            "line": 122
           },
           "name": "engineType",
           "overrides": "projen-pipelines.CDKPipeline",
@@ -1151,7 +1173,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 53
+            "line": 64
           },
           "name": "needsVersionedArtifacts",
           "type": {
@@ -1164,7 +1186,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 60
+            "line": 71
           },
           "name": "useGithubPackages",
           "protected": true,
@@ -1189,7 +1211,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/awscdk/github.ts",
-        "line": 30
+        "line": 32
       },
       "name": "GithubCDKPipelineOptions",
       "properties": [
@@ -1202,7 +1224,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 33
+            "line": 35
           },
           "name": "iamRoleArns",
           "type": {
@@ -1219,7 +1241,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 40
+            "line": 42
           },
           "name": "runnerTags",
           "optional": true,
@@ -1232,6 +1254,25 @@
             }
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "INFO: When using environments consider protection rules instead of using the manual option of projen-pipelines for stages",
+            "stability": "stable",
+            "summary": "whether to use GitHub environments for deployment stages."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/github.ts",
+            "line": 54
+          },
+          "name": "useGithubEnvironments",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -1242,7 +1283,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 43
+            "line": 45
           },
           "name": "useGithubPackagesForAssembly",
           "optional": true,
@@ -1285,6 +1326,28 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "IAM role ARN for the asset publishing step for a specific stage."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/github.ts",
+            "line": 24
+          },
+          "name": "assetPublishingPerStage",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -1311,7 +1374,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/github.ts",
-            "line": 24
+            "line": 26
           },
           "name": "deployment",
           "optional": true,
@@ -1441,7 +1504,7 @@
         },
         "locationInModule": {
           "filename": "src/awscdk/gitlab.ts",
-          "line": 82
+          "line": 84
         },
         "parameters": [
           {
@@ -1467,7 +1530,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/awscdk/gitlab.ts",
-        "line": 61
+        "line": 63
       },
       "methods": [
         {
@@ -1478,7 +1541,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 209
+            "line": 211
           },
           "name": "createAssetUpload",
           "protected": true
@@ -1491,7 +1554,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 244
+            "line": 262
           },
           "name": "createDeployment",
           "parameters": [
@@ -1514,7 +1577,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 311
+            "line": 329
           },
           "name": "createIndependentDeployment",
           "parameters": [
@@ -1537,7 +1600,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 173
+            "line": 175
           },
           "name": "createSynth",
           "protected": true
@@ -1548,7 +1611,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 353
+            "line": 371
           },
           "name": "engineType",
           "overrides": "projen-pipelines.CDKPipeline",
@@ -1566,7 +1629,7 @@
           },
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 114
+            "line": 116
           },
           "name": "setupSnippets",
           "protected": true
@@ -1582,7 +1645,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 70
+            "line": 72
           },
           "name": "config",
           "type": {
@@ -1598,7 +1661,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 67
+            "line": 69
           },
           "name": "jobImage",
           "type": {
@@ -1614,7 +1677,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 64
+            "line": 66
           },
           "name": "needsVersionedArtifacts",
           "type": {
@@ -1638,7 +1701,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/awscdk/gitlab.ts",
-        "line": 45
+        "line": 47
       },
       "name": "GitlabCDKPipelineOptions",
       "properties": [
@@ -1651,7 +1714,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 47
+            "line": 49
           },
           "name": "iamRoleArns",
           "type": {
@@ -1667,7 +1730,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 51
+            "line": 53
           },
           "name": "image",
           "optional": true,
@@ -1684,7 +1747,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 49
+            "line": 51
           },
           "name": "runnerTags",
           "optional": true,
@@ -1715,7 +1778,7 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "IAM role ARN for the asset publishing stage."
+            "summary": "IAM role ARN for the asset publishing step."
           },
           "immutable": true,
           "locationInModule": {
@@ -1728,6 +1791,28 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "IAM role ARN for the asset publishing step for a specific stage."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/awscdk/gitlab.ts",
+            "line": 20
+          },
+          "name": "assetPublishingPerStage",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -1754,7 +1839,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 22
+            "line": 24
           },
           "name": "deployment",
           "optional": true,
@@ -1776,7 +1861,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 20
+            "line": 22
           },
           "name": "diff",
           "optional": true,
@@ -1821,7 +1906,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/awscdk/gitlab.ts",
-        "line": 29
+        "line": 31
       },
       "name": "GitlabRunnerTags",
       "properties": [
@@ -1834,7 +1919,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 35
+            "line": 37
           },
           "name": "assetPublishing",
           "optional": true,
@@ -1856,7 +1941,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 31
+            "line": 33
           },
           "name": "default",
           "optional": true,
@@ -1878,7 +1963,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 39
+            "line": 41
           },
           "name": "deployment",
           "optional": true,
@@ -1905,7 +1990,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 37
+            "line": 39
           },
           "name": "diff",
           "optional": true,
@@ -1932,7 +2017,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/awscdk/gitlab.ts",
-            "line": 33
+            "line": 35
           },
           "name": "synth",
           "optional": true,
@@ -2489,6 +2574,6 @@
       "symbolId": "src/awscdk/base:StageOptions"
     }
   },
-  "version": "0.0.69",
-  "fingerprint": "j87MTDjnj7tFpmFcFuJ2jrfecEhO7TlxLQLI0kPer7o="
+  "version": "0.0.71",
+  "fingerprint": "wOKcj00vMyiyEAOvouy3+3GK12AbF6C4h+mVreQmyVY="
 }

package/API.md

@@ -1487,6 +1487,7 @@ const githubCDKPipelineOptions: GithubCDKPipelineOptions = { ... }
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.stackPrefix">stackPrefix</a></code> | <code>string</code> | This field is used to define a prefix for the AWS Stack resources created during the pipeline's operation. |
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.GithubIamRoleConfig">GithubIamRoleConfig</a></code> | IAM config for GitHub Actions. |
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.runnerTags">runnerTags</a></code> | <code>string[]</code> | runner tags to use to select runners. |
+| <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.useGithubEnvironments">useGithubEnvironments</a></code> | <code>boolean</code> | whether to use GitHub environments for deployment stages. |
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.useGithubPackagesForAssembly">useGithubPackagesForAssembly</a></code> | <code>boolean</code> | use GitHub Packages to store vesioned artifacts of cloud assembly; |
 
 ---
@@ -1680,6 +1681,21 @@ runner tags to use to select runners.
 
 ---
 
+##### `useGithubEnvironments`<sup>Optional</sup> <a name="useGithubEnvironments" id="projen-pipelines.GithubCDKPipelineOptions.property.useGithubEnvironments"></a>
+
+```typescript
+public readonly useGithubEnvironments: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+whether to use GitHub environments for deployment stages.
+
+INFO: When using environments consider protection rules instead of using the manual option of projen-pipelines for stages
+
+---
+
 ##### `useGithubPackagesForAssembly`<sup>Optional</sup> <a name="useGithubPackagesForAssembly" id="projen-pipelines.GithubCDKPipelineOptions.property.useGithubPackagesForAssembly"></a>
 
 ```typescript
@@ -1711,6 +1727,7 @@ const githubIamRoleConfig: GithubIamRoleConfig = { ... }
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#projen-pipelines.GithubIamRoleConfig.property.assetPublishing">assetPublishing</a></code> | <code>string</code> | IAM role ARN for the asset publishing step. |
+| <code><a href="#projen-pipelines.GithubIamRoleConfig.property.assetPublishingPerStage">assetPublishingPerStage</a></code> | <code>{[ key: string ]: string}</code> | IAM role ARN for the asset publishing step for a specific stage. |
 | <code><a href="#projen-pipelines.GithubIamRoleConfig.property.default">default</a></code> | <code>string</code> | Default IAM role ARN used if no specific role is provided. |
 | <code><a href="#projen-pipelines.GithubIamRoleConfig.property.deployment">deployment</a></code> | <code>{[ key: string ]: string}</code> | IAM role ARNs for different deployment stages. |
 | <code><a href="#projen-pipelines.GithubIamRoleConfig.property.synth">synth</a></code> | <code>string</code> | IAM role ARN for the synthesis step. |
@@ -1729,6 +1746,18 @@ IAM role ARN for the asset publishing step.
 
 ---
 
+##### `assetPublishingPerStage`<sup>Optional</sup> <a name="assetPublishingPerStage" id="projen-pipelines.GithubIamRoleConfig.property.assetPublishingPerStage"></a>
+
+```typescript
+public readonly assetPublishingPerStage: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: string}
+
+IAM role ARN for the asset publishing step for a specific stage.
+
+---
+
 ##### `default`<sup>Optional</sup> <a name="default" id="projen-pipelines.GithubIamRoleConfig.property.default"></a>
 
 ```typescript
@@ -2078,7 +2107,8 @@ const gitlabIamRoleConfig: GitlabIamRoleConfig = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#projen-pipelines.GitlabIamRoleConfig.property.assetPublishing">assetPublishing</a></code> | <code>string</code> | IAM role ARN for the asset publishing stage. |
+| <code><a href="#projen-pipelines.GitlabIamRoleConfig.property.assetPublishing">assetPublishing</a></code> | <code>string</code> | IAM role ARN for the asset publishing step. |
+| <code><a href="#projen-pipelines.GitlabIamRoleConfig.property.assetPublishingPerStage">assetPublishingPerStage</a></code> | <code>{[ key: string ]: string}</code> | IAM role ARN for the asset publishing step for a specific stage. |
 | <code><a href="#projen-pipelines.GitlabIamRoleConfig.property.default">default</a></code> | <code>string</code> | Default IAM role ARN used if specific stage role is not provided. |
 | <code><a href="#projen-pipelines.GitlabIamRoleConfig.property.deployment">deployment</a></code> | <code>{[ key: string ]: string}</code> | A map of stage names to IAM role ARNs for the deployment operation. |
 | <code><a href="#projen-pipelines.GitlabIamRoleConfig.property.diff">diff</a></code> | <code>{[ key: string ]: string}</code> | A map of stage names to IAM role ARNs for the diff operation. |
@@ -2094,7 +2124,19 @@ public readonly assetPublishing: string;
 
 - *Type:* string
 
-IAM role ARN for the asset publishing stage.
+IAM role ARN for the asset publishing step.
+
+---
+
+##### `assetPublishingPerStage`<sup>Optional</sup> <a name="assetPublishingPerStage" id="projen-pipelines.GitlabIamRoleConfig.property.assetPublishingPerStage"></a>
+
+```typescript
+public readonly assetPublishingPerStage: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: string}
+
+IAM role ARN for the asset publishing step for a specific stage.
 
 ---
 

package/lib/awscdk/base.d.ts

@@ -115,7 +115,8 @@ export declare abstract class CDKPipeline extends Component {
     protected renderInstallCommands(): string[];
     protected renderInstallPackageCommands(packageName: string, runPreInstallCommands?: boolean): string[];
     protected renderSynthCommands(): string[];
-    protected getAssetUploadCommands(needsVersionedArtifacts: boolean): string[];
+    protected renderAssetUploadCommands(stageName?: string): string[];
+    protected renderAssemblyUploadCommands(): string[];
     protected renderDeployCommands(stageName: string): string[];
     protected renderDiffCommands(stageName: string): string[];
     protected createSafeStageName(name: string): string;