projen-pipelines 0.0.61 → 0.0.63

package/API.md

@@ -436,6 +436,7 @@ Configuration options for the pipeline.
 | <code><a href="#projen-pipelines.GithubCDKPipeline.engineType">engineType</a></code> | the type of engine this implementation of CDKPipeline is for. |
 | <code><a href="#projen-pipelines.GithubCDKPipeline.createAssetUpload">createAssetUpload</a></code> | Creates a job to upload assets to AWS as part of the pipeline. |
 | <code><a href="#projen-pipelines.GithubCDKPipeline.createDeployment">createDeployment</a></code> | Creates a job to deploy the CDK application to AWS. |
+| <code><a href="#projen-pipelines.GithubCDKPipeline.createIndependentDeployment">createIndependentDeployment</a></code> | Creates a job to deploy the CDK application to AWS. |
 
 ---
 
@@ -505,6 +506,22 @@ The deployment stage to create.
 
 ---
 
+##### `createIndependentDeployment` <a name="createIndependentDeployment" id="projen-pipelines.GithubCDKPipeline.createIndependentDeployment"></a>
+
+```typescript
+public createIndependentDeployment(stage: IndependentStage): void
+```
+
+Creates a job to deploy the CDK application to AWS.
+
+###### `stage`<sup>Required</sup> <a name="stage" id="projen-pipelines.GithubCDKPipeline.createIndependentDeployment.parameter.stage"></a>
+
+- *Type:* <a href="#projen-pipelines.IndependentStage">IndependentStage</a>
+
+The independent stage to create.
+
+---
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -676,6 +693,7 @@ Configuration options for the pipeline.
 | <code><a href="#projen-pipelines.GitlabCDKPipeline.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
 | <code><a href="#projen-pipelines.GitlabCDKPipeline.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
 | <code><a href="#projen-pipelines.GitlabCDKPipeline.engineType">engineType</a></code> | *No description.* |
+| <code><a href="#projen-pipelines.GitlabCDKPipeline.createIndependentDeployment">createIndependentDeployment</a></code> | Creates a job to deploy the CDK application to AWS. |
 
 ---
 
