projen-pipelines 0.1.1 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/API.md CHANGED
@@ -1226,6 +1226,7 @@ const bashCDKPipelineOptions: BashCDKPipelineOptions = { ... }
1226
1226
 
1227
1227
  | **Name** | **Type** | **Description** |
1228
1228
  | --- | --- | --- |
1229
+ | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
1229
1230
  | <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. |
1230
1231
  | <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. |
1231
1232
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
@@ -1243,6 +1244,18 @@ const bashCDKPipelineOptions: BashCDKPipelineOptions = { ... }
1243
1244
 
1244
1245
  ---
1245
1246
 
1247
+ ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.BashCDKPipelineOptions.property.iamRoleArns"></a>
1248
+
1249
+ ```typescript
1250
+ public readonly iamRoleArns: IamRoleConfig;
1251
+ ```
1252
+
1253
+ - *Type:* <a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a>
1254
+
1255
+ IAM config.
1256
+
1257
+ ---
1258
+
1246
1259
  ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="projen-pipelines.BashCDKPipelineOptions.property.pkgNamespace"></a>
1247
1260
 
1248
1261
  ```typescript
@@ -1459,6 +1472,7 @@ const cDKPipelineOptions: CDKPipelineOptions = { ... }
1459
1472
 
1460
1473
  | **Name** | **Type** | **Description** |
1461
1474
  | --- | --- | --- |
1475
+ | <code><a href="#projen-pipelines.CDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
1462
1476
  | <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. |
1463
1477
  | <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. |
1464
1478
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
@@ -1476,6 +1490,18 @@ const cDKPipelineOptions: CDKPipelineOptions = { ... }
1476
1490
 
1477
1491
  ---
1478
1492
 
1493
+ ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.CDKPipelineOptions.property.iamRoleArns"></a>
1494
+
1495
+ ```typescript
1496
+ public readonly iamRoleArns: IamRoleConfig;
1497
+ ```
1498
+
1499
+ - *Type:* <a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a>
1500
+
1501
+ IAM config.
1502
+
1503
+ ---
1504
+
1479
1505
  ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="projen-pipelines.CDKPipelineOptions.property.pkgNamespace"></a>
1480
1506
 
1481
1507
  ```typescript
@@ -1640,6 +1666,67 @@ This field is used to define a prefix for the AWS Stack resources created during
1640
1666
 
1641
1667
  ---
1642
1668
 
1669
+ ### CodeArtifactLoginStepOptions <a name="CodeArtifactLoginStepOptions" id="projen-pipelines.CodeArtifactLoginStepOptions"></a>
1670
+
1671
+ #### Initializer <a name="Initializer" id="projen-pipelines.CodeArtifactLoginStepOptions.Initializer"></a>
1672
+
1673
+ ```typescript
1674
+ import { CodeArtifactLoginStepOptions } from 'projen-pipelines'
1675
+
1676
+ const codeArtifactLoginStepOptions: CodeArtifactLoginStepOptions = { ... }
1677
+ ```
1678
+
1679
+ #### Properties <a name="Properties" id="Properties"></a>
1680
+
1681
+ | **Name** | **Type** | **Description** |
1682
+ | --- | --- | --- |
1683
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStepOptions.property.domainName">domainName</a></code> | <code>string</code> | *No description.* |
1684
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStepOptions.property.ownerAccount">ownerAccount</a></code> | <code>string</code> | *No description.* |
1685
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStepOptions.property.region">region</a></code> | <code>string</code> | *No description.* |
1686
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStepOptions.property.role">role</a></code> | <code>string</code> | *No description.* |
1687
+
1688
+ ---
1689
+
1690
+ ##### `domainName`<sup>Required</sup> <a name="domainName" id="projen-pipelines.CodeArtifactLoginStepOptions.property.domainName"></a>
1691
+
1692
+ ```typescript
1693
+ public readonly domainName: string;
1694
+ ```
1695
+
1696
+ - *Type:* string
1697
+
1698
+ ---
1699
+
1700
+ ##### `ownerAccount`<sup>Required</sup> <a name="ownerAccount" id="projen-pipelines.CodeArtifactLoginStepOptions.property.ownerAccount"></a>
1701
+
1702
+ ```typescript
1703
+ public readonly ownerAccount: string;
1704
+ ```
1705
+
1706
+ - *Type:* string
1707
+
1708
+ ---
1709
+
1710
+ ##### `region`<sup>Required</sup> <a name="region" id="projen-pipelines.CodeArtifactLoginStepOptions.property.region"></a>
1711
+
1712
+ ```typescript
1713
+ public readonly region: string;
1714
+ ```
1715
+
1716
+ - *Type:* string
1717
+
1718
+ ---
1719
+
1720
+ ##### `role`<sup>Required</sup> <a name="role" id="projen-pipelines.CodeArtifactLoginStepOptions.property.role"></a>
1721
+
1722
+ ```typescript
1723
+ public readonly role: string;
1724
+ ```
1725
+
1726
+ - *Type:* string
1727
+
1728
+ ---
1729
+
1643
1730
  ### CodeCatalystCDKPipelineOptions <a name="CodeCatalystCDKPipelineOptions" id="projen-pipelines.CodeCatalystCDKPipelineOptions"></a>
1644
1731
 
1645
1732
  #### Initializer <a name="Initializer" id="projen-pipelines.CodeCatalystCDKPipelineOptions.Initializer"></a>
@@ -1654,6 +1741,7 @@ const codeCatalystCDKPipelineOptions: CodeCatalystCDKPipelineOptions = { ... }
1654
1741
 
1655
1742
  | **Name** | **Type** | **Description** |
1656
1743
  | --- | --- | --- |
1744
+ | <code><a href="#projen-pipelines.CodeCatalystCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
1657
1745
  | <code><a href="#projen-pipelines.CodeCatalystCDKPipelineOptions.property.pkgNamespace">pkgNamespace</a></code> | <code>string</code> | This field determines the NPM namespace to be used when packaging CDK cloud assemblies. |
1658
1746
  | <code><a href="#projen-pipelines.CodeCatalystCDKPipelineOptions.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. |
1659
1747
  | <code><a href="#projen-pipelines.CodeCatalystCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
@@ -1668,7 +1756,18 @@ const codeCatalystCDKPipelineOptions: CodeCatalystCDKPipelineOptions = { ... }
1668
1756
  | <code><a href="#projen-pipelines.CodeCatalystCDKPipelineOptions.property.preSynthCommands">preSynthCommands</a></code> | <code>string[]</code> | *No description.* |
1669
1757
  | <code><a href="#projen-pipelines.CodeCatalystCDKPipelineOptions.property.preSynthSteps">preSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
1670
1758
  | <code><a href="#projen-pipelines.CodeCatalystCDKPipelineOptions.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. |
1671
- | <code><a href="#projen-pipelines.CodeCatalystCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.CodeCatalystIamRoleConfig">CodeCatalystIamRoleConfig</a></code> | *No description.* |
1759
+
1760
+ ---
1761
+
1762
+ ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.CodeCatalystCDKPipelineOptions.property.iamRoleArns"></a>
1763
+
1764
+ ```typescript
1765
+ public readonly iamRoleArns: IamRoleConfig;
1766
+ ```
1767
+
1768
+ - *Type:* <a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a>
1769
+
1770
+ IAM config.
1672
1771
 
1673
1772
  ---
1674
1773
 
@@ -1836,98 +1935,6 @@ This field is used to define a prefix for the AWS Stack resources created during
1836
1935
 
1837
1936
  ---
1838
1937
 
1839
- ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.CodeCatalystCDKPipelineOptions.property.iamRoleArns"></a>
1840
-
1841
- ```typescript
1842
- public readonly iamRoleArns: CodeCatalystIamRoleConfig;
1843
- ```
1844
-
1845
- - *Type:* <a href="#projen-pipelines.CodeCatalystIamRoleConfig">CodeCatalystIamRoleConfig</a>
1846
-
1847
- ---
1848
-
1849
- ### CodeCatalystIamRoleConfig <a name="CodeCatalystIamRoleConfig" id="projen-pipelines.CodeCatalystIamRoleConfig"></a>
1850
-
1851
- #### Initializer <a name="Initializer" id="projen-pipelines.CodeCatalystIamRoleConfig.Initializer"></a>
1852
-
1853
- ```typescript
1854
- import { CodeCatalystIamRoleConfig } from 'projen-pipelines'
1855
-
1856
- const codeCatalystIamRoleConfig: CodeCatalystIamRoleConfig = { ... }
1857
- ```
1858
-
1859
- #### Properties <a name="Properties" id="Properties"></a>
1860
-
1861
- | **Name** | **Type** | **Description** |
1862
- | --- | --- | --- |
1863
- | <code><a href="#projen-pipelines.CodeCatalystIamRoleConfig.property.assetPublishing">assetPublishing</a></code> | <code>string</code> | IAM role ARN for the asset publishing step. |
1864
- | <code><a href="#projen-pipelines.CodeCatalystIamRoleConfig.property.assetPublishingPerStage">assetPublishingPerStage</a></code> | <code>{[ key: string ]: string}</code> | IAM role ARN for the asset publishing step for a specific stage. |
1865
- | <code><a href="#projen-pipelines.CodeCatalystIamRoleConfig.property.default">default</a></code> | <code>string</code> | Default IAM role ARN used if no specific role is provided. |
1866
- | <code><a href="#projen-pipelines.CodeCatalystIamRoleConfig.property.deployment">deployment</a></code> | <code>{[ key: string ]: string}</code> | IAM role ARNs for different deployment stages. |
1867
- | <code><a href="#projen-pipelines.CodeCatalystIamRoleConfig.property.synth">synth</a></code> | <code>string</code> | IAM role ARN for the synthesis step. |
1868
-
1869
- ---
1870
-
1871
- ##### `assetPublishing`<sup>Optional</sup> <a name="assetPublishing" id="projen-pipelines.CodeCatalystIamRoleConfig.property.assetPublishing"></a>
1872
-
1873
- ```typescript
1874
- public readonly assetPublishing: string;
1875
- ```
1876
-
1877
- - *Type:* string
1878
-
1879
- IAM role ARN for the asset publishing step.
1880
-
1881
- ---
1882
-
1883
- ##### `assetPublishingPerStage`<sup>Optional</sup> <a name="assetPublishingPerStage" id="projen-pipelines.CodeCatalystIamRoleConfig.property.assetPublishingPerStage"></a>
1884
-
1885
- ```typescript
1886
- public readonly assetPublishingPerStage: {[ key: string ]: string};
1887
- ```
1888
-
1889
- - *Type:* {[ key: string ]: string}
1890
-
1891
- IAM role ARN for the asset publishing step for a specific stage.
1892
-
1893
- ---
1894
-
1895
- ##### `default`<sup>Optional</sup> <a name="default" id="projen-pipelines.CodeCatalystIamRoleConfig.property.default"></a>
1896
-
1897
- ```typescript
1898
- public readonly default: string;
1899
- ```
1900
-
1901
- - *Type:* string
1902
-
1903
- Default IAM role ARN used if no specific role is provided.
1904
-
1905
- ---
1906
-
1907
- ##### `deployment`<sup>Optional</sup> <a name="deployment" id="projen-pipelines.CodeCatalystIamRoleConfig.property.deployment"></a>
1908
-
1909
- ```typescript
1910
- public readonly deployment: {[ key: string ]: string};
1911
- ```
1912
-
1913
- - *Type:* {[ key: string ]: string}
1914
-
1915
- IAM role ARNs for different deployment stages.
1916
-
1917
- ---
1918
-
1919
- ##### `synth`<sup>Optional</sup> <a name="synth" id="projen-pipelines.CodeCatalystIamRoleConfig.property.synth"></a>
1920
-
1921
- ```typescript
1922
- public readonly synth: string;
1923
- ```
1924
-
1925
- - *Type:* string
1926
-
1927
- IAM role ARN for the synthesis step.
1928
-
1929
- ---
1930
-
1931
1938
  ### CodeCatalystStepConfig <a name="CodeCatalystStepConfig" id="projen-pipelines.CodeCatalystStepConfig"></a>
1932
1939
 
1933
1940
  Configuration interface for a CodeCatalyst Actions step.
@@ -2004,6 +2011,9 @@ const deploymentStage: DeploymentStage = { ... }
2004
2011
  | --- | --- | --- |
2005
2012
  | <code><a href="#projen-pipelines.DeploymentStage.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
2006
2013
  | <code><a href="#projen-pipelines.DeploymentStage.property.name">name</a></code> | <code>string</code> | *No description.* |
2014
+ | <code><a href="#projen-pipelines.DeploymentStage.property.diffType">diffType</a></code> | <code><a href="#projen-pipelines.CdkDiffType">CdkDiffType</a></code> | *No description.* |
2015
+ | <code><a href="#projen-pipelines.DeploymentStage.property.postDeploySteps">postDeploySteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2016
+ | <code><a href="#projen-pipelines.DeploymentStage.property.postDiffSteps">postDiffSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2007
2017
  | <code><a href="#projen-pipelines.DeploymentStage.property.watchable">watchable</a></code> | <code>boolean</code> | *No description.* |
2008
2018
  | <code><a href="#projen-pipelines.DeploymentStage.property.manualApproval">manualApproval</a></code> | <code>boolean</code> | *No description.* |
2009
2019
 
@@ -2029,6 +2039,36 @@ public readonly name: string;
2029
2039
 
2030
2040
  ---
2031
2041
 
2042
+ ##### `diffType`<sup>Optional</sup> <a name="diffType" id="projen-pipelines.DeploymentStage.property.diffType"></a>
2043
+
2044
+ ```typescript
2045
+ public readonly diffType: CdkDiffType;
2046
+ ```
2047
+
2048
+ - *Type:* <a href="#projen-pipelines.CdkDiffType">CdkDiffType</a>
2049
+
2050
+ ---
2051
+
2052
+ ##### `postDeploySteps`<sup>Optional</sup> <a name="postDeploySteps" id="projen-pipelines.DeploymentStage.property.postDeploySteps"></a>
2053
+
2054
+ ```typescript
2055
+ public readonly postDeploySteps: PipelineStep[];
2056
+ ```
2057
+
2058
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
2059
+
2060
+ ---
2061
+
2062
+ ##### `postDiffSteps`<sup>Optional</sup> <a name="postDiffSteps" id="projen-pipelines.DeploymentStage.property.postDiffSteps"></a>
2063
+
2064
+ ```typescript
2065
+ public readonly postDiffSteps: PipelineStep[];
2066
+ ```
2067
+
2068
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
2069
+
2070
+ ---
2071
+
2032
2072
  ##### `watchable`<sup>Optional</sup> <a name="watchable" id="projen-pipelines.DeploymentStage.property.watchable"></a>
2033
2073
 
2034
2074
  ```typescript
@@ -2159,6 +2199,7 @@ const githubCDKPipelineOptions: GithubCDKPipelineOptions = { ... }
2159
2199
 
2160
2200
  | **Name** | **Type** | **Description** |
2161
2201
  | --- | --- | --- |
2202
+ | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
2162
2203
  | <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. |
2163
2204
  | <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. |
2164
2205
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
@@ -2173,13 +2214,24 @@ const githubCDKPipelineOptions: GithubCDKPipelineOptions = { ... }
2173
2214
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.preSynthCommands">preSynthCommands</a></code> | <code>string[]</code> | *No description.* |
2174
2215
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.preSynthSteps">preSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2175
2216
  | <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. |
2176
- | <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. |
2177
2217
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.runnerTags">runnerTags</a></code> | <code>string[]</code> | runner tags to use to select runners. |
2178
2218
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.useGithubEnvironments">useGithubEnvironments</a></code> | <code>boolean</code> | whether to use GitHub environments for deployment stages. |
2179
2219
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.useGithubPackagesForAssembly">useGithubPackagesForAssembly</a></code> | <code>boolean</code> | use GitHub Packages to store vesioned artifacts of cloud assembly; |
2180
2220
 
2181
2221
  ---
2182
2222
 
2223
+ ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.GithubCDKPipelineOptions.property.iamRoleArns"></a>
2224
+
2225
+ ```typescript
2226
+ public readonly iamRoleArns: IamRoleConfig;
2227
+ ```
2228
+
2229
+ - *Type:* <a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a>
2230
+
2231
+ IAM config.
2232
+
2233
+ ---
2234
+
2183
2235
  ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="projen-pipelines.GithubCDKPipelineOptions.property.pkgNamespace"></a>
2184
2236
 
2185
2237
  ```typescript