@@ -719,6 +737,22 @@ Synthesizes files to the project output directory.
 public engineType(): PipelineEngine
 ```
 
+##### `createIndependentDeployment` <a name="createIndependentDeployment" id="projen-pipelines.GitlabCDKPipeline.createIndependentDeployment"></a>
+
+```typescript
+public createIndependentDeployment(stage: IndependentStage): void
+```
+
+Creates a job to deploy the CDK application to AWS.
+
+###### `stage`<sup>Required</sup> <a name="stage" id="projen-pipelines.GitlabCDKPipeline.createIndependentDeployment.parameter.stage"></a>
+
+- *Type:* <a href="#projen-pipelines.IndependentStage">IndependentStage</a>
+
+The independent stage to create.
+
+---
+
 #### Static Functions <a name="Static Functions" id="Static Functions"></a>
 
 | **Name** | **Description** |
@@ -890,11 +924,12 @@ const bashCDKPipelineOptions: BashCDKPipelineOptions = { ... }
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
-| <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | *No description.* |
+| <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | This field specifies a list of stages that should be deployed using a CI/CD pipeline. |
 | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
 | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.deploySubStacks">deploySubStacks</a></code> | <code>boolean</code> | If set to true all CDK actions will also include <stackName>/* to deploy/diff/destroy sub stacks of the main stack. |
-| <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | *No description.* |
-| <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | *No description.* |
+| <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for feature stages. |
+| <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.independentStages">independentStages</a></code> | <code><a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]</code> | This specifies details for independent stages. |
+| <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for a personal stage. |
 | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
 | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
 | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
@@ -928,6 +963,8 @@ public readonly stages: DeploymentStage[];
 
 - *Type:* <a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]
 
+This field specifies a list of stages that should be deployed using a CI/CD pipeline.
+
 ---
 
 ##### `branchName`<sup>Optional</sup> <a name="branchName" id="projen-pipelines.BashCDKPipelineOptions.property.branchName"></a>
@@ -966,6 +1003,20 @@ public readonly featureStages: StageOptions;
 
 - *Type:* <a href="#projen-pipelines.StageOptions">StageOptions</a>
 
+This specifies details for feature stages.
+
+---
+
+##### `independentStages`<sup>Optional</sup> <a name="independentStages" id="projen-pipelines.BashCDKPipelineOptions.property.independentStages"></a>
+
+```typescript
+public readonly independentStages: IndependentStage[];
+```
+
+- *Type:* <a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]
+
+This specifies details for independent stages.
+
 ---
 
 ##### `personalStage`<sup>Optional</sup> <a name="personalStage" id="projen-pipelines.BashCDKPipelineOptions.property.personalStage"></a>
@@ -976,6 +1027,8 @@ public readonly personalStage: StageOptions;
 
 - *Type:* <a href="#projen-pipelines.StageOptions">StageOptions</a>
 
+This specifies details for a personal stage.
+
 ---
 
 ##### `postSynthCommands`<sup>Optional</sup> <a name="postSynthCommands" id="projen-pipelines.BashCDKPipelineOptions.property.postSynthCommands"></a>
@@ -1104,11 +1157,12 @@ const cDKPipelineOptions: CDKPipelineOptions = { ... }
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#projen-pipelines.CDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
-| <code><a href="#projen-pipelines.CDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | *No description.* |
+| <code><a href="#projen-pipelines.CDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | This field specifies a list of stages that should be deployed using a CI/CD pipeline. |
 | <code><a href="#projen-pipelines.CDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
 | <code><a href="#projen-pipelines.CDKPipelineOptions.property.deploySubStacks">deploySubStacks</a></code> | <code>boolean</code> | If set to true all CDK actions will also include <stackName>/* to deploy/diff/destroy sub stacks of the main stack. |
-| <code><a href="#projen-pipelines.CDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | *No description.* |
-| <code><a href="#projen-pipelines.CDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | *No description.* |
+| <code><a href="#projen-pipelines.CDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for feature stages. |
+| <code><a href="#projen-pipelines.CDKPipelineOptions.property.independentStages">independentStages</a></code> | <code><a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]</code> | This specifies details for independent stages. |
+| <code><a href="#projen-pipelines.CDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for a personal stage. |
 | <code><a href="#projen-pipelines.CDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
 | <code><a href="#projen-pipelines.CDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
 | <code><a href="#projen-pipelines.CDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
@@ -1142,6 +1196,8 @@ public readonly stages: DeploymentStage[];
 
 - *Type:* <a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]
 
+This field specifies a list of stages that should be deployed using a CI/CD pipeline.
+
 ---
 
 ##### `branchName`<sup>Optional</sup> <a name="branchName" id="projen-pipelines.CDKPipelineOptions.property.branchName"></a>
@@ -1180,6 +1236,20 @@ public readonly featureStages: StageOptions;
 
 - *Type:* <a href="#projen-pipelines.StageOptions">StageOptions</a>
 
+This specifies details for feature stages.
+
+---
+
+##### `independentStages`<sup>Optional</sup> <a name="independentStages" id="projen-pipelines.CDKPipelineOptions.property.independentStages"></a>
+
+```typescript
+public readonly independentStages: IndependentStage[];
+```
+
+- *Type:* <a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]
+
+This specifies details for independent stages.
+
 ---
 
 ##### `personalStage`<sup>Optional</sup> <a name="personalStage" id="projen-pipelines.CDKPipelineOptions.property.personalStage"></a>
@@ -1190,6 +1260,8 @@ public readonly personalStage: StageOptions;
 
 - *Type:* <a href="#projen-pipelines.StageOptions">StageOptions</a>
 
+This specifies details for a personal stage.
+
 ---
 
 ##### `postSynthCommands`<sup>Optional</sup> <a name="postSynthCommands" id="projen-pipelines.CDKPipelineOptions.property.postSynthCommands"></a>
@@ -1267,6 +1339,8 @@ This field is used to define a prefix for the AWS Stack resources created during
 
 ### DeploymentStage <a name="DeploymentStage" id="projen-pipelines.DeploymentStage"></a>
 
+Options for stages that are part of the pipeline.
+
 #### Initializer <a name="Initializer" id="projen-pipelines.DeploymentStage.Initializer"></a>
 
 ```typescript
@@ -1387,11 +1461,12 @@ const githubCDKPipelineOptions: GithubCDKPipelineOptions = { ... }
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
-| <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | *No description.* |
+| <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | This field specifies a list of stages that should be deployed using a CI/CD pipeline. |
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.deploySubStacks">deploySubStacks</a></code> | <code>boolean</code> | If set to true all CDK actions will also include <stackName>/* to deploy/diff/destroy sub stacks of the main stack. |
-| <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | *No description.* |
-| <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | *No description.* |
+| <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for feature stages. |
+| <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.independentStages">independentStages</a></code> | <code><a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]</code> | This specifies details for independent stages. |
+| <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for a personal stage. |
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
 | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