@@ -2344,18 +2396,6 @@ This field is used to define a prefix for the AWS Stack resources created during
2344
2396
 
2345
2397
  ---
2346
2398
 
2347
- ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.GithubCDKPipelineOptions.property.iamRoleArns"></a>
2348
-
2349
- ```typescript
2350
- public readonly iamRoleArns: GithubIamRoleConfig;
2351
- ```
2352
-
2353
- - *Type:* <a href="#projen-pipelines.GithubIamRoleConfig">GithubIamRoleConfig</a>
2354
-
2355
- IAM config for GitHub Actions.
2356
-
2357
- ---
2358
-
2359
2399
  ##### `runnerTags`<sup>Optional</sup> <a name="runnerTags" id="projen-pipelines.GithubCDKPipelineOptions.property.runnerTags"></a>
2360
2400
 
2361
2401
  ```typescript
@@ -2398,187 +2438,103 @@ also needed for manual approvals
2398
2438
 
2399
2439
  ---
2400
2440
 
2401
- ### GithubIamRoleConfig <a name="GithubIamRoleConfig" id="projen-pipelines.GithubIamRoleConfig"></a>
2402
-
2403
- Configuration interface for GitHub-specific IAM roles used in the CDK pipeline.
2441
+ ### GithubPackagesLoginStepOptions <a name="GithubPackagesLoginStepOptions" id="projen-pipelines.GithubPackagesLoginStepOptions"></a>
2404
2442
 
2405
- #### Initializer <a name="Initializer" id="projen-pipelines.GithubIamRoleConfig.Initializer"></a>
2443
+ #### Initializer <a name="Initializer" id="projen-pipelines.GithubPackagesLoginStepOptions.Initializer"></a>
2406
2444
 
2407
2445
  ```typescript
2408
- import { GithubIamRoleConfig } from 'projen-pipelines'
2446
+ import { GithubPackagesLoginStepOptions } from 'projen-pipelines'
2409
2447
 
2410
- const githubIamRoleConfig: GithubIamRoleConfig = { ... }
2448
+ const githubPackagesLoginStepOptions: GithubPackagesLoginStepOptions = { ... }
2411
2449
  ```
2412
2450
 
2413
2451
  #### Properties <a name="Properties" id="Properties"></a>
2414
2452
 
2415
2453
  | **Name** | **Type** | **Description** |
2416
2454
  | --- | --- | --- |
2417
- | <code><a href="#projen-pipelines.GithubIamRoleConfig.property.assetPublishing">assetPublishing</a></code> | <code>string</code> | IAM role ARN for the asset publishing step. |
2418
- | <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. |
2419
- | <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. |
2420
- | <code><a href="#projen-pipelines.GithubIamRoleConfig.property.deployment">deployment</a></code> | <code>{[ key: string ]: string}</code> | IAM role ARNs for different deployment stages. |
2421
- | <code><a href="#projen-pipelines.GithubIamRoleConfig.property.synth">synth</a></code> | <code>string</code> | IAM role ARN for the synthesis step. |
2455
+ | <code><a href="#projen-pipelines.GithubPackagesLoginStepOptions.property.write">write</a></code> | <code>boolean</code> | Whether or not to grant the step write permissions to the registry. |
2422
2456
 
2423
2457
  ---
2424
2458
 
2425
- ##### `assetPublishing`<sup>Optional</sup> <a name="assetPublishing" id="projen-pipelines.GithubIamRoleConfig.property.assetPublishing"></a>
2459
+ ##### `write`<sup>Optional</sup> <a name="write" id="projen-pipelines.GithubPackagesLoginStepOptions.property.write"></a>
2426
2460
 
2427
2461
  ```typescript
2428
- public readonly assetPublishing: string;
2462
+ public readonly write: boolean;
2429
2463
  ```
2430
2464
 
2431
- - *Type:* string
2465
+ - *Type:* boolean
2466
+ - *Default:* false
2432
2467
 
2433
- IAM role ARN for the asset publishing step.
2468
+ Whether or not to grant the step write permissions to the registry.
2434
2469
 
2435
2470
  ---
2436
2471
 
2437
- ##### `assetPublishingPerStage`<sup>Optional</sup> <a name="assetPublishingPerStage" id="projen-pipelines.GithubIamRoleConfig.property.assetPublishingPerStage"></a>
2472
+ ### GithubStepConfig <a name="GithubStepConfig" id="projen-pipelines.GithubStepConfig"></a>
2473
+
2474
+ Configuration interface for a GitHub Actions step.
2475
+
2476
+ #### Initializer <a name="Initializer" id="projen-pipelines.GithubStepConfig.Initializer"></a>
2438
2477
 
2439
2478
  ```typescript
2440
- public readonly assetPublishingPerStage: {[ key: string ]: string};
2479
+ import { GithubStepConfig } from 'projen-pipelines'
2480
+
2481
+ const githubStepConfig: GithubStepConfig = { ... }
2441
2482
  ```
2442
2483
 
2443
- - *Type:* {[ key: string ]: string}
2484
+ #### Properties <a name="Properties" id="Properties"></a>
2444
2485
 
2445
- IAM role ARN for the asset publishing step for a specific stage.
2486
+ | **Name** | **Type** | **Description** |
2487
+ | --- | --- | --- |
2488
+ | <code><a href="#projen-pipelines.GithubStepConfig.property.env">env</a></code> | <code>{[ key: string ]: string}</code> | Additional environment variables to set for this step. |
2489
+ | <code><a href="#projen-pipelines.GithubStepConfig.property.needs">needs</a></code> | <code>string[]</code> | Dependencies which need to be completed before this step. |
2490
+ | <code><a href="#projen-pipelines.GithubStepConfig.property.steps">steps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Commands wrapped as GitHub Action job steps. |
2491
+ | <code><a href="#projen-pipelines.GithubStepConfig.property.permissions">permissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Additional job permissions needed. |
2446
2492
 
2447
2493
  ---
2448
2494
 
2449
- ##### `default`<sup>Optional</sup> <a name="default" id="projen-pipelines.GithubIamRoleConfig.property.default"></a>
2495
+ ##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.GithubStepConfig.property.env"></a>
2450
2496
 
2451
2497
  ```typescript
2452
- public readonly default: string;
2498
+ public readonly env: {[ key: string ]: string};
2453
2499
  ```
2454
2500
 
2455
- - *Type:* string
2501
+ - *Type:* {[ key: string ]: string}
2456
2502
 
2457
- Default IAM role ARN used if no specific role is provided.
2503
+ Additional environment variables to set for this step.
2458
2504
 
2459
2505
  ---
2460
2506
 
2461
- ##### `deployment`<sup>Optional</sup> <a name="deployment" id="projen-pipelines.GithubIamRoleConfig.property.deployment"></a>
2507
+ ##### `needs`<sup>Required</sup> <a name="needs" id="projen-pipelines.GithubStepConfig.property.needs"></a>
2462
2508
 
2463
2509
  ```typescript
2464
- public readonly deployment: {[ key: string ]: string};
2510
+ public readonly needs: string[];
2465
2511
  ```
2466
2512
 
2467
- - *Type:* {[ key: string ]: string}
2513
+ - *Type:* string[]
2468
2514
 
2469
- IAM role ARNs for different deployment stages.
2515
+ Dependencies which need to be completed before this step.
2470
2516
 
2471
2517
  ---
2472
2518
 
2473
- ##### `synth`<sup>Optional</sup> <a name="synth" id="projen-pipelines.GithubIamRoleConfig.property.synth"></a>
2519
+ ##### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.GithubStepConfig.property.steps"></a>
2474
2520
 
2475
2521
  ```typescript
2476
- public readonly synth: string;
2522
+ public readonly steps: JobStep[];
2477
2523
  ```
2478
2524
 
2479
- - *Type:* string
2525
+ - *Type:* projen.github.workflows.JobStep[]
2480
2526
 
2481
- IAM role ARN for the synthesis step.
2527
+ Commands wrapped as GitHub Action job steps.
2482
2528
 
2483
2529
  ---
2484
2530
 
2485
- ### GithubPackagesLoginStepOptions <a name="GithubPackagesLoginStepOptions" id="projen-pipelines.GithubPackagesLoginStepOptions"></a>
2486
-
2487
- #### Initializer <a name="Initializer" id="projen-pipelines.GithubPackagesLoginStepOptions.Initializer"></a>
2531
+ ##### `permissions`<sup>Optional</sup> <a name="permissions" id="projen-pipelines.GithubStepConfig.property.permissions"></a>
2488
2532
 
2489
2533
  ```typescript
2490
- import { GithubPackagesLoginStepOptions } from 'projen-pipelines'
2491
-
2492
- const githubPackagesLoginStepOptions: GithubPackagesLoginStepOptions = { ... }
2534
+ public readonly permissions: JobPermissions;
2493
2535
  ```
2494
2536
 
2495
- #### Properties <a name="Properties" id="Properties"></a>
2496
-
2497
- | **Name** | **Type** | **Description** |
2498
- | --- | --- | --- |
2499
- | <code><a href="#projen-pipelines.GithubPackagesLoginStepOptions.property.write">write</a></code> | <code>boolean</code> | Whether or not to grant the step write permissions to the registry. |
2500
-
2501
- ---
2502
-
2503
- ##### `write`<sup>Optional</sup> <a name="write" id="projen-pipelines.GithubPackagesLoginStepOptions.property.write"></a>
2504
-
2505
- ```typescript
2506
- public readonly write: boolean;
2507
- ```
2508
-
2509
- - *Type:* boolean
2510
- - *Default:* false
2511
-
2512
- Whether or not to grant the step write permissions to the registry.
2513
-
2514
- ---
2515
-
2516
- ### GithubStepConfig <a name="GithubStepConfig" id="projen-pipelines.GithubStepConfig"></a>
2517
-
2518
- Configuration interface for a GitHub Actions step.
2519
-
2520
- #### Initializer <a name="Initializer" id="projen-pipelines.GithubStepConfig.Initializer"></a>
2521
-
2522
- ```typescript
2523
- import { GithubStepConfig } from 'projen-pipelines'
2524
-
2525
- const githubStepConfig: GithubStepConfig = { ... }
2526
- ```
2527
-
2528
- #### Properties <a name="Properties" id="Properties"></a>
2529
-
2530
- | **Name** | **Type** | **Description** |
2531
- | --- | --- | --- |
2532
- | <code><a href="#projen-pipelines.GithubStepConfig.property.env">env</a></code> | <code>{[ key: string ]: string}</code> | Additional environment variables to set for this step. |
2533
- | <code><a href="#projen-pipelines.GithubStepConfig.property.needs">needs</a></code> | <code>string[]</code> | Dependencies which need to be completed before this step. |
2534
- | <code><a href="#projen-pipelines.GithubStepConfig.property.steps">steps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Commands wrapped as GitHub Action job steps. |
2535
- | <code><a href="#projen-pipelines.GithubStepConfig.property.permissions">permissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Additional job permissions needed. |
2536
-
2537
- ---
2538
-
2539
- ##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.GithubStepConfig.property.env"></a>
2540
-
2541
- ```typescript
2542
- public readonly env: {[ key: string ]: string};
2543
- ```
2544
-
2545
- - *Type:* {[ key: string ]: string}
2546
-
2547
- Additional environment variables to set for this step.
2548
-
2549
- ---
2550
-
2551
- ##### `needs`<sup>Required</sup> <a name="needs" id="projen-pipelines.GithubStepConfig.property.needs"></a>
2552
-
2553
- ```typescript
2554
- public readonly needs: string[];
2555
- ```
2556
-
2557
- - *Type:* string[]
2558
-
2559
- Dependencies which need to be completed before this step.
2560
-
2561
- ---
2562
-
2563
- ##### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.GithubStepConfig.property.steps"></a>
2564
-
2565
- ```typescript
2566
- public readonly steps: JobStep[];
2567
- ```
2568
-
2569
- - *Type:* projen.github.workflows.JobStep[]
2570
-
2571
- Commands wrapped as GitHub Action job steps.
2572
-
2573
- ---
2574
-
2575
- ##### `permissions`<sup>Optional</sup> <a name="permissions" id="projen-pipelines.GithubStepConfig.property.permissions"></a>
2576
-
2577
- ```typescript
2578
- public readonly permissions: JobPermissions;
2579
- ```
2580
-
2581
- - *Type:* projen.github.workflows.JobPermissions
2537
+ - *Type:* projen.github.workflows.JobPermissions
2582
2538
 
2583
2539
  Additional job permissions needed.
2584
2540
 
@@ -2600,6 +2556,7 @@ const gitlabCDKPipelineOptions: GitlabCDKPipelineOptions = { ... }
2600
2556
 
2601
2557
  | **Name** | **Type** | **Description** |
2602
2558
  | --- | --- | --- |
2559
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
2603
2560
  | <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. |
2604
2561
  | <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. |
2605
2562
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
@@ -2614,12 +2571,23 @@ const gitlabCDKPipelineOptions: GitlabCDKPipelineOptions = { ... }
2614
2571
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preSynthCommands">preSynthCommands</a></code> | <code>string[]</code> | *No description.* |
2615
2572
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preSynthSteps">preSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2616
2573
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.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. |
2617
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.GitlabIamRoleConfig">GitlabIamRoleConfig</a></code> | IAM role ARNs configuration for the pipeline. |
2618
2574
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.image">image</a></code> | <code>string</code> | The Docker image to use for running the pipeline jobs. |
2619
2575
  | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.runnerTags">runnerTags</a></code> | <code><a href="#projen-pipelines.GitlabRunnerTags">GitlabRunnerTags</a></code> | Runner tags configuration for the pipeline. |
2620
2576
 
2621
2577
  ---
2622
2578
 
2579
+ ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.GitlabCDKPipelineOptions.property.iamRoleArns"></a>
2580
+
2581
+ ```typescript
2582
+ public readonly iamRoleArns: IamRoleConfig;
2583
+ ```
2584
+
2585
+ - *Type:* <a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a>
2586
+
2587
+ IAM config.
2588
+
2589
+ ---
2590
+
2623
2591
  ##### `pkgNamespace`<sup>Required</sup> <a name="pkgNamespace" id="projen-pipelines.GitlabCDKPipelineOptions.property.pkgNamespace"></a>
2624
2592
 
2625
2593
  ```typescript
@@ -2784,18 +2752,6 @@ This field is used to define a prefix for the AWS Stack resources created during
2784
2752
 
2785
2753
  ---
2786
2754
 
2787
- ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.GitlabCDKPipelineOptions.property.iamRoleArns"></a>
2788
-
2789
- ```typescript
2790
- public readonly iamRoleArns: GitlabIamRoleConfig;
2791
- ```
2792
-
2793
- - *Type:* <a href="#projen-pipelines.GitlabIamRoleConfig">GitlabIamRoleConfig</a>
2794
-
2795
- IAM role ARNs configuration for the pipeline.
2796
-
2797
- ---
2798
-
2799
2755
  ##### `image`<sup>Optional</sup> <a name="image" id="projen-pipelines.GitlabCDKPipelineOptions.property.image"></a>
2800
2756
 