@@ -1428,6 +1503,8 @@ public readonly stages: DeploymentStage[];
 
 - *Type:* <a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]
 
+This field specifies a list of stages that should be deployed using a CI/CD pipeline.
+
 ---
 
 ##### `branchName`<sup>Optional</sup> <a name="branchName" id="projen-pipelines.GithubCDKPipelineOptions.property.branchName"></a>
@@ -1466,6 +1543,20 @@ public readonly featureStages: StageOptions;
 
 - *Type:* <a href="#projen-pipelines.StageOptions">StageOptions</a>
 
+This specifies details for feature stages.
+
+---
+
+##### `independentStages`<sup>Optional</sup> <a name="independentStages" id="projen-pipelines.GithubCDKPipelineOptions.property.independentStages"></a>
+
+```typescript
+public readonly independentStages: IndependentStage[];
+```
+
+- *Type:* <a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]
+
+This specifies details for independent stages.
+
 ---
 
 ##### `personalStage`<sup>Optional</sup> <a name="personalStage" id="projen-pipelines.GithubCDKPipelineOptions.property.personalStage"></a>
@@ -1476,6 +1567,8 @@ public readonly personalStage: StageOptions;
 
 - *Type:* <a href="#projen-pipelines.StageOptions">StageOptions</a>
 
+This specifies details for a personal stage.
+
 ---
 
 ##### `postSynthCommands`<sup>Optional</sup> <a name="postSynthCommands" id="projen-pipelines.GithubCDKPipelineOptions.property.postSynthCommands"></a>
@@ -1677,11 +1770,24 @@ const githubStepConfig: GithubStepConfig = { ... }
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
+| <code><a href="#projen-pipelines.GithubStepConfig.property.env">env</a></code> | <code>{[ key: string ]: string}</code> | Additional environment variables to set for this step. |
 | <code><a href="#projen-pipelines.GithubStepConfig.property.needs">needs</a></code> | <code>string[]</code> | Dependencies which need to be completed before this step. |
 | <code><a href="#projen-pipelines.GithubStepConfig.property.steps">steps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Commands wrapped as GitHub Action job steps. |
 
 ---
 
+##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.GithubStepConfig.property.env"></a>
+
+```typescript
+public readonly env: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: string}
+
+Additional environment variables to set for this step.
+
+---
+
 ##### `needs`<sup>Required</sup> <a name="needs" id="projen-pipelines.GithubStepConfig.property.needs"></a>
 
 ```typescript
@@ -1723,11 +1829,12 @@ const gitlabCDKPipelineOptions: GitlabCDKPipelineOptions = { ... }
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
-| <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | *No description.* |
+| <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.stages">stages</a></code> | <code><a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]</code> | This field specifies a list of stages that should be deployed using a CI/CD pipeline. |
 | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
 | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.deploySubStacks">deploySubStacks</a></code> | <code>boolean</code> | If set to true all CDK actions will also include <stackName>/* to deploy/diff/destroy sub stacks of the main stack. |
-| <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | *No description.* |
-| <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | *No description.* |
+| <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.featureStages">featureStages</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for feature stages. |
+| <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.independentStages">independentStages</a></code> | <code><a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]</code> | This specifies details for independent stages. |
+| <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.personalStage">personalStage</a></code> | <code><a href="#projen-pipelines.StageOptions">StageOptions</a></code> | This specifies details for a personal stage. |
 | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
 | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
 | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
@@ -1764,6 +1871,8 @@ public readonly stages: DeploymentStage[];
 
 - *Type:* <a href="#projen-pipelines.DeploymentStage">DeploymentStage</a>[]
 
+This field specifies a list of stages that should be deployed using a CI/CD pipeline.
+
 ---
 
 ##### `branchName`<sup>Optional</sup> <a name="branchName" id="projen-pipelines.GitlabCDKPipelineOptions.property.branchName"></a>
@@ -1802,6 +1911,20 @@ public readonly featureStages: StageOptions;
 
 - *Type:* <a href="#projen-pipelines.StageOptions">StageOptions</a>
 