2801
2757
  ```typescript
@@ -2820,106 +2776,6 @@ Runner tags configuration for the pipeline.
2820
2776
 
2821
2777
  ---
2822
2778
 
2823
- ### GitlabIamRoleConfig <a name="GitlabIamRoleConfig" id="projen-pipelines.GitlabIamRoleConfig"></a>
2824
-
2825
- Configuration for IAM roles used within the GitLab CI/CD pipeline for various stages.
2826
-
2827
- Allows specifying different IAM roles for synthesis, asset publishing, and deployment stages,
2828
- providing granular control over permissions.
2829
-
2830
- #### Initializer <a name="Initializer" id="projen-pipelines.GitlabIamRoleConfig.Initializer"></a>
2831
-
2832
- ```typescript
2833
- import { GitlabIamRoleConfig } from 'projen-pipelines'
2834
-
2835
- const gitlabIamRoleConfig: GitlabIamRoleConfig = { ... }
2836
- ```
2837
-
2838
- #### Properties <a name="Properties" id="Properties"></a>
2839
-
2840
- | **Name** | **Type** | **Description** |
2841
- | --- | --- | --- |
2842
- | <code><a href="#projen-pipelines.GitlabIamRoleConfig.property.assetPublishing">assetPublishing</a></code> | <code>string</code> | IAM role ARN for the asset publishing step. |
2843
- | <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. |
2844
- | <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. |
2845
- | <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. |
2846
- | <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. |
2847
- | <code><a href="#projen-pipelines.GitlabIamRoleConfig.property.synth">synth</a></code> | <code>string</code> | IAM role ARN for the synthesis stage. |
2848
-
2849
- ---
2850
-
2851
- ##### `assetPublishing`<sup>Optional</sup> <a name="assetPublishing" id="projen-pipelines.GitlabIamRoleConfig.property.assetPublishing"></a>
2852
-
2853
- ```typescript
2854
- public readonly assetPublishing: string;
2855
- ```
2856
-
2857
- - *Type:* string
2858
-
2859
- IAM role ARN for the asset publishing step.
2860
-
2861
- ---
2862
-
2863
- ##### `assetPublishingPerStage`<sup>Optional</sup> <a name="assetPublishingPerStage" id="projen-pipelines.GitlabIamRoleConfig.property.assetPublishingPerStage"></a>
2864
-
2865
- ```typescript
2866
- public readonly assetPublishingPerStage: {[ key: string ]: string};
2867
- ```
2868
-
2869
- - *Type:* {[ key: string ]: string}
2870
-
2871
- IAM role ARN for the asset publishing step for a specific stage.
2872
-
2873
- ---
2874
-
2875
- ##### `default`<sup>Optional</sup> <a name="default" id="projen-pipelines.GitlabIamRoleConfig.property.default"></a>
2876
-
2877
- ```typescript
2878
- public readonly default: string;
2879
- ```
2880
-
2881
- - *Type:* string
2882
-
2883
- Default IAM role ARN used if specific stage role is not provided.
2884
-
2885
- ---
2886
-
2887
- ##### `deployment`<sup>Optional</sup> <a name="deployment" id="projen-pipelines.GitlabIamRoleConfig.property.deployment"></a>
2888
-
2889
- ```typescript
2890
- public readonly deployment: {[ key: string ]: string};
2891
- ```
2892
-
2893
- - *Type:* {[ key: string ]: string}
2894
-
2895
- A map of stage names to IAM role ARNs for the deployment operation.
2896
-
2897
- ---
2898
-
2899
- ##### `diff`<sup>Optional</sup> <a name="diff" id="projen-pipelines.GitlabIamRoleConfig.property.diff"></a>
2900
-
2901
- ```typescript
2902
- public readonly diff: {[ key: string ]: string};
2903
- ```
2904
-
2905
- - *Type:* {[ key: string ]: string}
2906
-
2907
- A map of stage names to IAM role ARNs for the diff operation.
2908
-
2909
- ---
2910
-
2911
- ##### `synth`<sup>Optional</sup> <a name="synth" id="projen-pipelines.GitlabIamRoleConfig.property.synth"></a>
2912
-
2913
- ```typescript
2914
- public readonly synth: string;
2915
- ```
2916
-
2917
- - *Type:* string
2918
-
2919
- IAM role ARN for the synthesis stage.
2920
-
2921
- ---
2922
-
2923
2779
  ### GitlabRunnerTags <a name="GitlabRunnerTags" id="projen-pipelines.GitlabRunnerTags"></a>
2924
2780
 
2925
2781
  Configuration for GitLab runner tags used within the CI/CD pipeline for various stages.
@@ -3077,6 +2933,103 @@ Dependencies which need to be completed before this step.
3077
2933
 
3078
2934
  ---
3079
2935
 
2936
+ ### IamRoleConfig <a name="IamRoleConfig" id="projen-pipelines.IamRoleConfig"></a>
2937
+
2938
+ Configuration interface for IAM roles used in the CDK pipeline.
2939
+
2940
+ #### Initializer <a name="Initializer" id="projen-pipelines.IamRoleConfig.Initializer"></a>
2941
+
2942
+ ```typescript
2943
+ import { IamRoleConfig } from 'projen-pipelines'
2944
+
2945
+ const iamRoleConfig: IamRoleConfig = { ... }
2946
+ ```
2947
+
2948
+ #### Properties <a name="Properties" id="Properties"></a>
2949
+
2950
+ | **Name** | **Type** | **Description** |
2951
+ | --- | --- | --- |
2952
+ | <code><a href="#projen-pipelines.IamRoleConfig.property.assetPublishing">assetPublishing</a></code> | <code>string</code> | IAM role ARN for the asset publishing step. |
2953
+ | <code><a href="#projen-pipelines.IamRoleConfig.property.assetPublishingPerStage">assetPublishingPerStage</a></code> | <code>{[ key: string ]: string}</code> | IAM role ARN for the asset publishing step for a specific stage. |
2954
+ | <code><a href="#projen-pipelines.IamRoleConfig.property.default">default</a></code> | <code>string</code> | Default IAM role ARN used if no specific role is provided. |
2955
+ | <code><a href="#projen-pipelines.IamRoleConfig.property.deployment">deployment</a></code> | <code>{[ key: string ]: string}</code> | IAM role ARNs for different deployment stages. |
2956
+ | <code><a href="#projen-pipelines.IamRoleConfig.property.diff">diff</a></code> | <code>{[ key: string ]: string}</code> | IAM role ARNs for different diff stages. |
2957
+ | <code><a href="#projen-pipelines.IamRoleConfig.property.synth">synth</a></code> | <code>string</code> | IAM role ARN for the synthesis step. |
2958
+
2959
+ ---
2960
+
2961
+ ##### `assetPublishing`<sup>Optional</sup> <a name="assetPublishing" id="projen-pipelines.IamRoleConfig.property.assetPublishing"></a>
2962
+
2963
+ ```typescript
2964
+ public readonly assetPublishing: string;
2965
+ ```
2966
+
2967
+ - *Type:* string
2968
+
2969
+ IAM role ARN for the asset publishing step.
2970
+
2971
+ ---
2972
+
2973
+ ##### `assetPublishingPerStage`<sup>Optional</sup> <a name="assetPublishingPerStage" id="projen-pipelines.IamRoleConfig.property.assetPublishingPerStage"></a>
2974
+
2975
+ ```typescript
2976
+ public readonly assetPublishingPerStage: {[ key: string ]: string};
2977
+ ```
2978
+
2979
+ - *Type:* {[ key: string ]: string}
2980
+
2981
+ IAM role ARN for the asset publishing step for a specific stage.
2982
+
2983
+ ---
2984
+
2985
+ ##### `default`<sup>Optional</sup> <a name="default" id="projen-pipelines.IamRoleConfig.property.default"></a>
2986
+
2987
+ ```typescript
2988
+ public readonly default: string;
2989
+ ```
2990
+
2991
+ - *Type:* string
2992
+
2993
+ Default IAM role ARN used if no specific role is provided.
2994
+
2995
+ ---
2996
+
2997
+ ##### `deployment`<sup>Optional</sup> <a name="deployment" id="projen-pipelines.IamRoleConfig.property.deployment"></a>
2998
+
2999
+ ```typescript
3000
+ public readonly deployment: {[ key: string ]: string};
3001
+ ```
3002
+
3003
+ - *Type:* {[ key: string ]: string}
3004
+
3005
+ IAM role ARNs for different deployment stages.
3006
+
3007
+ ---
3008
+
3009
+ ##### `diff`<sup>Optional</sup> <a name="diff" id="projen-pipelines.IamRoleConfig.property.diff"></a>
3010
+
3011
+ ```typescript
3012
+ public readonly diff: {[ key: string ]: string};
3013
+ ```
3014
+
3015
+ - *Type:* {[ key: string ]: string}
3016
+
3017
+ IAM role ARNs for different diff stages.
3018
+
3019
+ ---
3020
+
3021
+ ##### `synth`<sup>Optional</sup> <a name="synth" id="projen-pipelines.IamRoleConfig.property.synth"></a>
3022
+
3023
+ ```typescript
3024
+ public readonly synth: string;
3025
+ ```
3026
+
3027
+ - *Type:* string
3028
+
3029
+ IAM role ARN for the synthesis step.
3030
+
3031
+ ---
3032
+
3080
3033
  ### IndependentStage <a name="IndependentStage" id="projen-pipelines.IndependentStage"></a>
3081
3034
 
3082
3035
  Options for stages that are not part of the pipeline.
@@ -3095,10 +3048,11 @@ const independentStage: IndependentStage = { ... }
3095
3048
  | --- | --- | --- |
3096
3049
  | <code><a href="#projen-pipelines.IndependentStage.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
3097
3050
  | <code><a href="#projen-pipelines.IndependentStage.property.name">name</a></code> | <code>string</code> | *No description.* |
3098
- | <code><a href="#projen-pipelines.IndependentStage.property.watchable">watchable</a></code> | <code>boolean</code> | *No description.* |
3099
- | <code><a href="#projen-pipelines.IndependentStage.property.deployOnPush">deployOnPush</a></code> | <code>boolean</code> | This specifies whether the stage should be deployed on push. |
3051
+ | <code><a href="#projen-pipelines.IndependentStage.property.diffType">diffType</a></code> | <code><a href="#projen-pipelines.CdkDiffType">CdkDiffType</a></code> | *No description.* |
3100
3052
  | <code><a href="#projen-pipelines.IndependentStage.property.postDeploySteps">postDeploySteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
3101
3053
  | <code><a href="#projen-pipelines.IndependentStage.property.postDiffSteps">postDiffSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
3054
+ | <code><a href="#projen-pipelines.IndependentStage.property.watchable">watchable</a></code> | <code>boolean</code> | *No description.* |
3055
+ | <code><a href="#projen-pipelines.IndependentStage.property.deployOnPush">deployOnPush</a></code> | <code>boolean</code> | This specifies whether the stage should be deployed on push. |
3102
3056
 
3103
3057
  ---
3104
3058
 
@@ -3122,6 +3076,36 @@ public readonly name: string;
3122
3076
 
3123
3077
  ---
3124
3078
 
3079
+ ##### `diffType`<sup>Optional</sup> <a name="diffType" id="projen-pipelines.IndependentStage.property.diffType"></a>
3080
+
3081
+ ```typescript
3082
+ public readonly diffType: CdkDiffType;
3083
+ ```
3084
+
3085
+ - *Type:* <a href="#projen-pipelines.CdkDiffType">CdkDiffType</a>
3086
+
3087
+ ---
3088
+
3089
+ ##### `postDeploySteps`<sup>Optional</sup> <a name="postDeploySteps" id="projen-pipelines.IndependentStage.property.postDeploySteps"></a>
3090
+
3091
+ ```typescript
3092
+ public readonly postDeploySteps: PipelineStep[];
3093
+ ```
3094
+
3095
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
3096
+
3097
+ ---
3098
+
3099
+ ##### `postDiffSteps`<sup>Optional</sup> <a name="postDiffSteps" id="projen-pipelines.IndependentStage.property.postDiffSteps"></a>
3100
+
3101
+ ```typescript
3102
+ public readonly postDiffSteps: PipelineStep[];
3103
+ ```
3104
+
3105
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
3106
+
3107
+ ---
3108
+
3125
3109
  ##### `watchable`<sup>Optional</sup> <a name="watchable" id="projen-pipelines.IndependentStage.property.watchable"></a>
3126
3110
 
3127
3111
  ```typescript
@@ -3145,65 +3129,78 @@ This specifies whether the stage should be deployed on push.
3145
3129
 
3146
3130
  ---
3147
3131
 
3148
- ##### `postDeploySteps`<sup>Optional</sup> <a name="postDeploySteps" id="projen-pipelines.IndependentStage.property.postDeploySteps"></a>
3132
+ ### NamedStageOptions <a name="NamedStageOptions" id="projen-pipelines.NamedStageOptions"></a>
3133
+
3134
+ Options for a CDK stage with a name.
3135
+
3136
+ #### Initializer <a name="Initializer" id="projen-pipelines.NamedStageOptions.Initializer"></a>
3149
3137
 
3150
3138
  ```typescript
3151
- public readonly postDeploySteps: PipelineStep[];
3139
+ import { NamedStageOptions } from 'projen-pipelines'
3140
+
3141
+ const namedStageOptions: NamedStageOptions = { ... }
3152
3142
  ```
3153
3143
 
3154
- - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
3144
+ #### Properties <a name="Properties" id="Properties"></a>
3145
+
3146
+ | **Name** | **Type** | **Description** |
3147
+ | --- | --- | --- |
3148
+ | <code><a href="#projen-pipelines.NamedStageOptions.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
3149
+ | <code><a href="#projen-pipelines.NamedStageOptions.property.name">name</a></code> | <code>string</code> | *No description.* |
3150
+ | <code><a href="#projen-pipelines.NamedStageOptions.property.diffType">diffType</a></code> | <code><a href="#projen-pipelines.CdkDiffType">CdkDiffType</a></code> | *No description.* |
3151
+ | <code><a href="#projen-pipelines.NamedStageOptions.property.postDeploySteps">postDeploySteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
3152
+ | <code><a href="#projen-pipelines.NamedStageOptions.property.postDiffSteps">postDiffSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
3153
+ | <code><a href="#projen-pipelines.NamedStageOptions.property.watchable">watchable</a></code> | <code>boolean</code> | *No description.* |
3155
3154
 
3156
3155
  ---
3157
3156
 
3158
- ##### `postDiffSteps`<sup>Optional</sup> <a name="postDiffSteps" id="projen-pipelines.IndependentStage.property.postDiffSteps"></a>
3157
+ ##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.NamedStageOptions.property.env"></a>
3159
3158
 
3160
3159
  ```typescript
3161
- public readonly postDiffSteps: PipelineStep[];
3160
+ public readonly env: Environment;
3162
3161
  ```
3163
3162
 
3164
- - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
3163
+ - *Type:* <a href="#projen-pipelines.Environment">Environment</a>
3165
3164
 
3166
3165
  ---
3167
3166
 
3168
- ### NamedStageOptions <a name="NamedStageOptions" id="projen-pipelines.NamedStageOptions"></a>
3167
+ ##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.NamedStageOptions.property.name"></a>
3169
3168
 
3170
- Options for a CDK stage with a name.
3169
+ ```typescript
3170
+ public readonly name: string;
3171
+ ```
3172
+
3173
+ - *Type:* string
3174
+
3175
+ ---
3171
3176
 
3172
- #### Initializer <a name="Initializer" id="projen-pipelines.NamedStageOptions.Initializer"></a>
3177
+ ##### `diffType`<sup>Optional</sup> <a name="diffType" id="projen-pipelines.NamedStageOptions.property.diffType"></a>
3173
3178
 
3174
3179
  ```typescript
3175
- import { NamedStageOptions } from 'projen-pipelines'
3176
-
3177
- const namedStageOptions: NamedStageOptions = { ... }
3180
+ public readonly diffType: CdkDiffType;
3178
3181
  ```
3179
3182
 
3180
- #### Properties <a name="Properties" id="Properties"></a>
3181
-
3182
- | **Name** | **Type** | **Description** |
3183
- | --- | --- | --- |
3184
- | <code><a href="#projen-pipelines.NamedStageOptions.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
3185
- | <code><a href="#projen-pipelines.NamedStageOptions.property.name">name</a></code> | <code>string</code> | *No description.* |
3186
- | <code><a href="#projen-pipelines.NamedStageOptions.property.watchable">watchable</a></code> | <code>boolean</code> | *No description.* |
3183
+ - *Type:* <a href="#projen-pipelines.CdkDiffType">CdkDiffType</a>
3187
3184
 
3188
3185
  ---
3189
3186
 
3190
- ##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.NamedStageOptions.property.env"></a>
3187
+ ##### `postDeploySteps`<sup>Optional</sup> <a name="postDeploySteps" id="projen-pipelines.NamedStageOptions.property.postDeploySteps"></a>
3191
3188
 