+This specifies details for feature stages.
+
+---
+
+##### `independentStages`<sup>Optional</sup> <a name="independentStages" id="projen-pipelines.GitlabCDKPipelineOptions.property.independentStages"></a>
+
+```typescript
+public readonly independentStages: IndependentStage[];
+```
+
+- *Type:* <a href="#projen-pipelines.IndependentStage">IndependentStage</a>[]
+
+This specifies details for independent stages.
+
 ---
 
 ##### `personalStage`<sup>Optional</sup> <a name="personalStage" id="projen-pipelines.GitlabCDKPipelineOptions.property.personalStage"></a>
@@ -1812,6 +1935,8 @@ public readonly personalStage: StageOptions;
 
 - *Type:* <a href="#projen-pipelines.StageOptions">StageOptions</a>
 
+This specifies details for a personal stage.
+
 ---
 
 ##### `postSynthCommands`<sup>Optional</sup> <a name="postSynthCommands" id="projen-pipelines.GitlabCDKPipelineOptions.property.postSynthCommands"></a>
@@ -2113,6 +2238,7 @@ const gitlabStepConfig: GitlabStepConfig = { ... }
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#projen-pipelines.GitlabStepConfig.property.commands">commands</a></code> | <code>string[]</code> | Shell commands to execute in this step. |
+| <code><a href="#projen-pipelines.GitlabStepConfig.property.env">env</a></code> | <code>{[ key: string ]: string}</code> | Additional environment variables to set for this step. |
 | <code><a href="#projen-pipelines.GitlabStepConfig.property.extensions">extensions</a></code> | <code>string[]</code> | List of job extensions related to the step. |
 | <code><a href="#projen-pipelines.GitlabStepConfig.property.needs">needs</a></code> | <code>projen.gitlab.Need[]</code> | Dependencies which need to be completed before this step. |
 
@@ -2130,6 +2256,18 @@ Shell commands to execute in this step.
 
 ---
 
+##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.GitlabStepConfig.property.env"></a>
+
+```typescript
+public readonly env: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: string}
+
+Additional environment variables to set for this step.
+
+---
+
 ##### `extensions`<sup>Required</sup> <a name="extensions" id="projen-pipelines.GitlabStepConfig.property.extensions"></a>
 
 ```typescript
@@ -2154,8 +2292,114 @@ Dependencies which need to be completed before this step.
 
 ---
 
+### IndependentStage <a name="IndependentStage" id="projen-pipelines.IndependentStage"></a>
+
+Options for stages that are not part of the pipeline.
+
+#### Initializer <a name="Initializer" id="projen-pipelines.IndependentStage.Initializer"></a>
+
+```typescript
+import { IndependentStage } from 'projen-pipelines'
+
+const independentStage: IndependentStage = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#projen-pipelines.IndependentStage.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
+| <code><a href="#projen-pipelines.IndependentStage.property.name">name</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#projen-pipelines.IndependentStage.property.postDeploySteps">postDeploySteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
+| <code><a href="#projen-pipelines.IndependentStage.property.postDiffSteps">postDiffSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
+
+---
+
+##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.IndependentStage.property.env"></a>
+
+```typescript
+public readonly env: Environment;
+```
+
+- *Type:* <a href="#projen-pipelines.Environment">Environment</a>
+
+---
+
+##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.IndependentStage.property.name"></a>
+
+```typescript
+public readonly name: string;
+```
+
+- *Type:* string
+
+---
+
+##### `postDeploySteps`<sup>Optional</sup> <a name="postDeploySteps" id="projen-pipelines.IndependentStage.property.postDeploySteps"></a>
+
+```typescript
+public readonly postDeploySteps: PipelineStep[];
+```
+
+- *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
+
+---
+
+##### `postDiffSteps`<sup>Optional</sup> <a name="postDiffSteps" id="projen-pipelines.IndependentStage.property.postDiffSteps"></a>
+
+```typescript
+public readonly postDiffSteps: PipelineStep[];
+```
+
+- *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
+
+---
+
+### NamedStageOptions <a name="NamedStageOptions" id="projen-pipelines.NamedStageOptions"></a>
+
+Options for a CDK stage with a name.
+
+#### Initializer <a name="Initializer" id="projen-pipelines.NamedStageOptions.Initializer"></a>
+
+```typescript
+import { NamedStageOptions } from 'projen-pipelines'
+
+const namedStageOptions: NamedStageOptions = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#projen-pipelines.NamedStageOptions.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
+| <code><a href="#projen-pipelines.NamedStageOptions.property.name">name</a></code> | <code>string</code> | *No description.* |
+
+---
+
+##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.NamedStageOptions.property.env"></a>
+
+```typescript
+public readonly env: Environment;
+```
+
+- *Type:* <a href="#projen-pipelines.Environment">Environment</a>
+
+---
+
+##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.NamedStageOptions.property.name"></a>
+
+```typescript
+public readonly name: string;
+```
+
+- *Type:* string
+
+---
+
 ### StageOptions <a name="StageOptions" id="projen-pipelines.StageOptions"></a>
 
+Options for a CDK stage like the target environment.
+
 #### Initializer <a name="Initializer" id="projen-pipelines.StageOptions.Initializer"></a>
 
 ```typescript
@@ -2228,7 +2472,7 @@ public toBash(): BashStepConfig
 
 Generates a configuration for a bash script step.
 
-Must be implemented by subclasses.
+Should be implemented by subclasses.
 
 ##### `toGithub` <a name="toGithub" id="projen-pipelines.PipelineStep.toGithub"></a>
 
@@ -2238,7 +2482,7 @@ public toGithub(): GithubStepConfig
 
 Generates a configuration for a GitHub Actions step.
 
-Must be implemented by subclasses.
+Should be implemented by subclasses.
 
 ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.PipelineStep.toGitlab"></a>
 
@@ -2248,7 +2492,7 @@ public toGitlab(): GitlabStepConfig
 
 Generates a configuration for a GitLab CI step.
 
-Must be implemented by subclasses.
+Should be implemented by subclasses.
 
 
 

package/README.md

@@ -195,3 +195,17 @@ git push origin my-branch
 8. **Submit a Pull Request**: Once your changes are ready to be reviewed, create a pull request from your forked repository's branch into the `main` branch of this repository.
 
 Your pull request will be reviewed and hopefully merged quickly. Thanks for contributing!
+
+## Known issues
+
+### Environment variable not recognized during `npx projen`
+
+When attempting to run `npx projen`, users may encounter an error related to environment variable substitution within configuration files. Specifically, the `${GITHUB_TOKEN}` placeholder fails to be replaced.
+
+#### Solution
+
+To resolve this issue, prefix the `npx projen` command with the `GITHUB_TOKEN=` environment variable:
+
+```bash
+GITHUB_TOKEN= npx projen
+```

package/lib/awscdk/base.d.ts

@@ -20,11 +20,28 @@ export interface Environment {
      */
     readonly region: string;
 }
-export interface DeploymentStage {
-    readonly name: string;
-    readonly env: Environment;
+/**
+ * Options for stages that are part of the pipeline
+ */
+export interface DeploymentStage extends NamedStageOptions {
     readonly manualApproval?: boolean;
 }
+/**
+ * Options for stages that are not part of the pipeline
+ */
+export interface IndependentStage extends NamedStageOptions {
+    readonly postDiffSteps?: PipelineStep[];
+    readonly postDeploySteps?: PipelineStep[];
+}
+/**
+ * Options for a CDK stage with a name
+ */
+export interface NamedStageOptions extends StageOptions {
+    readonly name: string;
+}
+/**
+ * Options for a CDK stage like the target environment
+ */
 export interface StageOptions {
     readonly env: Environment;
 }
@@ -60,8 +77,15 @@ export interface CDKPipelineOptions {
      * better organization and ease of management.
      */
     readonly pkgNamespace: string;
+    /**
+     * This field specifies a list of stages that should be deployed using a CI/CD pipeline
+     */
     readonly stages: DeploymentStage[];
+    /** This specifies details for independent stages */
+    readonly independentStages?: IndependentStage[];
+    /** This specifies details for a personal stage */
     readonly personalStage?: StageOptions;
+    /** This specifies details for feature stages */
     readonly featureStages?: StageOptions;
     readonly preInstallCommands?: string[];
     readonly preSynthCommands?: string[];
@@ -112,5 +136,10 @@ export declare abstract class CDKPipeline extends Component {
      * @param {DeployStageOptions} stage - The stage to create
      */
     protected createPipelineStage(stage: DeploymentStage): void;
+    /**
+     * This method sets up tasks for the independent stages including deployment and comparing changes (diff).
+     * @param {NamedStageOptions} stage - The stage to create
+     */
+    protected createIndependentStage(stage: IndependentStage): void;
     protected getCliStackPattern(stage: string): string;
 }