3192
3189
  ```typescript
3193
- public readonly env: Environment;
3190
+ public readonly postDeploySteps: PipelineStep[];
3194
3191
  ```
3195
3192
 
3196
- - *Type:* <a href="#projen-pipelines.Environment">Environment</a>
3193
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
3197
3194
 
3198
3195
  ---
3199
3196
 
3200
- ##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.NamedStageOptions.property.name"></a>
3197
+ ##### `postDiffSteps`<sup>Optional</sup> <a name="postDiffSteps" id="projen-pipelines.NamedStageOptions.property.postDiffSteps"></a>
3201
3198
 
3202
3199
  ```typescript
3203
- public readonly name: string;
3200
+ public readonly postDiffSteps: PipelineStep[];
3204
3201
  ```
3205
3202
 
3206
- - *Type:* string
3203
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
3207
3204
 
3208
3205
  ---
3209
3206
 
@@ -3375,6 +3372,109 @@ Should be implemented by subclasses.
3375
3372
 
3376
3373
 
3377
3374
 
3375
+ ### CodeArtifactLoginStep <a name="CodeArtifactLoginStep" id="projen-pipelines.CodeArtifactLoginStep"></a>
3376
+
3377
+ #### Initializers <a name="Initializers" id="projen-pipelines.CodeArtifactLoginStep.Initializer"></a>
3378
+
3379
+ ```typescript
3380
+ import { CodeArtifactLoginStep } from 'projen-pipelines'
3381
+
3382
+ new CodeArtifactLoginStep(project: Project, options: CodeArtifactLoginStepOptions)
3383
+ ```
3384
+
3385
+ | **Name** | **Type** | **Description** |
3386
+ | --- | --- | --- |
3387
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3388
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.options">options</a></code> | <code><a href="#projen-pipelines.CodeArtifactLoginStepOptions">CodeArtifactLoginStepOptions</a></code> | *No description.* |
3389
+
3390
+ ---
3391
+
3392
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.project"></a>
3393
+
3394
+ - *Type:* projen.Project
3395
+
3396
+ The projen project reference.
3397
+
3398
+ ---
3399
+
3400
+ ##### `options`<sup>Required</sup> <a name="options" id="projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.options"></a>
3401
+
3402
+ - *Type:* <a href="#projen-pipelines.CodeArtifactLoginStepOptions">CodeArtifactLoginStepOptions</a>
3403
+
3404
+ ---
3405
+
3406
+ #### Methods <a name="Methods" id="Methods"></a>
3407
+
3408
+ | **Name** | **Description** |
3409
+ | --- | --- |
3410
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toBash">toBash</a></code> | Converts the sequence of steps into a Bash script configuration. |
3411
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the sequence of steps into a CodeCatalyst Actions step configuration. |
3412
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toGithub">toGithub</a></code> | Converts the sequence of steps into a GitHub Actions step configuration. |
3413
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toGitlab">toGitlab</a></code> | Converts the sequence of steps into a GitLab CI configuration. |
3414
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.addSteps">addSteps</a></code> | *No description.* |
3415
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.prependSteps">prependSteps</a></code> | *No description.* |
3416
+
3417
+ ---
3418
+
3419
+ ##### `toBash` <a name="toBash" id="projen-pipelines.CodeArtifactLoginStep.toBash"></a>
3420
+
3421
+ ```typescript
3422
+ public toBash(): BashStepConfig
3423
+ ```
3424
+
3425
+ Converts the sequence of steps into a Bash script configuration.
3426
+
3427
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.CodeArtifactLoginStep.toCodeCatalyst"></a>
3428
+
3429
+ ```typescript
3430
+ public toCodeCatalyst(): CodeCatalystStepConfig
3431
+ ```
3432
+
3433
+ Converts the sequence of steps into a CodeCatalyst Actions step configuration.
3434
+
3435
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.CodeArtifactLoginStep.toGithub"></a>
3436
+
3437
+ ```typescript
3438
+ public toGithub(): GithubStepConfig
3439
+ ```
3440
+
3441
+ Converts the sequence of steps into a GitHub Actions step configuration.
3442
+
3443
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.CodeArtifactLoginStep.toGitlab"></a>
3444
+
3445
+ ```typescript
3446
+ public toGitlab(): GitlabStepConfig
3447
+ ```
3448
+
3449
+ Converts the sequence of steps into a GitLab CI configuration.
3450
+
3451
+ ##### `addSteps` <a name="addSteps" id="projen-pipelines.CodeArtifactLoginStep.addSteps"></a>
3452
+
3453
+ ```typescript
3454
+ public addSteps(steps: PipelineStep): void
3455
+ ```
3456
+
3457
+ ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.CodeArtifactLoginStep.addSteps.parameter.steps"></a>
3458
+
3459
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>
3460
+
3461
+ ---
3462
+
3463
+ ##### `prependSteps` <a name="prependSteps" id="projen-pipelines.CodeArtifactLoginStep.prependSteps"></a>
3464
+
3465
+ ```typescript
3466
+ public prependSteps(steps: PipelineStep): void
3467
+ ```
3468
+
3469
+ ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.CodeArtifactLoginStep.prependSteps.parameter.steps"></a>
3470
+
3471
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>
3472
+
3473
+ ---
3474
+
3475
+
3476
+
3477
+
3378
3478
  ### DownloadArtifactStep <a name="DownloadArtifactStep" id="projen-pipelines.DownloadArtifactStep"></a>
3379
3479
 
3380
3480
  #### Initializers <a name="Initializers" id="projen-pipelines.DownloadArtifactStep.Initializer"></a>
@@ -3623,6 +3723,90 @@ Should be implemented by subclasses.
3623
3723
 
3624
3724
 
3625
3725
 
3726
+ ### ProjenScriptStep <a name="ProjenScriptStep" id="projen-pipelines.ProjenScriptStep"></a>
3727
+
3728
+ #### Initializers <a name="Initializers" id="projen-pipelines.ProjenScriptStep.Initializer"></a>
3729
+
3730
+ ```typescript
3731
+ import { ProjenScriptStep } from 'projen-pipelines'
3732
+
3733
+ new ProjenScriptStep(project: Project, scriptName: string, args?: string)
3734
+ ```
3735
+
3736
+ | **Name** | **Type** | **Description** |
3737
+ | --- | --- | --- |
3738
+ | <code><a href="#projen-pipelines.ProjenScriptStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3739
+ | <code><a href="#projen-pipelines.ProjenScriptStep.Initializer.parameter.scriptName">scriptName</a></code> | <code>string</code> | *No description.* |
3740
+ | <code><a href="#projen-pipelines.ProjenScriptStep.Initializer.parameter.args">args</a></code> | <code>string</code> | *No description.* |
3741
+
3742
+ ---
3743
+
3744
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.ProjenScriptStep.Initializer.parameter.project"></a>
3745
+
3746
+ - *Type:* projen.Project
3747
+
3748
+ The projen project reference.
3749
+
3750
+ ---
3751
+
3752
+ ##### `scriptName`<sup>Required</sup> <a name="scriptName" id="projen-pipelines.ProjenScriptStep.Initializer.parameter.scriptName"></a>
3753
+
3754
+ - *Type:* string
3755
+
3756
+ ---
3757
+
3758
+ ##### `args`<sup>Optional</sup> <a name="args" id="projen-pipelines.ProjenScriptStep.Initializer.parameter.args"></a>
3759
+
3760
+ - *Type:* string
3761
+
3762
+ ---
3763
+
3764
+ #### Methods <a name="Methods" id="Methods"></a>
3765
+
3766
+ | **Name** | **Description** |
3767
+ | --- | --- |
3768
+ | <code><a href="#projen-pipelines.ProjenScriptStep.toBash">toBash</a></code> | Converts the step into a Bash script configuration. |
3769
+ | <code><a href="#projen-pipelines.ProjenScriptStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the step into a CodeCatalyst Actions step configuration. |
3770
+ | <code><a href="#projen-pipelines.ProjenScriptStep.toGithub">toGithub</a></code> | Converts the step into a GitHub Actions step configuration. |
3771
+ | <code><a href="#projen-pipelines.ProjenScriptStep.toGitlab">toGitlab</a></code> | Converts the step into a GitLab CI configuration. |
3772
+
3773
+ ---
3774
+
3775
+ ##### `toBash` <a name="toBash" id="projen-pipelines.ProjenScriptStep.toBash"></a>
3776
+
3777
+ ```typescript
3778
+ public toBash(): BashStepConfig
3779
+ ```
3780
+
3781
+ Converts the step into a Bash script configuration.
3782
+
3783
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.ProjenScriptStep.toCodeCatalyst"></a>
3784
+
3785
+ ```typescript
3786
+ public toCodeCatalyst(): CodeCatalystStepConfig
3787
+ ```
3788
+
3789
+ Converts the step into a CodeCatalyst Actions step configuration.
3790
+
3791
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.ProjenScriptStep.toGithub"></a>
3792
+
3793
+ ```typescript
3794
+ public toGithub(): GithubStepConfig
3795
+ ```
3796
+
3797
+ Converts the step into a GitHub Actions step configuration.
3798
+
3799
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.ProjenScriptStep.toGitlab"></a>
3800
+
3801
+ ```typescript
3802
+ public toGitlab(): GitlabStepConfig
3803
+ ```
3804
+
3805
+ Converts the step into a GitLab CI configuration.
3806
+
3807
+
3808
+
3809
+
3626
3810
  ### SimpleCommandStep <a name="SimpleCommandStep" id="projen-pipelines.SimpleCommandStep"></a>
3627
3811
 
3628
3812
  Concrete implementation of PipelineStep that executes simple commands.
@@ -3704,6 +3888,111 @@ Converts the step into a GitLab CI configuration.
3704
3888
 
3705
3889
 
3706
3890
 
3891
+ ### StepSequence <a name="StepSequence" id="projen-pipelines.StepSequence"></a>
3892
+
3893
+ #### Initializers <a name="Initializers" id="projen-pipelines.StepSequence.Initializer"></a>
3894
+
3895
+ ```typescript
3896
+ import { StepSequence } from 'projen-pipelines'
3897
+
3898
+ new StepSequence(project: Project, steps: PipelineStep[])
3899
+ ```
3900
+
3901
+ | **Name** | **Type** | **Description** |
3902
+ | --- | --- | --- |
3903
+ | <code><a href="#projen-pipelines.StepSequence.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3904
+ | <code><a href="#projen-pipelines.StepSequence.Initializer.parameter.steps">steps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | - The sequence of pipeline steps. |
3905
+
3906
+ ---
3907
+
3908
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.StepSequence.Initializer.parameter.project"></a>
3909
+
3910
+ - *Type:* projen.Project
3911
+
3912
+ The projen project reference.
3913
+
3914
+ ---
3915
+
3916
+ ##### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.StepSequence.Initializer.parameter.steps"></a>
3917
+
3918
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
3919
+
3920
+ The sequence of pipeline steps.
3921
+
3922
+ ---
3923
+
3924
+ #### Methods <a name="Methods" id="Methods"></a>
3925
+
3926
+ | **Name** | **Description** |
3927
+ | --- | --- |
3928
+ | <code><a href="#projen-pipelines.StepSequence.toBash">toBash</a></code> | Converts the sequence of steps into a Bash script configuration. |
3929
+ | <code><a href="#projen-pipelines.StepSequence.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the sequence of steps into a CodeCatalyst Actions step configuration. |
3930
+ | <code><a href="#projen-pipelines.StepSequence.toGithub">toGithub</a></code> | Converts the sequence of steps into a GitHub Actions step configuration. |
3931
+ | <code><a href="#projen-pipelines.StepSequence.toGitlab">toGitlab</a></code> | Converts the sequence of steps into a GitLab CI configuration. |
3932
+ | <code><a href="#projen-pipelines.StepSequence.addSteps">addSteps</a></code> | *No description.* |
3933
+ | <code><a href="#projen-pipelines.StepSequence.prependSteps">prependSteps</a></code> | *No description.* |
3934
+
3935
+ ---
3936
+
3937
+ ##### `toBash` <a name="toBash" id="projen-pipelines.StepSequence.toBash"></a>
3938
+
3939
+ ```typescript
3940
+ public toBash(): BashStepConfig
3941
+ ```
3942
+
3943
+ Converts the sequence of steps into a Bash script configuration.
3944
+
3945
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.StepSequence.toCodeCatalyst"></a>
3946
+
3947
+ ```typescript
3948
+ public toCodeCatalyst(): CodeCatalystStepConfig
3949
+ ```
3950
+
3951
+ Converts the sequence of steps into a CodeCatalyst Actions step configuration.
3952
+
3953
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.StepSequence.toGithub"></a>
3954
+
3955
+ ```typescript
3956
+ public toGithub(): GithubStepConfig
3957
+ ```
3958
+
3959
+ Converts the sequence of steps into a GitHub Actions step configuration.
3960
+
3961
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.StepSequence.toGitlab"></a>
3962
+
3963
+ ```typescript
3964
+ public toGitlab(): GitlabStepConfig
3965
+ ```
3966
+
3967
+ Converts the sequence of steps into a GitLab CI configuration.
3968
+
3969
+ ##### `addSteps` <a name="addSteps" id="projen-pipelines.StepSequence.addSteps"></a>
3970
+
3971
+ ```typescript
3972
+ public addSteps(steps: PipelineStep): void
3973
+ ```
3974
+
3975
+ ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.StepSequence.addSteps.parameter.steps"></a>
3976
+
3977
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>
3978
+
3979
+ ---
3980
+
3981
+ ##### `prependSteps` <a name="prependSteps" id="projen-pipelines.StepSequence.prependSteps"></a>
3982
+
3983
+ ```typescript
3984
+ public prependSteps(steps: PipelineStep): void
3985
+ ```
3986
+
3987
+ ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.StepSequence.prependSteps.parameter.steps"></a>
3988
+
3989
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>
3990
+
3991
+ ---
3992
+
3993
+
3994
+
3995
+
3707
3996
  ### UploadArtifactStep <a name="UploadArtifactStep" id="projen-pipelines.UploadArtifactStep"></a>
3708
3997
 
3709
3998
  #### Initializers <a name="Initializers" id="projen-pipelines.UploadArtifactStep.Initializer"></a>
@@ -3790,6 +4079,39 @@ Should be implemented by subclasses.
3790
4079
 
3791
4080
  ## Enums <a name="Enums" id="Enums"></a>
3792
4081
 
4082
+ ### CdkDiffType <a name="CdkDiffType" id="projen-pipelines.CdkDiffType"></a>
4083
+
4084
+ #### Members <a name="Members" id="Members"></a>
4085
+
4086
+ | **Name** | **Description** |
4087
+ | --- | --- |
4088
+ | <code><a href="#projen-pipelines.CdkDiffType.NONE">NONE</a></code> | Do not perform a diff. |
4089
+ | <code><a href="#projen-pipelines.CdkDiffType.FAST">FAST</a></code> | Perform a fast template diff (--no-changeset). |
4090
+ | <code><a href="#projen-pipelines.CdkDiffType.FULL">FULL</a></code> | Perform a full CloudFormation diff (--changeset). |
4091
+
4092
+ ---
4093
+
4094
+ ##### `NONE` <a name="NONE" id="projen-pipelines.CdkDiffType.NONE"></a>
4095
+
4096
+ Do not perform a diff.
4097
+
4098
+ ---
4099
+
4100
+
4101
+ ##### `FAST` <a name="FAST" id="projen-pipelines.CdkDiffType.FAST"></a>
4102
+
4103
+ Perform a fast template diff (--no-changeset).
4104
+
4105
+ ---
4106
+
4107
+
4108
+ ##### `FULL` <a name="FULL" id="projen-pipelines.CdkDiffType.FULL"></a>
4109
+
4110
+ Perform a full CloudFormation diff (--changeset).
4111
+
4112
+ ---
4113
+
4114
+
3793
4115
  ### PipelineEngine <a name="PipelineEngine" id="projen-pipelines.PipelineEngine"></a>
3794
4116
 
3795
4117
  The CI/CD tooling used to run your pipeline.