projen-pipelines 0.2.12 → 0.2.13

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
@@ -203,6 +203,9 @@ new BashCDKPipeline(app: AwsCdkTypeScriptApp, options: BashCDKPipelineOptions)
203
203
  | <code><a href="#projen-pipelines.BashCDKPipeline.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
204
204
  | <code><a href="#projen-pipelines.BashCDKPipeline.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
205
205
  | <code><a href="#projen-pipelines.BashCDKPipeline.engineType">engineType</a></code> | *No description.* |
206
+ | <code><a href="#projen-pipelines.BashCDKPipeline.generateVersioningAppCode">generateVersioningAppCode</a></code> | Generate CDK application code for versioning. |
207
+ | <code><a href="#projen-pipelines.BashCDKPipeline.generateVersioningImports">generateVersioningImports</a></code> | Generate versioning imports for CDK application. |
208
+ | <code><a href="#projen-pipelines.BashCDKPipeline.generateVersioningUtilities">generateVersioningUtilities</a></code> | Generate versioning utility functions for CDK application. |
206
209
 
207
210
  ---
208
211
 
@@ -246,6 +249,36 @@ Synthesizes files to the project output directory.
246
249
  public engineType(): PipelineEngine
247
250
  ```
248
251
 
252
+ ##### `generateVersioningAppCode` <a name="generateVersioningAppCode" id="projen-pipelines.BashCDKPipeline.generateVersioningAppCode"></a>
253
+
254
+ ```typescript
255
+ public generateVersioningAppCode(config: VersioningConfig): string
256
+ ```
257
+
258
+ Generate CDK application code for versioning.
259
+
260
+ ###### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.BashCDKPipeline.generateVersioningAppCode.parameter.config"></a>
261
+
262
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
263
+
264
+ ---
265
+
266
+ ##### `generateVersioningImports` <a name="generateVersioningImports" id="projen-pipelines.BashCDKPipeline.generateVersioningImports"></a>
267
+
268
+ ```typescript
269
+ public generateVersioningImports(): string
270
+ ```
271
+
272
+ Generate versioning imports for CDK application.
273
+
274
+ ##### `generateVersioningUtilities` <a name="generateVersioningUtilities" id="projen-pipelines.BashCDKPipeline.generateVersioningUtilities"></a>
275
+
276
+ ```typescript
277
+ public generateVersioningUtilities(): string
278
+ ```
279
+
280
+ Generate versioning utility functions for CDK application.
281
+
249
282
  #### Static Functions <a name="Static Functions" id="Static Functions"></a>
250
283
 
251
284
  | **Name** | **Description** |
@@ -399,6 +432,9 @@ new CDKPipeline(app: AwsCdkTypeScriptApp, baseOptions: CDKPipelineOptions)
399
432
  | <code><a href="#projen-pipelines.CDKPipeline.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
400
433
  | <code><a href="#projen-pipelines.CDKPipeline.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
401
434
  | <code><a href="#projen-pipelines.CDKPipeline.engineType">engineType</a></code> | *No description.* |
435
+ | <code><a href="#projen-pipelines.CDKPipeline.generateVersioningAppCode">generateVersioningAppCode</a></code> | Generate CDK application code for versioning. |
436
+ | <code><a href="#projen-pipelines.CDKPipeline.generateVersioningImports">generateVersioningImports</a></code> | Generate versioning imports for CDK application. |
437
+ | <code><a href="#projen-pipelines.CDKPipeline.generateVersioningUtilities">generateVersioningUtilities</a></code> | Generate versioning utility functions for CDK application. |
402
438
 
403
439
  ---
404
440
 
@@ -442,6 +478,36 @@ Synthesizes files to the project output directory.
442
478
  public engineType(): PipelineEngine
443
479
  ```
444
480
 
481
+ ##### `generateVersioningAppCode` <a name="generateVersioningAppCode" id="projen-pipelines.CDKPipeline.generateVersioningAppCode"></a>
482
+
483
+ ```typescript
484
+ public generateVersioningAppCode(config: VersioningConfig): string
485
+ ```
486
+
487
+ Generate CDK application code for versioning.
488
+
489
+ ###### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.CDKPipeline.generateVersioningAppCode.parameter.config"></a>
490
+
491
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
492
+
493
+ ---
494
+
495
+ ##### `generateVersioningImports` <a name="generateVersioningImports" id="projen-pipelines.CDKPipeline.generateVersioningImports"></a>
496
+
497
+ ```typescript
498
+ public generateVersioningImports(): string
499
+ ```
500
+
501
+ Generate versioning imports for CDK application.
502
+
503
+ ##### `generateVersioningUtilities` <a name="generateVersioningUtilities" id="projen-pipelines.CDKPipeline.generateVersioningUtilities"></a>
504
+
505
+ ```typescript
506
+ public generateVersioningUtilities(): string
507
+ ```
508
+
509
+ Generate versioning utility functions for CDK application.
510
+
445
511
  #### Static Functions <a name="Static Functions" id="Static Functions"></a>
446
512
 
447
513
  | **Name** | **Description** |
@@ -769,6 +835,9 @@ Configuration options for the pipeline.
769
835
  | <code><a href="#projen-pipelines.GithubCDKPipeline.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
770
836
  | <code><a href="#projen-pipelines.GithubCDKPipeline.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
771
837
  | <code><a href="#projen-pipelines.GithubCDKPipeline.engineType">engineType</a></code> | the type of engine this implementation of CDKPipeline is for. |
838
+ | <code><a href="#projen-pipelines.GithubCDKPipeline.generateVersioningAppCode">generateVersioningAppCode</a></code> | Generate CDK application code for versioning. |
839
+ | <code><a href="#projen-pipelines.GithubCDKPipeline.generateVersioningImports">generateVersioningImports</a></code> | Generate versioning imports for CDK application. |
840
+ | <code><a href="#projen-pipelines.GithubCDKPipeline.generateVersioningUtilities">generateVersioningUtilities</a></code> | Generate versioning utility functions for CDK application. |
772
841
  | <code><a href="#projen-pipelines.GithubCDKPipeline.createAssetUpload">createAssetUpload</a></code> | Creates a job to upload assets to AWS as part of the pipeline. |
773
842
  | <code><a href="#projen-pipelines.GithubCDKPipeline.createDeployment">createDeployment</a></code> | Creates a job to deploy the CDK application to AWS. |
774
843
  | <code><a href="#projen-pipelines.GithubCDKPipeline.createIndependentDeployment">createIndependentDeployment</a></code> | Creates a job to deploy the CDK application to AWS. |
@@ -817,6 +886,36 @@ public engineType(): PipelineEngine
817
886
 
818
887
  the type of engine this implementation of CDKPipeline is for.
819
888
 
889
+ ##### `generateVersioningAppCode` <a name="generateVersioningAppCode" id="projen-pipelines.GithubCDKPipeline.generateVersioningAppCode"></a>
890
+
891
+ ```typescript
892
+ public generateVersioningAppCode(config: VersioningConfig): string
893
+ ```
894
+
895
+ Generate CDK application code for versioning.
896
+
897
+ ###### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.GithubCDKPipeline.generateVersioningAppCode.parameter.config"></a>
898
+
899
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
900
+
901
+ ---
902
+
903
+ ##### `generateVersioningImports` <a name="generateVersioningImports" id="projen-pipelines.GithubCDKPipeline.generateVersioningImports"></a>
904
+
905
+ ```typescript
906
+ public generateVersioningImports(): string
907
+ ```
908
+
909
+ Generate versioning imports for CDK application.
910
+
911
+ ##### `generateVersioningUtilities` <a name="generateVersioningUtilities" id="projen-pipelines.GithubCDKPipeline.generateVersioningUtilities"></a>
912
+
913
+ ```typescript
914
+ public generateVersioningUtilities(): string
915
+ ```
916
+
917
+ Generate versioning utility functions for CDK application.
918
+
820
919
  ##### `createAssetUpload` <a name="createAssetUpload" id="projen-pipelines.GithubCDKPipeline.createAssetUpload"></a>
821
920
 
822
921
  ```typescript
@@ -1028,6 +1127,9 @@ Configuration options for the pipeline.
1028
1127
  | <code><a href="#projen-pipelines.GitlabCDKPipeline.preSynthesize">preSynthesize</a></code> | Called before synthesis. |
1029
1128
  | <code><a href="#projen-pipelines.GitlabCDKPipeline.synthesize">synthesize</a></code> | Synthesizes files to the project output directory. |
1030
1129
  | <code><a href="#projen-pipelines.GitlabCDKPipeline.engineType">engineType</a></code> | *No description.* |
1130
+ | <code><a href="#projen-pipelines.GitlabCDKPipeline.generateVersioningAppCode">generateVersioningAppCode</a></code> | Generate CDK application code for versioning. |
1131
+ | <code><a href="#projen-pipelines.GitlabCDKPipeline.generateVersioningImports">generateVersioningImports</a></code> | Generate versioning imports for CDK application. |
1132
+ | <code><a href="#projen-pipelines.GitlabCDKPipeline.generateVersioningUtilities">generateVersioningUtilities</a></code> | Generate versioning utility functions for CDK application. |
1031
1133
  | <code><a href="#projen-pipelines.GitlabCDKPipeline.createIndependentDeployment">createIndependentDeployment</a></code> | Creates a job to deploy the CDK application to AWS. |
1032
1134
 
1033
1135
  ---
@@ -1072,6 +1174,36 @@ Synthesizes files to the project output directory.
1072
1174
  public engineType(): PipelineEngine
1073
1175
  ```
1074
1176
 
1177
+ ##### `generateVersioningAppCode` <a name="generateVersioningAppCode" id="projen-pipelines.GitlabCDKPipeline.generateVersioningAppCode"></a>
1178
+
1179
+ ```typescript
1180
+ public generateVersioningAppCode(config: VersioningConfig): string
1181
+ ```
1182
+
1183
+ Generate CDK application code for versioning.
1184
+
1185
+ ###### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.GitlabCDKPipeline.generateVersioningAppCode.parameter.config"></a>
1186
+
1187
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
1188
+
1189
+ ---
1190
+
1191
+ ##### `generateVersioningImports` <a name="generateVersioningImports" id="projen-pipelines.GitlabCDKPipeline.generateVersioningImports"></a>
1192
+
1193
+ ```typescript
1194
+ public generateVersioningImports(): string
1195
+ ```
1196
+
1197
+ Generate versioning imports for CDK application.
1198
+
1199
+ ##### `generateVersioningUtilities` <a name="generateVersioningUtilities" id="projen-pipelines.GitlabCDKPipeline.generateVersioningUtilities"></a>
1200
+
1201
+ ```typescript
1202
+ public generateVersioningUtilities(): string
1203
+ ```
1204
+
1205
+ Generate versioning utility functions for CDK application.
1206
+
1075
1207
  ##### `createIndependentDeployment` <a name="createIndependentDeployment" id="projen-pipelines.GitlabCDKPipeline.createIndependentDeployment"></a>
1076
1208
 
1077
1209
  ```typescript
@@ -1413,6 +1545,7 @@ const bashCDKPipelineOptions: BashCDKPipelineOptions = { ... }
1413
1545
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.preSynthCommands">preSynthCommands</a></code> | <code>string[]</code> | *No description.* |
1414
1546
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.preSynthSteps">preSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
1415
1547
  | <code><a href="#projen-pipelines.BashCDKPipelineOptions.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. |
1548
+ | <code><a href="#projen-pipelines.BashCDKPipelineOptions.property.versioning">versioning</a></code> | <code><a href="#projen-pipelines.VersioningConfig">VersioningConfig</a></code> | Versioning configuration. |
1416
1549
 
1417
1550
  ---
1418
1551
 
@@ -1595,6 +1728,18 @@ This field is used to define a prefix for the AWS Stack resources created during
1595
1728
 
1596
1729
  ---
1597
1730
 
1731
+ ##### `versioning`<sup>Optional</sup> <a name="versioning" id="projen-pipelines.BashCDKPipelineOptions.property.versioning"></a>
1732
+
1733
+ ```typescript
1734
+ public readonly versioning: VersioningConfig;
1735
+ ```
1736
+
1737
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
1738
+
1739
+ Versioning configuration.
1740
+
1741
+ ---
1742
+
1598
1743
  ### BashStepConfig <a name="BashStepConfig" id="projen-pipelines.BashStepConfig"></a>
1599
1744
 
1600
1745
  Configuration interface for a bash script step.
@@ -1627,6 +1772,45 @@ Shell commands to execute.
1627
1772
 
1628
1773
  ---
1629
1774
 
1775
+ ### BuildNumberConfig <a name="BuildNumberConfig" id="projen-pipelines.BuildNumberConfig"></a>
1776
+
1777
+ #### Initializer <a name="Initializer" id="projen-pipelines.BuildNumberConfig.Initializer"></a>
1778
+
1779
+ ```typescript
1780
+ import { BuildNumberConfig } from 'projen-pipelines'
1781
+
1782
+ const buildNumberConfig: BuildNumberConfig = { ... }
1783
+ ```
1784
+
1785
+ #### Properties <a name="Properties" id="Properties"></a>
1786
+
1787
+ | **Name** | **Type** | **Description** |
1788
+ | --- | --- | --- |
1789
+ | <code><a href="#projen-pipelines.BuildNumberConfig.property.commitCount">commitCount</a></code> | <code><a href="#projen-pipelines.CommitCountConfig">CommitCountConfig</a></code> | *No description.* |
1790
+ | <code><a href="#projen-pipelines.BuildNumberConfig.property.prefix">prefix</a></code> | <code>string</code> | *No description.* |
1791
+
1792
+ ---
1793
+
1794
+ ##### `commitCount`<sup>Optional</sup> <a name="commitCount" id="projen-pipelines.BuildNumberConfig.property.commitCount"></a>
1795
+
1796
+ ```typescript
1797
+ public readonly commitCount: CommitCountConfig;
1798
+ ```
1799
+
1800
+ - *Type:* <a href="#projen-pipelines.CommitCountConfig">CommitCountConfig</a>
1801
+
1802
+ ---
1803
+
1804
+ ##### `prefix`<sup>Optional</sup> <a name="prefix" id="projen-pipelines.BuildNumberConfig.property.prefix"></a>
1805
+
1806
+ ```typescript
1807
+ public readonly prefix: string;
1808
+ ```
1809
+
1810
+ - *Type:* string
1811
+
1812
+ ---
1813
+
1630
1814
  ### CDKPipelineOptions <a name="CDKPipelineOptions" id="projen-pipelines.CDKPipelineOptions"></a>
1631
1815
 
1632
1816
  The CDKPipelineOptions interface is designed to provide configuration options for a CDK (Cloud Development Kit) pipeline.
@@ -1662,6 +1846,7 @@ const cDKPipelineOptions: CDKPipelineOptions = { ... }
1662
1846
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.preSynthCommands">preSynthCommands</a></code> | <code>string[]</code> | *No description.* |
1663
1847
  | <code><a href="#projen-pipelines.CDKPipelineOptions.property.preSynthSteps">preSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
1664
1848
  | <code><a href="#projen-pipelines.CDKPipelineOptions.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. |
1849
+ | <code><a href="#projen-pipelines.CDKPipelineOptions.property.versioning">versioning</a></code> | <code><a href="#projen-pipelines.VersioningConfig">VersioningConfig</a></code> | Versioning configuration. |
1665
1850
 
1666
1851
  ---
1667
1852
 
@@ -1844,6 +2029,107 @@ This field is used to define a prefix for the AWS Stack resources created during
1844
2029
 
1845
2030
  ---
1846
2031
 
2032
+ ##### `versioning`<sup>Optional</sup> <a name="versioning" id="projen-pipelines.CDKPipelineOptions.property.versioning"></a>
2033
+
2034
+ ```typescript
2035
+ public readonly versioning: VersioningConfig;
2036
+ ```
2037
+
2038
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
2039
+
2040
+ Versioning configuration.
2041
+
2042
+ ---
2043
+
2044
+ ### CloudFormationOnlyOptions <a name="CloudFormationOnlyOptions" id="projen-pipelines.CloudFormationOnlyOptions"></a>
2045
+
2046
+ #### Initializer <a name="Initializer" id="projen-pipelines.CloudFormationOnlyOptions.Initializer"></a>
2047
+
2048
+ ```typescript
2049
+ import { CloudFormationOnlyOptions } from 'projen-pipelines'
2050
+
2051
+ const cloudFormationOnlyOptions: CloudFormationOnlyOptions = { ... }
2052
+ ```
2053
+
2054
+ #### Properties <a name="Properties" id="Properties"></a>
2055
+
2056
+ | **Name** | **Type** | **Description** |
2057
+ | --- | --- | --- |
2058
+ | <code><a href="#projen-pipelines.CloudFormationOnlyOptions.property.exportName">exportName</a></code> | <code>string</code> | *No description.* |
2059
+ | <code><a href="#projen-pipelines.CloudFormationOnlyOptions.property.format">format</a></code> | <code>string</code> | *No description.* |
2060
+ | <code><a href="#projen-pipelines.CloudFormationOnlyOptions.property.stackOutputName">stackOutputName</a></code> | <code>string</code> | *No description.* |
2061
+
2062
+ ---
2063
+
2064
+ ##### `exportName`<sup>Optional</sup> <a name="exportName" id="projen-pipelines.CloudFormationOnlyOptions.property.exportName"></a>
2065
+
2066
+ ```typescript
2067
+ public readonly exportName: string;
2068
+ ```
2069
+
2070
+ - *Type:* string
2071
+
2072
+ ---
2073
+
2074
+ ##### `format`<sup>Optional</sup> <a name="format" id="projen-pipelines.CloudFormationOnlyOptions.property.format"></a>
2075
+
2076
+ ```typescript
2077
+ public readonly format: string;
2078
+ ```
2079
+
2080
+ - *Type:* string
2081
+
2082
+ ---
2083
+
2084
+ ##### `stackOutputName`<sup>Optional</sup> <a name="stackOutputName" id="projen-pipelines.CloudFormationOnlyOptions.property.stackOutputName"></a>
2085
+
2086
+ ```typescript
2087
+ public readonly stackOutputName: string;
2088
+ ```
2089
+
2090
+ - *Type:* string
2091
+
2092
+ ---
2093
+
2094
+ ### CloudFormationOutputConfig <a name="CloudFormationOutputConfig" id="projen-pipelines.CloudFormationOutputConfig"></a>
2095
+
2096
+ #### Initializer <a name="Initializer" id="projen-pipelines.CloudFormationOutputConfig.Initializer"></a>
2097
+
2098
+ ```typescript
2099
+ import { CloudFormationOutputConfig } from 'projen-pipelines'
2100
+
2101
+ const cloudFormationOutputConfig: CloudFormationOutputConfig = { ... }
2102
+ ```
2103
+
2104
+ #### Properties <a name="Properties" id="Properties"></a>
2105
+
2106
+ | **Name** | **Type** | **Description** |
2107
+ | --- | --- | --- |
2108
+ | <code><a href="#projen-pipelines.CloudFormationOutputConfig.property.enabled">enabled</a></code> | <code>boolean</code> | *No description.* |
2109
+ | <code><a href="#projen-pipelines.CloudFormationOutputConfig.property.exportName">exportName</a></code> | <code>string</code> | *No description.* |
2110
+
2111
+ ---
2112
+
2113
+ ##### `enabled`<sup>Required</sup> <a name="enabled" id="projen-pipelines.CloudFormationOutputConfig.property.enabled"></a>
2114
+
2115
+ ```typescript
2116
+ public readonly enabled: boolean;
2117
+ ```
2118
+
2119
+ - *Type:* boolean
2120
+
2121
+ ---
2122
+
2123
+ ##### `exportName`<sup>Optional</sup> <a name="exportName" id="projen-pipelines.CloudFormationOutputConfig.property.exportName"></a>
2124
+
2125
+ ```typescript
2126
+ public readonly exportName: string;
2127
+ ```
2128
+
2129
+ - *Type:* string
2130
+
2131
+ ---
2132
+
1847
2133
  ### CodeArtifactLoginStepOptions <a name="CodeArtifactLoginStepOptions" id="projen-pipelines.CodeArtifactLoginStepOptions"></a>
1848
2134
 
1849
2135
  #### Initializer <a name="Initializer" id="projen-pipelines.CodeArtifactLoginStepOptions.Initializer"></a>
@@ -1963,144 +2249,409 @@ Dependencies which need to be completed before this step.
1963
2249
 
1964
2250
  ---
1965
2251
 
1966
- ### DeploymentStage <a name="DeploymentStage" id="projen-pipelines.DeploymentStage"></a>
1967
-
1968
- Options for stages that are part of the pipeline.
2252
+ ### CommitCountConfig <a name="CommitCountConfig" id="projen-pipelines.CommitCountConfig"></a>
1969
2253
 
1970
- #### Initializer <a name="Initializer" id="projen-pipelines.DeploymentStage.Initializer"></a>
2254
+ #### Initializer <a name="Initializer" id="projen-pipelines.CommitCountConfig.Initializer"></a>
1971
2255
 
1972
2256
  ```typescript
1973
- import { DeploymentStage } from 'projen-pipelines'
2257
+ import { CommitCountConfig } from 'projen-pipelines'
1974
2258
 
1975
- const deploymentStage: DeploymentStage = { ... }
2259
+ const commitCountConfig: CommitCountConfig = { ... }
1976
2260
  ```
1977
2261
 
1978
2262
  #### Properties <a name="Properties" id="Properties"></a>
1979
2263
 
1980
2264
  | **Name** | **Type** | **Description** |
1981
2265
  | --- | --- | --- |
1982
- | <code><a href="#projen-pipelines.DeploymentStage.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
1983
- | <code><a href="#projen-pipelines.DeploymentStage.property.name">name</a></code> | <code>string</code> | *No description.* |
1984
- | <code><a href="#projen-pipelines.DeploymentStage.property.diffType">diffType</a></code> | <code><a href="#projen-pipelines.CdkDiffType">CdkDiffType</a></code> | *No description.* |
1985
- | <code><a href="#projen-pipelines.DeploymentStage.property.postDeploySteps">postDeploySteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
1986
- | <code><a href="#projen-pipelines.DeploymentStage.property.postDiffSteps">postDiffSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
1987
- | <code><a href="#projen-pipelines.DeploymentStage.property.watchable">watchable</a></code> | <code>boolean</code> | *No description.* |
1988
- | <code><a href="#projen-pipelines.DeploymentStage.property.manualApproval">manualApproval</a></code> | <code>boolean</code> | *No description.* |
2266
+ | <code><a href="#projen-pipelines.CommitCountConfig.property.countFrom">countFrom</a></code> | <code>string</code> | Count from: 'all' \| 'branch' \| 'since-tag'. |
2267
+ | <code><a href="#projen-pipelines.CommitCountConfig.property.includeBranch">includeBranch</a></code> | <code>boolean</code> | Include branch name. |
2268
+ | <code><a href="#projen-pipelines.CommitCountConfig.property.padding">padding</a></code> | <code>number</code> | Padding for count. |
2269
+ | <code><a href="#projen-pipelines.CommitCountConfig.property.resetOnMajor">resetOnMajor</a></code> | <code>boolean</code> | Reset on major version. |
1989
2270
 
1990
2271
  ---
1991
2272
 
1992
- ##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.DeploymentStage.property.env"></a>
2273
+ ##### `countFrom`<sup>Optional</sup> <a name="countFrom" id="projen-pipelines.CommitCountConfig.property.countFrom"></a>
1993
2274
 
1994
2275
  ```typescript
1995
- public readonly env: Environment;
2276
+ public readonly countFrom: string;
1996
2277
  ```
1997
2278
 
1998
- - *Type:* <a href="#projen-pipelines.Environment">Environment</a>
2279
+ - *Type:* string
2280
+
2281
+ Count from: 'all' | 'branch' | 'since-tag'.
1999
2282
 
2000
2283
  ---
2001
2284
 
2002
- ##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.DeploymentStage.property.name"></a>
2285
+ ##### `includeBranch`<sup>Optional</sup> <a name="includeBranch" id="projen-pipelines.CommitCountConfig.property.includeBranch"></a>
2003
2286
 
2004
2287
  ```typescript
2005
- public readonly name: string;
2288
+ public readonly includeBranch: boolean;
2006
2289
  ```
2007
2290
 
2008
- - *Type:* string
2291
+ - *Type:* boolean
2292
+
2293
+ Include branch name.
2009
2294
 
2010
2295
  ---
2011
2296
 
2012
- ##### `diffType`<sup>Optional</sup> <a name="diffType" id="projen-pipelines.DeploymentStage.property.diffType"></a>
2297
+ ##### `padding`<sup>Optional</sup> <a name="padding" id="projen-pipelines.CommitCountConfig.property.padding"></a>
2013
2298
 
2014
2299
  ```typescript
2015
- public readonly diffType: CdkDiffType;
2300
+ public readonly padding: number;
2016
2301
  ```
2017
2302
 
2018
- - *Type:* <a href="#projen-pipelines.CdkDiffType">CdkDiffType</a>
2303
+ - *Type:* number
2304
+
2305
+ Padding for count.
2019
2306
 
2020
2307
  ---
2021
2308
 
2022
- ##### `postDeploySteps`<sup>Optional</sup> <a name="postDeploySteps" id="projen-pipelines.DeploymentStage.property.postDeploySteps"></a>
2309
+ ##### `resetOnMajor`<sup>Optional</sup> <a name="resetOnMajor" id="projen-pipelines.CommitCountConfig.property.resetOnMajor"></a>
2023
2310
 
2024
2311
  ```typescript
2025
- public readonly postDeploySteps: PipelineStep[];
2312
+ public readonly resetOnMajor: boolean;
2026
2313
  ```
2027
2314
 
2028
- - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
2315
+ - *Type:* boolean
2316
+
2317
+ Reset on major version.
2029
2318
 
2030
2319
  ---
2031
2320
 
2032
- ##### `postDiffSteps`<sup>Optional</sup> <a name="postDiffSteps" id="projen-pipelines.DeploymentStage.property.postDiffSteps"></a>
2321
+ ### ComputationContext <a name="ComputationContext" id="projen-pipelines.ComputationContext"></a>
2322
+
2323
+ Context for version computation.
2324
+
2325
+ #### Initializer <a name="Initializer" id="projen-pipelines.ComputationContext.Initializer"></a>
2033
2326
 
2034
2327
  ```typescript
2035
- public readonly postDiffSteps: PipelineStep[];
2328
+ import { ComputationContext } from 'projen-pipelines'
2329
+
2330
+ const computationContext: ComputationContext = { ... }
2036
2331
  ```
2037
2332
 
2038
- - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
2333
+ #### Properties <a name="Properties" id="Properties"></a>
2334
+
2335
+ | **Name** | **Type** | **Description** |
2336
+ | --- | --- | --- |
2337
+ | <code><a href="#projen-pipelines.ComputationContext.property.deployedBy">deployedBy</a></code> | <code>string</code> | *No description.* |
2338
+ | <code><a href="#projen-pipelines.ComputationContext.property.environment">environment</a></code> | <code>string</code> | *No description.* |
2339
+ | <code><a href="#projen-pipelines.ComputationContext.property.gitInfo">gitInfo</a></code> | <code><a href="#projen-pipelines.GitInfo">GitInfo</a></code> | *No description.* |
2340
+ | <code><a href="#projen-pipelines.ComputationContext.property.buildNumber">buildNumber</a></code> | <code>string</code> | *No description.* |
2341
+ | <code><a href="#projen-pipelines.ComputationContext.property.pipelineVersion">pipelineVersion</a></code> | <code>string</code> | *No description.* |
2342
+ | <code><a href="#projen-pipelines.ComputationContext.property.repository">repository</a></code> | <code>string</code> | *No description.* |
2039
2343
 
2040
2344
  ---
2041
2345
 
2042
- ##### `watchable`<sup>Optional</sup> <a name="watchable" id="projen-pipelines.DeploymentStage.property.watchable"></a>
2346
+ ##### `deployedBy`<sup>Required</sup> <a name="deployedBy" id="projen-pipelines.ComputationContext.property.deployedBy"></a>
2043
2347
 
2044
2348
  ```typescript
2045
- public readonly watchable: boolean;
2349
+ public readonly deployedBy: string;
2046
2350
  ```
2047
2351
 
2048
- - *Type:* boolean
2352
+ - *Type:* string
2049
2353
 
2050
2354
  ---
2051
2355
 
2052
- ##### `manualApproval`<sup>Optional</sup> <a name="manualApproval" id="projen-pipelines.DeploymentStage.property.manualApproval"></a>
2356
+ ##### `environment`<sup>Required</sup> <a name="environment" id="projen-pipelines.ComputationContext.property.environment"></a>
2053
2357
 
2054
2358
  ```typescript
2055
- public readonly manualApproval: boolean;
2359
+ public readonly environment: string;
2056
2360
  ```
2057
2361
 
2058
- - *Type:* boolean
2362
+ - *Type:* string
2059
2363
 
2060
2364
  ---
2061
2365
 
2062
- ### DownloadArtifactStepConfig <a name="DownloadArtifactStepConfig" id="projen-pipelines.DownloadArtifactStepConfig"></a>
2063
-
2064
- #### Initializer <a name="Initializer" id="projen-pipelines.DownloadArtifactStepConfig.Initializer"></a>
2366
+ ##### `gitInfo`<sup>Required</sup> <a name="gitInfo" id="projen-pipelines.ComputationContext.property.gitInfo"></a>
2065
2367
 
2066
2368
  ```typescript
2067
- import { DownloadArtifactStepConfig } from 'projen-pipelines'
2068
-
2069
- const downloadArtifactStepConfig: DownloadArtifactStepConfig = { ... }
2369
+ public readonly gitInfo: GitInfo;
2070
2370
  ```
2071
2371
 
2072
- #### Properties <a name="Properties" id="Properties"></a>
2073
-
2074
- | **Name** | **Type** | **Description** |
2075
- | --- | --- | --- |
2076
- | <code><a href="#projen-pipelines.DownloadArtifactStepConfig.property.name">name</a></code> | <code>string</code> | *No description.* |
2077
- | <code><a href="#projen-pipelines.DownloadArtifactStepConfig.property.path">path</a></code> | <code>string</code> | *No description.* |
2372
+ - *Type:* <a href="#projen-pipelines.GitInfo">GitInfo</a>
2078
2373
 
2079
2374
  ---
2080
2375
 
2081
- ##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.DownloadArtifactStepConfig.property.name"></a>
2376
+ ##### `buildNumber`<sup>Optional</sup> <a name="buildNumber" id="projen-pipelines.ComputationContext.property.buildNumber"></a>
2082
2377
 
2083
2378
  ```typescript
2084
- public readonly name: string;
2379
+ public readonly buildNumber: string;
2085
2380
  ```
2086
2381
 
2087
2382
  - *Type:* string
2088
2383
 
2089
2384
  ---
2090
2385
 
2091
- ##### `path`<sup>Required</sup> <a name="path" id="projen-pipelines.DownloadArtifactStepConfig.property.path"></a>
2386
+ ##### `pipelineVersion`<sup>Optional</sup> <a name="pipelineVersion" id="projen-pipelines.ComputationContext.property.pipelineVersion"></a>
2092
2387
 
2093
2388
  ```typescript
2094
- public readonly path: string;
2389
+ public readonly pipelineVersion: string;
2095
2390
  ```
2096
2391
 
2097
2392
  - *Type:* string
2098
2393
 
2099
2394
  ---
2100
2395
 
2101
- ### Environment <a name="Environment" id="projen-pipelines.Environment"></a>
2396
+ ##### `repository`<sup>Optional</sup> <a name="repository" id="projen-pipelines.ComputationContext.property.repository"></a>
2102
2397
 
2103
- The Environment interface is designed to hold AWS related information for a specific deployment environment within your infrastructure.
2398
+ ```typescript
2399
+ public readonly repository: string;
2400
+ ```
2401
+
2402
+ - *Type:* string
2403
+
2404
+ ---
2405
+
2406
+ ### CustomVersioningConfig <a name="CustomVersioningConfig" id="projen-pipelines.CustomVersioningConfig"></a>
2407
+
2408
+ #### Initializer <a name="Initializer" id="projen-pipelines.CustomVersioningConfig.Initializer"></a>
2409
+
2410
+ ```typescript
2411
+ import { CustomVersioningConfig } from 'projen-pipelines'
2412
+
2413
+ const customVersioningConfig: CustomVersioningConfig = { ... }
2414
+ ```
2415
+
2416
+ #### Properties <a name="Properties" id="Properties"></a>
2417
+
2418
+ | **Name** | **Type** | **Description** |
2419
+ | --- | --- | --- |
2420
+ | <code><a href="#projen-pipelines.CustomVersioningConfig.property.outputs">outputs</a></code> | <code><a href="#projen-pipelines.VersioningOutputConfig">VersioningOutputConfig</a></code> | *No description.* |
2421
+ | <code><a href="#projen-pipelines.CustomVersioningConfig.property.strategy">strategy</a></code> | <code><a href="#projen-pipelines.IVersioningStrategy">IVersioningStrategy</a></code> | *No description.* |
2422
+ | <code><a href="#projen-pipelines.CustomVersioningConfig.property.enabled">enabled</a></code> | <code>boolean</code> | *No description.* |
2423
+ | <code><a href="#projen-pipelines.CustomVersioningConfig.property.stageOverrides">stageOverrides</a></code> | <code>{[ key: string ]: <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>}</code> | *No description.* |
2424
+
2425
+ ---
2426
+
2427
+ ##### `outputs`<sup>Required</sup> <a name="outputs" id="projen-pipelines.CustomVersioningConfig.property.outputs"></a>
2428
+
2429
+ ```typescript
2430
+ public readonly outputs: VersioningOutputConfig;
2431
+ ```
2432
+
2433
+ - *Type:* <a href="#projen-pipelines.VersioningOutputConfig">VersioningOutputConfig</a>
2434
+
2435
+ ---
2436
+
2437
+ ##### `strategy`<sup>Required</sup> <a name="strategy" id="projen-pipelines.CustomVersioningConfig.property.strategy"></a>
2438
+
2439
+ ```typescript
2440
+ public readonly strategy: IVersioningStrategy;
2441
+ ```
2442
+
2443
+ - *Type:* <a href="#projen-pipelines.IVersioningStrategy">IVersioningStrategy</a>
2444
+
2445
+ ---
2446
+
2447
+ ##### `enabled`<sup>Optional</sup> <a name="enabled" id="projen-pipelines.CustomVersioningConfig.property.enabled"></a>
2448
+
2449
+ ```typescript
2450
+ public readonly enabled: boolean;
2451
+ ```
2452
+
2453
+ - *Type:* boolean
2454
+
2455
+ ---
2456
+
2457
+ ##### `stageOverrides`<sup>Optional</sup> <a name="stageOverrides" id="projen-pipelines.CustomVersioningConfig.property.stageOverrides"></a>
2458
+
2459
+ ```typescript
2460
+ public readonly stageOverrides: {[ key: string ]: VersioningConfig};
2461
+ ```
2462
+
2463
+ - *Type:* {[ key: string ]: <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>}
2464
+
2465
+ ---
2466
+
2467
+ ### DeploymentInfoInput <a name="DeploymentInfoInput" id="projen-pipelines.DeploymentInfoInput"></a>
2468
+
2469
+ #### Initializer <a name="Initializer" id="projen-pipelines.DeploymentInfoInput.Initializer"></a>
2470
+
2471
+ ```typescript
2472
+ import { DeploymentInfoInput } from 'projen-pipelines'
2473
+
2474
+ const deploymentInfoInput: DeploymentInfoInput = { ... }
2475
+ ```
2476
+
2477
+ #### Properties <a name="Properties" id="Properties"></a>
2478
+
2479
+ | **Name** | **Type** | **Description** |
2480
+ | --- | --- | --- |
2481
+ | <code><a href="#projen-pipelines.DeploymentInfoInput.property.environment">environment</a></code> | <code>string</code> | *No description.* |
2482
+ | <code><a href="#projen-pipelines.DeploymentInfoInput.property.buildNumber">buildNumber</a></code> | <code>string</code> | *No description.* |
2483
+ | <code><a href="#projen-pipelines.DeploymentInfoInput.property.deployedBy">deployedBy</a></code> | <code>string</code> | *No description.* |
2484
+
2485
+ ---
2486
+
2487
+ ##### `environment`<sup>Required</sup> <a name="environment" id="projen-pipelines.DeploymentInfoInput.property.environment"></a>
2488
+
2489
+ ```typescript
2490
+ public readonly environment: string;
2491
+ ```
2492
+
2493
+ - *Type:* string
2494
+
2495
+ ---
2496
+
2497
+ ##### `buildNumber`<sup>Optional</sup> <a name="buildNumber" id="projen-pipelines.DeploymentInfoInput.property.buildNumber"></a>
2498
+
2499
+ ```typescript
2500
+ public readonly buildNumber: string;
2501
+ ```
2502
+
2503
+ - *Type:* string
2504
+
2505
+ ---
2506
+
2507
+ ##### `deployedBy`<sup>Optional</sup> <a name="deployedBy" id="projen-pipelines.DeploymentInfoInput.property.deployedBy"></a>
2508
+
2509
+ ```typescript
2510
+ public readonly deployedBy: string;
2511
+ ```
2512
+
2513
+ - *Type:* string
2514
+
2515
+ ---
2516
+
2517
+ ### DeploymentStage <a name="DeploymentStage" id="projen-pipelines.DeploymentStage"></a>
2518
+
2519
+ Options for stages that are part of the pipeline.
2520
+
2521
+ #### Initializer <a name="Initializer" id="projen-pipelines.DeploymentStage.Initializer"></a>
2522
+
2523
+ ```typescript
2524
+ import { DeploymentStage } from 'projen-pipelines'
2525
+
2526
+ const deploymentStage: DeploymentStage = { ... }
2527
+ ```
2528
+
2529
+ #### Properties <a name="Properties" id="Properties"></a>
2530
+
2531
+ | **Name** | **Type** | **Description** |
2532
+ | --- | --- | --- |
2533
+ | <code><a href="#projen-pipelines.DeploymentStage.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
2534
+ | <code><a href="#projen-pipelines.DeploymentStage.property.name">name</a></code> | <code>string</code> | *No description.* |
2535
+ | <code><a href="#projen-pipelines.DeploymentStage.property.diffType">diffType</a></code> | <code><a href="#projen-pipelines.CdkDiffType">CdkDiffType</a></code> | *No description.* |
2536
+ | <code><a href="#projen-pipelines.DeploymentStage.property.postDeploySteps">postDeploySteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2537
+ | <code><a href="#projen-pipelines.DeploymentStage.property.postDiffSteps">postDiffSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2538
+ | <code><a href="#projen-pipelines.DeploymentStage.property.watchable">watchable</a></code> | <code>boolean</code> | *No description.* |
2539
+ | <code><a href="#projen-pipelines.DeploymentStage.property.manualApproval">manualApproval</a></code> | <code>boolean</code> | *No description.* |
2540
+
2541
+ ---
2542
+
2543
+ ##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.DeploymentStage.property.env"></a>
2544
+
2545
+ ```typescript
2546
+ public readonly env: Environment;
2547
+ ```
2548
+
2549
+ - *Type:* <a href="#projen-pipelines.Environment">Environment</a>
2550
+
2551
+ ---
2552
+
2553
+ ##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.DeploymentStage.property.name"></a>
2554
+
2555
+ ```typescript
2556
+ public readonly name: string;
2557
+ ```
2558
+
2559
+ - *Type:* string
2560
+
2561
+ ---
2562
+
2563
+ ##### `diffType`<sup>Optional</sup> <a name="diffType" id="projen-pipelines.DeploymentStage.property.diffType"></a>
2564
+
2565
+ ```typescript
2566
+ public readonly diffType: CdkDiffType;
2567
+ ```
2568
+
2569
+ - *Type:* <a href="#projen-pipelines.CdkDiffType">CdkDiffType</a>
2570
+
2571
+ ---
2572
+
2573
+ ##### `postDeploySteps`<sup>Optional</sup> <a name="postDeploySteps" id="projen-pipelines.DeploymentStage.property.postDeploySteps"></a>
2574
+
2575
+ ```typescript
2576
+ public readonly postDeploySteps: PipelineStep[];
2577
+ ```
2578
+
2579
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
2580
+
2581
+ ---
2582
+
2583
+ ##### `postDiffSteps`<sup>Optional</sup> <a name="postDiffSteps" id="projen-pipelines.DeploymentStage.property.postDiffSteps"></a>
2584
+
2585
+ ```typescript
2586
+ public readonly postDiffSteps: PipelineStep[];
2587
+ ```
2588
+
2589
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
2590
+
2591
+ ---
2592
+
2593
+ ##### `watchable`<sup>Optional</sup> <a name="watchable" id="projen-pipelines.DeploymentStage.property.watchable"></a>
2594
+
2595
+ ```typescript
2596
+ public readonly watchable: boolean;
2597
+ ```
2598
+
2599
+ - *Type:* boolean
2600
+
2601
+ ---
2602
+
2603
+ ##### `manualApproval`<sup>Optional</sup> <a name="manualApproval" id="projen-pipelines.DeploymentStage.property.manualApproval"></a>
2604
+
2605
+ ```typescript
2606
+ public readonly manualApproval: boolean;
2607
+ ```
2608
+
2609
+ - *Type:* boolean
2610
+
2611
+ ---
2612
+
2613
+ ### DownloadArtifactStepConfig <a name="DownloadArtifactStepConfig" id="projen-pipelines.DownloadArtifactStepConfig"></a>
2614
+
2615
+ #### Initializer <a name="Initializer" id="projen-pipelines.DownloadArtifactStepConfig.Initializer"></a>
2616
+
2617
+ ```typescript
2618
+ import { DownloadArtifactStepConfig } from 'projen-pipelines'
2619
+
2620
+ const downloadArtifactStepConfig: DownloadArtifactStepConfig = { ... }
2621
+ ```
2622
+
2623
+ #### Properties <a name="Properties" id="Properties"></a>
2624
+
2625
+ | **Name** | **Type** | **Description** |
2626
+ | --- | --- | --- |
2627
+ | <code><a href="#projen-pipelines.DownloadArtifactStepConfig.property.name">name</a></code> | <code>string</code> | *No description.* |
2628
+ | <code><a href="#projen-pipelines.DownloadArtifactStepConfig.property.path">path</a></code> | <code>string</code> | *No description.* |
2629
+
2630
+ ---
2631
+
2632
+ ##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.DownloadArtifactStepConfig.property.name"></a>
2633
+
2634
+ ```typescript
2635
+ public readonly name: string;
2636
+ ```
2637
+
2638
+ - *Type:* string
2639
+
2640
+ ---
2641
+
2642
+ ##### `path`<sup>Required</sup> <a name="path" id="projen-pipelines.DownloadArtifactStepConfig.property.path"></a>
2643
+
2644
+ ```typescript
2645
+ public readonly path: string;
2646
+ ```
2647
+
2648
+ - *Type:* string
2649
+
2650
+ ---
2651
+
2652
+ ### Environment <a name="Environment" id="projen-pipelines.Environment"></a>
2653
+
2654
+ The Environment interface is designed to hold AWS related information for a specific deployment environment within your infrastructure.
2104
2655
 
2105
2656
  Each environment requires a specific account and region for its resources.
2106
2657
 
@@ -2241,6 +2792,7 @@ const githubCDKPipelineOptions: GithubCDKPipelineOptions = { ... }
2241
2792
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.preSynthCommands">preSynthCommands</a></code> | <code>string[]</code> | *No description.* |
2242
2793
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.preSynthSteps">preSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2243
2794
  | <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. |
2795
+ | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.versioning">versioning</a></code> | <code><a href="#projen-pipelines.VersioningConfig">VersioningConfig</a></code> | Versioning configuration. |
2244
2796
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.runnerTags">runnerTags</a></code> | <code>string[]</code> | runner tags to use to select runners. |
2245
2797
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.useGithubEnvironments">useGithubEnvironments</a></code> | <code>boolean</code> | whether to use GitHub environments for deployment stages. |
2246
2798
  | <code><a href="#projen-pipelines.GithubCDKPipelineOptions.property.useGithubPackagesForAssembly">useGithubPackagesForAssembly</a></code> | <code>boolean</code> | use GitHub Packages to store vesioned artifacts of cloud assembly; |
@@ -2426,6 +2978,18 @@ This field is used to define a prefix for the AWS Stack resources created during
2426
2978
 
2427
2979
  ---
2428
2980
 
2981
+ ##### `versioning`<sup>Optional</sup> <a name="versioning" id="projen-pipelines.GithubCDKPipelineOptions.property.versioning"></a>
2982
+
2983
+ ```typescript
2984
+ public readonly versioning: VersioningConfig;
2985
+ ```
2986
+
2987
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
2988
+
2989
+ Versioning configuration.
2990
+
2991
+ ---
2992
+
2429
2993
  ##### `runnerTags`<sup>Optional</sup> <a name="runnerTags" id="projen-pipelines.GithubCDKPipelineOptions.property.runnerTags"></a>
2430
2994
 
2431
2995
  ```typescript
@@ -2570,49 +3134,218 @@ Additional job permissions needed.
2570
3134
 
2571
3135
  ---
2572
3136
 
2573
- ### GitlabCDKPipelineOptions <a name="GitlabCDKPipelineOptions" id="projen-pipelines.GitlabCDKPipelineOptions"></a>
3137
+ ### GitInfo <a name="GitInfo" id="projen-pipelines.GitInfo"></a>
2574
3138
 
2575
- Options for configuring the GitLab CDK pipeline, extending the base CDK pipeline options.
3139
+ Git information extracted from repository.
2576
3140
 
2577
- #### Initializer <a name="Initializer" id="projen-pipelines.GitlabCDKPipelineOptions.Initializer"></a>
3141
+ #### Initializer <a name="Initializer" id="projen-pipelines.GitInfo.Initializer"></a>
2578
3142
 
2579
3143
  ```typescript
2580
- import { GitlabCDKPipelineOptions } from 'projen-pipelines'
3144
+ import { GitInfo } from 'projen-pipelines'
2581
3145
 
2582
- const gitlabCDKPipelineOptions: GitlabCDKPipelineOptions = { ... }
3146
+ const gitInfo: GitInfo = { ... }
2583
3147
  ```
2584
3148
 
2585
3149
  #### Properties <a name="Properties" id="Properties"></a>
2586
3150
 
2587
3151
  | **Name** | **Type** | **Description** |
2588
3152
  | --- | --- | --- |
2589
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
2590
- | <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. |
2591
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
2592
- | <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. |
2593
- | <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. |
2594
- | <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. |
2595
- | <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. |
2596
- | <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. |
2597
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
2598
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2599
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
2600
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preInstallSteps">preInstallSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2601
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preSynthCommands">preSynthCommands</a></code> | <code>string[]</code> | *No description.* |
2602
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preSynthSteps">preSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
2603
- | <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. |
2604
- | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.image">image</a></code> | <code>string</code> | The Docker image to use for running the pipeline jobs. |
2605
- | <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. |
3153
+ | <code><a href="#projen-pipelines.GitInfo.property.branch">branch</a></code> | <code>string</code> | *No description.* |
3154
+ | <code><a href="#projen-pipelines.GitInfo.property.commitCount">commitCount</a></code> | <code>number</code> | *No description.* |
3155
+ | <code><a href="#projen-pipelines.GitInfo.property.commitHash">commitHash</a></code> | <code>string</code> | *No description.* |
3156
+ | <code><a href="#projen-pipelines.GitInfo.property.commitHashShort">commitHashShort</a></code> | <code>string</code> | *No description.* |
3157
+ | <code><a href="#projen-pipelines.GitInfo.property.commitsSinceTag">commitsSinceTag</a></code> | <code>number</code> | *No description.* |
3158
+ | <code><a href="#projen-pipelines.GitInfo.property.packageVersion">packageVersion</a></code> | <code>string</code> | *No description.* |
3159
+ | <code><a href="#projen-pipelines.GitInfo.property.tag">tag</a></code> | <code>string</code> | *No description.* |
2606
3160
 
2607
3161
  ---
2608
3162
 
2609
- ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.GitlabCDKPipelineOptions.property.iamRoleArns"></a>
3163
+ ##### `branch`<sup>Required</sup> <a name="branch" id="projen-pipelines.GitInfo.property.branch"></a>
2610
3164
 
2611
3165
  ```typescript
2612
- public readonly iamRoleArns: IamRoleConfig;
3166
+ public readonly branch: string;
2613
3167
  ```
2614
3168
 
2615
- - *Type:* <a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a>
3169
+ - *Type:* string
3170
+
3171
+ ---
3172
+
3173
+ ##### `commitCount`<sup>Required</sup> <a name="commitCount" id="projen-pipelines.GitInfo.property.commitCount"></a>
3174
+
3175
+ ```typescript
3176
+ public readonly commitCount: number;
3177
+ ```
3178
+
3179
+ - *Type:* number
3180
+
3181
+ ---
3182
+
3183
+ ##### `commitHash`<sup>Required</sup> <a name="commitHash" id="projen-pipelines.GitInfo.property.commitHash"></a>
3184
+
3185
+ ```typescript
3186
+ public readonly commitHash: string;
3187
+ ```
3188
+
3189
+ - *Type:* string
3190
+
3191
+ ---
3192
+
3193
+ ##### `commitHashShort`<sup>Required</sup> <a name="commitHashShort" id="projen-pipelines.GitInfo.property.commitHashShort"></a>
3194
+
3195
+ ```typescript
3196
+ public readonly commitHashShort: string;
3197
+ ```
3198
+
3199
+ - *Type:* string
3200
+
3201
+ ---
3202
+
3203
+ ##### `commitsSinceTag`<sup>Optional</sup> <a name="commitsSinceTag" id="projen-pipelines.GitInfo.property.commitsSinceTag"></a>
3204
+
3205
+ ```typescript
3206
+ public readonly commitsSinceTag: number;
3207
+ ```
3208
+
3209
+ - *Type:* number
3210
+
3211
+ ---
3212
+
3213
+ ##### `packageVersion`<sup>Optional</sup> <a name="packageVersion" id="projen-pipelines.GitInfo.property.packageVersion"></a>
3214
+
3215
+ ```typescript
3216
+ public readonly packageVersion: string;
3217
+ ```
3218
+
3219
+ - *Type:* string
3220
+
3221
+ ---
3222
+
3223
+ ##### `tag`<sup>Optional</sup> <a name="tag" id="projen-pipelines.GitInfo.property.tag"></a>
3224
+
3225
+ ```typescript
3226
+ public readonly tag: string;
3227
+ ```
3228
+
3229
+ - *Type:* string
3230
+
3231
+ ---
3232
+
3233
+ ### GitInfoInput <a name="GitInfoInput" id="projen-pipelines.GitInfoInput"></a>
3234
+
3235
+ #### Initializer <a name="Initializer" id="projen-pipelines.GitInfoInput.Initializer"></a>
3236
+
3237
+ ```typescript
3238
+ import { GitInfoInput } from 'projen-pipelines'
3239
+
3240
+ const gitInfoInput: GitInfoInput = { ... }
3241
+ ```
3242
+
3243
+ #### Properties <a name="Properties" id="Properties"></a>
3244
+
3245
+ | **Name** | **Type** | **Description** |
3246
+ | --- | --- | --- |
3247
+ | <code><a href="#projen-pipelines.GitInfoInput.property.branch">branch</a></code> | <code>string</code> | *No description.* |
3248
+ | <code><a href="#projen-pipelines.GitInfoInput.property.commitCount">commitCount</a></code> | <code>number</code> | *No description.* |
3249
+ | <code><a href="#projen-pipelines.GitInfoInput.property.commitHash">commitHash</a></code> | <code>string</code> | *No description.* |
3250
+ | <code><a href="#projen-pipelines.GitInfoInput.property.commitsSinceTag">commitsSinceTag</a></code> | <code>number</code> | *No description.* |
3251
+ | <code><a href="#projen-pipelines.GitInfoInput.property.tag">tag</a></code> | <code>string</code> | *No description.* |
3252
+
3253
+ ---
3254
+
3255
+ ##### `branch`<sup>Required</sup> <a name="branch" id="projen-pipelines.GitInfoInput.property.branch"></a>
3256
+
3257
+ ```typescript
3258
+ public readonly branch: string;
3259
+ ```
3260
+
3261
+ - *Type:* string
3262
+
3263
+ ---
3264
+
3265
+ ##### `commitCount`<sup>Required</sup> <a name="commitCount" id="projen-pipelines.GitInfoInput.property.commitCount"></a>
3266
+
3267
+ ```typescript
3268
+ public readonly commitCount: number;
3269
+ ```
3270
+
3271
+ - *Type:* number
3272
+
3273
+ ---
3274
+
3275
+ ##### `commitHash`<sup>Required</sup> <a name="commitHash" id="projen-pipelines.GitInfoInput.property.commitHash"></a>
3276
+
3277
+ ```typescript
3278
+ public readonly commitHash: string;
3279
+ ```
3280
+
3281
+ - *Type:* string
3282
+
3283
+ ---
3284
+
3285
+ ##### `commitsSinceTag`<sup>Optional</sup> <a name="commitsSinceTag" id="projen-pipelines.GitInfoInput.property.commitsSinceTag"></a>
3286
+
3287
+ ```typescript
3288
+ public readonly commitsSinceTag: number;
3289
+ ```
3290
+
3291
+ - *Type:* number
3292
+
3293
+ ---
3294
+
3295
+ ##### `tag`<sup>Optional</sup> <a name="tag" id="projen-pipelines.GitInfoInput.property.tag"></a>
3296
+
3297
+ ```typescript
3298
+ public readonly tag: string;
3299
+ ```
3300
+
3301
+ - *Type:* string
3302
+
3303
+ ---
3304
+
3305
+ ### GitlabCDKPipelineOptions <a name="GitlabCDKPipelineOptions" id="projen-pipelines.GitlabCDKPipelineOptions"></a>
3306
+
3307
+ Options for configuring the GitLab CDK pipeline, extending the base CDK pipeline options.
3308
+
3309
+ #### Initializer <a name="Initializer" id="projen-pipelines.GitlabCDKPipelineOptions.Initializer"></a>
3310
+
3311
+ ```typescript
3312
+ import { GitlabCDKPipelineOptions } from 'projen-pipelines'
3313
+
3314
+ const gitlabCDKPipelineOptions: GitlabCDKPipelineOptions = { ... }
3315
+ ```
3316
+
3317
+ #### Properties <a name="Properties" id="Properties"></a>
3318
+
3319
+ | **Name** | **Type** | **Description** |
3320
+ | --- | --- | --- |
3321
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.iamRoleArns">iamRoleArns</a></code> | <code><a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a></code> | IAM config. |
3322
+ | <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. |
3323
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.branchName">branchName</a></code> | <code>string</code> | the name of the branch to deploy from. |
3324
+ | <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. |
3325
+ | <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. |
3326
+ | <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. |
3327
+ | <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. |
3328
+ | <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. |
3329
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.postSynthCommands">postSynthCommands</a></code> | <code>string[]</code> | *No description.* |
3330
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.postSynthSteps">postSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
3331
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preInstallCommands">preInstallCommands</a></code> | <code>string[]</code> | *No description.* |
3332
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preInstallSteps">preInstallSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
3333
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preSynthCommands">preSynthCommands</a></code> | <code>string[]</code> | *No description.* |
3334
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.preSynthSteps">preSynthSteps</a></code> | <code><a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]</code> | *No description.* |
3335
+ | <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. |
3336
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.versioning">versioning</a></code> | <code><a href="#projen-pipelines.VersioningConfig">VersioningConfig</a></code> | Versioning configuration. |
3337
+ | <code><a href="#projen-pipelines.GitlabCDKPipelineOptions.property.image">image</a></code> | <code>string</code> | The Docker image to use for running the pipeline jobs. |
3338
+ | <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. |
3339
+
3340
+ ---
3341
+
3342
+ ##### `iamRoleArns`<sup>Required</sup> <a name="iamRoleArns" id="projen-pipelines.GitlabCDKPipelineOptions.property.iamRoleArns"></a>
3343
+
3344
+ ```typescript
3345
+ public readonly iamRoleArns: IamRoleConfig;
3346
+ ```
3347
+
3348
+ - *Type:* <a href="#projen-pipelines.IamRoleConfig">IamRoleConfig</a>
2616
3349
 
2617
3350
  IAM config.
2618
3351
 
@@ -2785,6 +3518,18 @@ This field is used to define a prefix for the AWS Stack resources created during
2785
3518
 
2786
3519
  ---
2787
3520
 
3521
+ ##### `versioning`<sup>Optional</sup> <a name="versioning" id="projen-pipelines.GitlabCDKPipelineOptions.property.versioning"></a>
3522
+
3523
+ ```typescript
3524
+ public readonly versioning: VersioningConfig;
3525
+ ```
3526
+
3527
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
3528
+
3529
+ Versioning configuration.
3530
+
3531
+ ---
3532
+
2788
3533
  ##### `image`<sup>Optional</sup> <a name="image" id="projen-pipelines.GitlabCDKPipelineOptions.property.image"></a>
2789
3534
 
2790
3535
  ```typescript
@@ -2966,6 +3711,114 @@ Dependencies which need to be completed before this step.
2966
3711
 
2967
3712
  ---
2968
3713
 
3714
+ ### GitTagConfig <a name="GitTagConfig" id="projen-pipelines.GitTagConfig"></a>
3715
+
3716
+ #### Initializer <a name="Initializer" id="projen-pipelines.GitTagConfig.Initializer"></a>
3717
+
3718
+ ```typescript
3719
+ import { GitTagConfig } from 'projen-pipelines'
3720
+
3721
+ const gitTagConfig: GitTagConfig = { ... }
3722
+ ```
3723
+
3724
+ #### Properties <a name="Properties" id="Properties"></a>
3725
+
3726
+ | **Name** | **Type** | **Description** |
3727
+ | --- | --- | --- |
3728
+ | <code><a href="#projen-pipelines.GitTagConfig.property.annotatedOnly">annotatedOnly</a></code> | <code>boolean</code> | Only use annotated tags. |
3729
+ | <code><a href="#projen-pipelines.GitTagConfig.property.includeSinceTag">includeSinceTag</a></code> | <code>boolean</code> | Include commits since tag. |
3730
+ | <code><a href="#projen-pipelines.GitTagConfig.property.pattern">pattern</a></code> | <code>string</code> | Tag pattern to match. |
3731
+ | <code><a href="#projen-pipelines.GitTagConfig.property.stripPrefix">stripPrefix</a></code> | <code>string</code> | Strip prefix from tag. |
3732
+
3733
+ ---
3734
+
3735
+ ##### `annotatedOnly`<sup>Optional</sup> <a name="annotatedOnly" id="projen-pipelines.GitTagConfig.property.annotatedOnly"></a>
3736
+
3737
+ ```typescript
3738
+ public readonly annotatedOnly: boolean;
3739
+ ```
3740
+
3741
+ - *Type:* boolean
3742
+
3743
+ Only use annotated tags.
3744
+
3745
+ ---
3746
+
3747
+ ##### `includeSinceTag`<sup>Optional</sup> <a name="includeSinceTag" id="projen-pipelines.GitTagConfig.property.includeSinceTag"></a>
3748
+
3749
+ ```typescript
3750
+ public readonly includeSinceTag: boolean;
3751
+ ```
3752
+
3753
+ - *Type:* boolean
3754
+
3755
+ Include commits since tag.
3756
+
3757
+ ---
3758
+
3759
+ ##### `pattern`<sup>Optional</sup> <a name="pattern" id="projen-pipelines.GitTagConfig.property.pattern"></a>
3760
+
3761
+ ```typescript
3762
+ public readonly pattern: string;
3763
+ ```
3764
+
3765
+ - *Type:* string
3766
+
3767
+ Tag pattern to match.
3768
+
3769
+ ---
3770
+
3771
+ ##### `stripPrefix`<sup>Optional</sup> <a name="stripPrefix" id="projen-pipelines.GitTagConfig.property.stripPrefix"></a>
3772
+
3773
+ ```typescript
3774
+ public readonly stripPrefix: string;
3775
+ ```
3776
+
3777
+ - *Type:* string
3778
+
3779
+ Strip prefix from tag.
3780
+
3781
+ ---
3782
+
3783
+ ### HierarchicalParametersOptions <a name="HierarchicalParametersOptions" id="projen-pipelines.HierarchicalParametersOptions"></a>
3784
+
3785
+ #### Initializer <a name="Initializer" id="projen-pipelines.HierarchicalParametersOptions.Initializer"></a>
3786
+
3787
+ ```typescript
3788
+ import { HierarchicalParametersOptions } from 'projen-pipelines'
3789
+
3790
+ const hierarchicalParametersOptions: HierarchicalParametersOptions = { ... }
3791
+ ```
3792
+
3793
+ #### Properties <a name="Properties" id="Properties"></a>
3794
+
3795
+ | **Name** | **Type** | **Description** |
3796
+ | --- | --- | --- |
3797
+ | <code><a href="#projen-pipelines.HierarchicalParametersOptions.property.format">format</a></code> | <code>string</code> | *No description.* |
3798
+ | <code><a href="#projen-pipelines.HierarchicalParametersOptions.property.includeCloudFormation">includeCloudFormation</a></code> | <code>boolean</code> | *No description.* |
3799
+
3800
+ ---
3801
+
3802
+ ##### `format`<sup>Optional</sup> <a name="format" id="projen-pipelines.HierarchicalParametersOptions.property.format"></a>
3803
+
3804
+ ```typescript
3805
+ public readonly format: string;
3806
+ ```
3807
+
3808
+ - *Type:* string
3809
+
3810
+ ---
3811
+
3812
+ ##### `includeCloudFormation`<sup>Optional</sup> <a name="includeCloudFormation" id="projen-pipelines.HierarchicalParametersOptions.property.includeCloudFormation"></a>
3813
+
3814
+ ```typescript
3815
+ public readonly includeCloudFormation: boolean;
3816
+ ```
3817
+
3818
+ - *Type:* boolean
3819
+
3820
+ ---
3821
+
2969
3822
  ### IamRoleConfig <a name="IamRoleConfig" id="projen-pipelines.IamRoleConfig"></a>
2970
3823
 
2971
3824
  Configuration interface for IAM roles used in the CDK pipeline.
@@ -3247,192 +4100,2156 @@ public readonly watchable: boolean;
3247
4100
 
3248
4101
  ---
3249
4102
 
3250
- ### StageOptions <a name="StageOptions" id="projen-pipelines.StageOptions"></a>
3251
-
3252
- Options for a CDK stage like the target environment.
4103
+ ### PackageJsonConfig <a name="PackageJsonConfig" id="projen-pipelines.PackageJsonConfig"></a>
3253
4104
 
3254
- #### Initializer <a name="Initializer" id="projen-pipelines.StageOptions.Initializer"></a>
4105
+ #### Initializer <a name="Initializer" id="projen-pipelines.PackageJsonConfig.Initializer"></a>
3255
4106
 
3256
4107
  ```typescript
3257
- import { StageOptions } from 'projen-pipelines'
4108
+ import { PackageJsonConfig } from 'projen-pipelines'
3258
4109
 
3259
- const stageOptions: StageOptions = { ... }
4110
+ const packageJsonConfig: PackageJsonConfig = { ... }
3260
4111
  ```
3261
4112
 
3262
4113
  #### Properties <a name="Properties" id="Properties"></a>
3263
4114
 
3264
4115
  | **Name** | **Type** | **Description** |
3265
4116
  | --- | --- | --- |
3266
- | <code><a href="#projen-pipelines.StageOptions.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
4117
+ | <code><a href="#projen-pipelines.PackageJsonConfig.property.appendCommitInfo">appendCommitInfo</a></code> | <code>boolean</code> | Append commit info. |
4118
+ | <code><a href="#projen-pipelines.PackageJsonConfig.property.includePrerelease">includePrerelease</a></code> | <code>boolean</code> | Include pre-release version. |
4119
+ | <code><a href="#projen-pipelines.PackageJsonConfig.property.path">path</a></code> | <code>string</code> | Path to package.json. |
3267
4120
 
3268
4121
  ---
3269
4122
 
3270
- ##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.StageOptions.property.env"></a>
4123
+ ##### `appendCommitInfo`<sup>Optional</sup> <a name="appendCommitInfo" id="projen-pipelines.PackageJsonConfig.property.appendCommitInfo"></a>
3271
4124
 
3272
4125
  ```typescript
3273
- public readonly env: Environment;
4126
+ public readonly appendCommitInfo: boolean;
3274
4127
  ```
3275
4128
 
3276
- - *Type:* <a href="#projen-pipelines.Environment">Environment</a>
4129
+ - *Type:* boolean
3277
4130
 
3278
- ---
4131
+ Append commit info.
3279
4132
 
3280
- ### UploadArtifactStepConfig <a name="UploadArtifactStepConfig" id="projen-pipelines.UploadArtifactStepConfig"></a>
4133
+ ---
3281
4134
 
3282
- #### Initializer <a name="Initializer" id="projen-pipelines.UploadArtifactStepConfig.Initializer"></a>
4135
+ ##### `includePrerelease`<sup>Optional</sup> <a name="includePrerelease" id="projen-pipelines.PackageJsonConfig.property.includePrerelease"></a>
3283
4136
 
3284
4137
  ```typescript
3285
- import { UploadArtifactStepConfig } from 'projen-pipelines'
3286
-
3287
- const uploadArtifactStepConfig: UploadArtifactStepConfig = { ... }
4138
+ public readonly includePrerelease: boolean;
3288
4139
  ```
3289
4140
 
3290
- #### Properties <a name="Properties" id="Properties"></a>
4141
+ - *Type:* boolean
3291
4142
 
3292
- | **Name** | **Type** | **Description** |
3293
- | --- | --- | --- |
3294
- | <code><a href="#projen-pipelines.UploadArtifactStepConfig.property.name">name</a></code> | <code>string</code> | *No description.* |
3295
- | <code><a href="#projen-pipelines.UploadArtifactStepConfig.property.path">path</a></code> | <code>string</code> | *No description.* |
4143
+ Include pre-release version.
3296
4144
 
3297
4145
  ---
3298
4146
 
3299
- ##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.UploadArtifactStepConfig.property.name"></a>
4147
+ ##### `path`<sup>Optional</sup> <a name="path" id="projen-pipelines.PackageJsonConfig.property.path"></a>
3300
4148
 
3301
4149
  ```typescript
3302
- public readonly name: string;
4150
+ public readonly path: string;
3303
4151
  ```
3304
4152
 
3305
4153
  - *Type:* string
3306
4154
 
4155
+ Path to package.json.
4156
+
4157
+ ---
4158
+
4159
+ ### ParameterStoreConfig <a name="ParameterStoreConfig" id="projen-pipelines.ParameterStoreConfig"></a>
4160
+
4161
+ #### Initializer <a name="Initializer" id="projen-pipelines.ParameterStoreConfig.Initializer"></a>
4162
+
4163
+ ```typescript
4164
+ import { ParameterStoreConfig } from 'projen-pipelines'
4165
+
4166
+ const parameterStoreConfig: ParameterStoreConfig = { ... }
4167
+ ```
4168
+
4169
+ #### Properties <a name="Properties" id="Properties"></a>
4170
+
4171
+ | **Name** | **Type** | **Description** |
4172
+ | --- | --- | --- |
4173
+ | <code><a href="#projen-pipelines.ParameterStoreConfig.property.enabled">enabled</a></code> | <code>boolean</code> | *No description.* |
4174
+ | <code><a href="#projen-pipelines.ParameterStoreConfig.property.allowOverwrite">allowOverwrite</a></code> | <code>boolean</code> | *No description.* |
4175
+ | <code><a href="#projen-pipelines.ParameterStoreConfig.property.description">description</a></code> | <code>string</code> | *No description.* |
4176
+ | <code><a href="#projen-pipelines.ParameterStoreConfig.property.hierarchical">hierarchical</a></code> | <code>boolean</code> | *No description.* |
4177
+ | <code><a href="#projen-pipelines.ParameterStoreConfig.property.parameterName">parameterName</a></code> | <code>string</code> | *No description.* |
4178
+ | <code><a href="#projen-pipelines.ParameterStoreConfig.property.splitParameters">splitParameters</a></code> | <code>boolean</code> | *No description.* |
4179
+
4180
+ ---
4181
+
4182
+ ##### `enabled`<sup>Required</sup> <a name="enabled" id="projen-pipelines.ParameterStoreConfig.property.enabled"></a>
4183
+
4184
+ ```typescript
4185
+ public readonly enabled: boolean;
4186
+ ```
4187
+
4188
+ - *Type:* boolean
4189
+
4190
+ ---
4191
+
4192
+ ##### `allowOverwrite`<sup>Optional</sup> <a name="allowOverwrite" id="projen-pipelines.ParameterStoreConfig.property.allowOverwrite"></a>
4193
+
4194
+ ```typescript
4195
+ public readonly allowOverwrite: boolean;
4196
+ ```
4197
+
4198
+ - *Type:* boolean
4199
+
4200
+ ---
4201
+
4202
+ ##### `description`<sup>Optional</sup> <a name="description" id="projen-pipelines.ParameterStoreConfig.property.description"></a>
4203
+
4204
+ ```typescript
4205
+ public readonly description: string;
4206
+ ```
4207
+
4208
+ - *Type:* string
4209
+
4210
+ ---
4211
+
4212
+ ##### `hierarchical`<sup>Optional</sup> <a name="hierarchical" id="projen-pipelines.ParameterStoreConfig.property.hierarchical"></a>
4213
+
4214
+ ```typescript
4215
+ public readonly hierarchical: boolean;
4216
+ ```
4217
+
4218
+ - *Type:* boolean
4219
+
4220
+ ---
4221
+
4222
+ ##### `parameterName`<sup>Optional</sup> <a name="parameterName" id="projen-pipelines.ParameterStoreConfig.property.parameterName"></a>
4223
+
4224
+ ```typescript
4225
+ public readonly parameterName: string;
4226
+ ```
4227
+
4228
+ - *Type:* string
4229
+
4230
+ ---
4231
+
4232
+ ##### `splitParameters`<sup>Optional</sup> <a name="splitParameters" id="projen-pipelines.ParameterStoreConfig.property.splitParameters"></a>
4233
+
4234
+ ```typescript
4235
+ public readonly splitParameters: boolean;
4236
+ ```
4237
+
4238
+ - *Type:* boolean
4239
+
4240
+ ---
4241
+
4242
+ ### StageOptions <a name="StageOptions" id="projen-pipelines.StageOptions"></a>
4243
+
4244
+ Options for a CDK stage like the target environment.
4245
+
4246
+ #### Initializer <a name="Initializer" id="projen-pipelines.StageOptions.Initializer"></a>
4247
+
4248
+ ```typescript
4249
+ import { StageOptions } from 'projen-pipelines'
4250
+
4251
+ const stageOptions: StageOptions = { ... }
4252
+ ```
4253
+
4254
+ #### Properties <a name="Properties" id="Properties"></a>
4255
+
4256
+ | **Name** | **Type** | **Description** |
4257
+ | --- | --- | --- |
4258
+ | <code><a href="#projen-pipelines.StageOptions.property.env">env</a></code> | <code><a href="#projen-pipelines.Environment">Environment</a></code> | *No description.* |
4259
+
4260
+ ---
4261
+
4262
+ ##### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.StageOptions.property.env"></a>
4263
+
4264
+ ```typescript
4265
+ public readonly env: Environment;
4266
+ ```
4267
+
4268
+ - *Type:* <a href="#projen-pipelines.Environment">Environment</a>
4269
+
4270
+ ---
4271
+
4272
+ ### StandardConfigOptions <a name="StandardConfigOptions" id="projen-pipelines.StandardConfigOptions"></a>
4273
+
4274
+ #### Initializer <a name="Initializer" id="projen-pipelines.StandardConfigOptions.Initializer"></a>
4275
+
4276
+ ```typescript
4277
+ import { StandardConfigOptions } from 'projen-pipelines'
4278
+
4279
+ const standardConfigOptions: StandardConfigOptions = { ... }
4280
+ ```
4281
+
4282
+ #### Properties <a name="Properties" id="Properties"></a>
4283
+
4284
+ | **Name** | **Type** | **Description** |
4285
+ | --- | --- | --- |
4286
+ | <code><a href="#projen-pipelines.StandardConfigOptions.property.format">format</a></code> | <code>string</code> | *No description.* |
4287
+ | <code><a href="#projen-pipelines.StandardConfigOptions.property.parameterStore">parameterStore</a></code> | <code>string \| boolean</code> | *No description.* |
4288
+
4289
+ ---
4290
+
4291
+ ##### `format`<sup>Optional</sup> <a name="format" id="projen-pipelines.StandardConfigOptions.property.format"></a>
4292
+
4293
+ ```typescript
4294
+ public readonly format: string;
4295
+ ```
4296
+
4297
+ - *Type:* string
4298
+
4299
+ ---
4300
+
4301
+ ##### `parameterStore`<sup>Optional</sup> <a name="parameterStore" id="projen-pipelines.StandardConfigOptions.property.parameterStore"></a>
4302
+
4303
+ ```typescript
4304
+ public readonly parameterStore: string | boolean;
4305
+ ```
4306
+
4307
+ - *Type:* string | boolean
4308
+
4309
+ ---
4310
+
4311
+ ### StandardOutputOptions <a name="StandardOutputOptions" id="projen-pipelines.StandardOutputOptions"></a>
4312
+
4313
+ #### Initializer <a name="Initializer" id="projen-pipelines.StandardOutputOptions.Initializer"></a>
4314
+
4315
+ ```typescript
4316
+ import { StandardOutputOptions } from 'projen-pipelines'
4317
+
4318
+ const standardOutputOptions: StandardOutputOptions = { ... }
4319
+ ```
4320
+
4321
+ #### Properties <a name="Properties" id="Properties"></a>
4322
+
4323
+ | **Name** | **Type** | **Description** |
4324
+ | --- | --- | --- |
4325
+ | <code><a href="#projen-pipelines.StandardOutputOptions.property.format">format</a></code> | <code>string</code> | *No description.* |
4326
+ | <code><a href="#projen-pipelines.StandardOutputOptions.property.parameterName">parameterName</a></code> | <code>string</code> | *No description.* |
4327
+
4328
+ ---
4329
+
4330
+ ##### `format`<sup>Optional</sup> <a name="format" id="projen-pipelines.StandardOutputOptions.property.format"></a>
4331
+
4332
+ ```typescript
4333
+ public readonly format: string;
4334
+ ```
4335
+
4336
+ - *Type:* string
4337
+
4338
+ ---
4339
+
4340
+ ##### `parameterName`<sup>Optional</sup> <a name="parameterName" id="projen-pipelines.StandardOutputOptions.property.parameterName"></a>
4341
+
4342
+ ```typescript
4343
+ public readonly parameterName: string;
4344
+ ```
4345
+
4346
+ - *Type:* string
4347
+
4348
+ ---
4349
+
4350
+ ### UploadArtifactStepConfig <a name="UploadArtifactStepConfig" id="projen-pipelines.UploadArtifactStepConfig"></a>
4351
+
4352
+ #### Initializer <a name="Initializer" id="projen-pipelines.UploadArtifactStepConfig.Initializer"></a>
4353
+
4354
+ ```typescript
4355
+ import { UploadArtifactStepConfig } from 'projen-pipelines'
4356
+
4357
+ const uploadArtifactStepConfig: UploadArtifactStepConfig = { ... }
4358
+ ```
4359
+
4360
+ #### Properties <a name="Properties" id="Properties"></a>
4361
+
4362
+ | **Name** | **Type** | **Description** |
4363
+ | --- | --- | --- |
4364
+ | <code><a href="#projen-pipelines.UploadArtifactStepConfig.property.name">name</a></code> | <code>string</code> | *No description.* |
4365
+ | <code><a href="#projen-pipelines.UploadArtifactStepConfig.property.path">path</a></code> | <code>string</code> | *No description.* |
4366
+
4367
+ ---
4368
+
4369
+ ##### `name`<sup>Required</sup> <a name="name" id="projen-pipelines.UploadArtifactStepConfig.property.name"></a>
4370
+
4371
+ ```typescript
4372
+ public readonly name: string;
4373
+ ```
4374
+
4375
+ - *Type:* string
4376
+
4377
+ ---
4378
+
4379
+ ##### `path`<sup>Required</sup> <a name="path" id="projen-pipelines.UploadArtifactStepConfig.property.path"></a>
4380
+
4381
+ ```typescript
4382
+ public readonly path: string;
4383
+ ```
4384
+
4385
+ - *Type:* string
4386
+
4387
+ ---
4388
+
4389
+ ### VersioningConfig <a name="VersioningConfig" id="projen-pipelines.VersioningConfig"></a>
4390
+
4391
+ #### Initializer <a name="Initializer" id="projen-pipelines.VersioningConfig.Initializer"></a>
4392
+
4393
+ ```typescript
4394
+ import { VersioningConfig } from 'projen-pipelines'
4395
+
4396
+ const versioningConfig: VersioningConfig = { ... }
4397
+ ```
4398
+
4399
+ #### Properties <a name="Properties" id="Properties"></a>
4400
+
4401
+ | **Name** | **Type** | **Description** |
4402
+ | --- | --- | --- |
4403
+ | <code><a href="#projen-pipelines.VersioningConfig.property.enabled">enabled</a></code> | <code>boolean</code> | Enable versioning feature. |
4404
+ | <code><a href="#projen-pipelines.VersioningConfig.property.outputs">outputs</a></code> | <code><a href="#projen-pipelines.VersioningOutputConfig">VersioningOutputConfig</a></code> | Output configuration. |
4405
+ | <code><a href="#projen-pipelines.VersioningConfig.property.strategy">strategy</a></code> | <code><a href="#projen-pipelines.IVersioningStrategy">IVersioningStrategy</a></code> | Primary versioning strategy. |
4406
+ | <code><a href="#projen-pipelines.VersioningConfig.property.stageOverrides">stageOverrides</a></code> | <code>{[ key: string ]: <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>}</code> | Stage-specific overrides. |
4407
+
4408
+ ---
4409
+
4410
+ ##### `enabled`<sup>Required</sup> <a name="enabled" id="projen-pipelines.VersioningConfig.property.enabled"></a>
4411
+
4412
+ ```typescript
4413
+ public readonly enabled: boolean;
4414
+ ```
4415
+
4416
+ - *Type:* boolean
4417
+ - *Default:* true
4418
+
4419
+ Enable versioning feature.
4420
+
4421
+ ---
4422
+
4423
+ ##### `outputs`<sup>Required</sup> <a name="outputs" id="projen-pipelines.VersioningConfig.property.outputs"></a>
4424
+
4425
+ ```typescript
4426
+ public readonly outputs: VersioningOutputConfig;
4427
+ ```
4428
+
4429
+ - *Type:* <a href="#projen-pipelines.VersioningOutputConfig">VersioningOutputConfig</a>
4430
+
4431
+ Output configuration.
4432
+
4433
+ ---
4434
+
4435
+ ##### `strategy`<sup>Required</sup> <a name="strategy" id="projen-pipelines.VersioningConfig.property.strategy"></a>
4436
+
4437
+ ```typescript
4438
+ public readonly strategy: IVersioningStrategy;
4439
+ ```
4440
+
4441
+ - *Type:* <a href="#projen-pipelines.IVersioningStrategy">IVersioningStrategy</a>
4442
+
4443
+ Primary versioning strategy.
4444
+
4445
+ ---
4446
+
4447
+ ##### `stageOverrides`<sup>Optional</sup> <a name="stageOverrides" id="projen-pipelines.VersioningConfig.property.stageOverrides"></a>
4448
+
4449
+ ```typescript
4450
+ public readonly stageOverrides: {[ key: string ]: VersioningConfig};
4451
+ ```
4452
+
4453
+ - *Type:* {[ key: string ]: <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>}
4454
+
4455
+ Stage-specific overrides.
4456
+
4457
+ ---
4458
+
4459
+ ### VersioningOutputConfig <a name="VersioningOutputConfig" id="projen-pipelines.VersioningOutputConfig"></a>
4460
+
4461
+ #### Initializer <a name="Initializer" id="projen-pipelines.VersioningOutputConfig.Initializer"></a>
4462
+
4463
+ ```typescript
4464
+ import { VersioningOutputConfig } from 'projen-pipelines'
4465
+
4466
+ const versioningOutputConfig: VersioningOutputConfig = { ... }
4467
+ ```
4468
+
4469
+ #### Properties <a name="Properties" id="Properties"></a>
4470
+
4471
+ | **Name** | **Type** | **Description** |
4472
+ | --- | --- | --- |
4473
+ | <code><a href="#projen-pipelines.VersioningOutputConfig.property.cloudFormation">cloudFormation</a></code> | <code><a href="#projen-pipelines.CloudFormationOutputConfig">CloudFormationOutputConfig</a></code> | Output to CloudFormation stack outputs. |
4474
+ | <code><a href="#projen-pipelines.VersioningOutputConfig.property.parameterStore">parameterStore</a></code> | <code><a href="#projen-pipelines.ParameterStoreConfig">ParameterStoreConfig</a></code> | Output to SSM Parameter Store. |
4475
+
4476
+ ---
4477
+
4478
+ ##### `cloudFormation`<sup>Required</sup> <a name="cloudFormation" id="projen-pipelines.VersioningOutputConfig.property.cloudFormation"></a>
4479
+
4480
+ ```typescript
4481
+ public readonly cloudFormation: CloudFormationOutputConfig;
4482
+ ```
4483
+
4484
+ - *Type:* <a href="#projen-pipelines.CloudFormationOutputConfig">CloudFormationOutputConfig</a>
4485
+ - *Default:* true
4486
+
4487
+ Output to CloudFormation stack outputs.
4488
+
4489
+ ---
4490
+
4491
+ ##### `parameterStore`<sup>Required</sup> <a name="parameterStore" id="projen-pipelines.VersioningOutputConfig.property.parameterStore"></a>
4492
+
4493
+ ```typescript
4494
+ public readonly parameterStore: ParameterStoreConfig;
4495
+ ```
4496
+
4497
+ - *Type:* <a href="#projen-pipelines.ParameterStoreConfig">ParameterStoreConfig</a>
4498
+ - *Default:* false
4499
+
4500
+ Output to SSM Parameter Store.
4501
+
4502
+ ---
4503
+
4504
+ ### VersioningStrategyComponents <a name="VersioningStrategyComponents" id="projen-pipelines.VersioningStrategyComponents"></a>
4505
+
4506
+ #### Initializer <a name="Initializer" id="projen-pipelines.VersioningStrategyComponents.Initializer"></a>
4507
+
4508
+ ```typescript
4509
+ import { VersioningStrategyComponents } from 'projen-pipelines'
4510
+
4511
+ const versioningStrategyComponents: VersioningStrategyComponents = { ... }
4512
+ ```
4513
+
4514
+ #### Properties <a name="Properties" id="Properties"></a>
4515
+
4516
+ | **Name** | **Type** | **Description** |
4517
+ | --- | --- | --- |
4518
+ | <code><a href="#projen-pipelines.VersioningStrategyComponents.property.commitCount">commitCount</a></code> | <code><a href="#projen-pipelines.CommitCountConfig">CommitCountConfig</a></code> | *No description.* |
4519
+ | <code><a href="#projen-pipelines.VersioningStrategyComponents.property.gitTag">gitTag</a></code> | <code><a href="#projen-pipelines.GitTagConfig">GitTagConfig</a></code> | *No description.* |
4520
+ | <code><a href="#projen-pipelines.VersioningStrategyComponents.property.packageJson">packageJson</a></code> | <code><a href="#projen-pipelines.PackageJsonConfig">PackageJsonConfig</a></code> | *No description.* |
4521
+
4522
+ ---
4523
+
4524
+ ##### `commitCount`<sup>Optional</sup> <a name="commitCount" id="projen-pipelines.VersioningStrategyComponents.property.commitCount"></a>
4525
+
4526
+ ```typescript
4527
+ public readonly commitCount: CommitCountConfig;
4528
+ ```
4529
+
4530
+ - *Type:* <a href="#projen-pipelines.CommitCountConfig">CommitCountConfig</a>
4531
+
4532
+ ---
4533
+
4534
+ ##### `gitTag`<sup>Optional</sup> <a name="gitTag" id="projen-pipelines.VersioningStrategyComponents.property.gitTag"></a>
4535
+
4536
+ ```typescript
4537
+ public readonly gitTag: GitTagConfig;
4538
+ ```
4539
+
4540
+ - *Type:* <a href="#projen-pipelines.GitTagConfig">GitTagConfig</a>
4541
+
4542
+ ---
4543
+
4544
+ ##### `packageJson`<sup>Optional</sup> <a name="packageJson" id="projen-pipelines.VersioningStrategyComponents.property.packageJson"></a>
4545
+
4546
+ ```typescript
4547
+ public readonly packageJson: PackageJsonConfig;
4548
+ ```
4549
+
4550
+ - *Type:* <a href="#projen-pipelines.PackageJsonConfig">PackageJsonConfig</a>
4551
+
4552
+ ---
4553
+
4554
+ ## Classes <a name="Classes" id="Classes"></a>
4555
+
4556
+ ### AwsAssumeRoleStep <a name="AwsAssumeRoleStep" id="projen-pipelines.AwsAssumeRoleStep"></a>
4557
+
4558
+ A step that assumes a role in AWS.
4559
+
4560
+ #### Initializers <a name="Initializers" id="projen-pipelines.AwsAssumeRoleStep.Initializer"></a>
4561
+
4562
+ ```typescript
4563
+ import { AwsAssumeRoleStep } from 'projen-pipelines'
4564
+
4565
+ new AwsAssumeRoleStep(project: Project, config: AwsAssumeRoleStepConfig)
4566
+ ```
4567
+
4568
+ | **Name** | **Type** | **Description** |
4569
+ | --- | --- | --- |
4570
+ | <code><a href="#projen-pipelines.AwsAssumeRoleStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
4571
+ | <code><a href="#projen-pipelines.AwsAssumeRoleStep.Initializer.parameter.config">config</a></code> | <code><a href="#projen-pipelines.AwsAssumeRoleStepConfig">AwsAssumeRoleStepConfig</a></code> | *No description.* |
4572
+
4573
+ ---
4574
+
4575
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.AwsAssumeRoleStep.Initializer.parameter.project"></a>
4576
+
4577
+ - *Type:* projen.Project
4578
+
4579
+ The projen project reference.
4580
+
4581
+ ---
4582
+
4583
+ ##### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.AwsAssumeRoleStep.Initializer.parameter.config"></a>
4584
+
4585
+ - *Type:* <a href="#projen-pipelines.AwsAssumeRoleStepConfig">AwsAssumeRoleStepConfig</a>
4586
+
4587
+ ---
4588
+
4589
+ #### Methods <a name="Methods" id="Methods"></a>
4590
+
4591
+ | **Name** | **Description** |
4592
+ | --- | --- |
4593
+ | <code><a href="#projen-pipelines.AwsAssumeRoleStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
4594
+ | <code><a href="#projen-pipelines.AwsAssumeRoleStep.toCodeCatalyst">toCodeCatalyst</a></code> | Generates a configuration for a CodeCatalyst Actions step. |
4595
+ | <code><a href="#projen-pipelines.AwsAssumeRoleStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
4596
+ | <code><a href="#projen-pipelines.AwsAssumeRoleStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
4597
+
4598
+ ---
4599
+
4600
+ ##### `toBash` <a name="toBash" id="projen-pipelines.AwsAssumeRoleStep.toBash"></a>
4601
+
4602
+ ```typescript
4603
+ public toBash(): BashStepConfig
4604
+ ```
4605
+
4606
+ Generates a configuration for a bash script step.
4607
+
4608
+ Should be implemented by subclasses.
4609
+
4610
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.AwsAssumeRoleStep.toCodeCatalyst"></a>
4611
+
4612
+ ```typescript
4613
+ public toCodeCatalyst(): CodeCatalystStepConfig
4614
+ ```
4615
+
4616
+ Generates a configuration for a CodeCatalyst Actions step.
4617
+
4618
+ Should be implemented by subclasses.
4619
+
4620
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.AwsAssumeRoleStep.toGithub"></a>
4621
+
4622
+ ```typescript
4623
+ public toGithub(): GithubStepConfig
4624
+ ```
4625
+
4626
+ Generates a configuration for a GitHub Actions step.
4627
+
4628
+ Should be implemented by subclasses.
4629
+
4630
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.AwsAssumeRoleStep.toGitlab"></a>
4631
+
4632
+ ```typescript
4633
+ public toGitlab(): GitlabStepConfig
4634
+ ```
4635
+
4636
+ Generates a configuration for a GitLab CI step.
4637
+
4638
+ Should be implemented by subclasses.
4639
+
4640
+
4641
+
4642
+
4643
+ ### CloudFormationOutput <a name="CloudFormationOutput" id="projen-pipelines.CloudFormationOutput"></a>
4644
+
4645
+ CloudFormation output configuration.
4646
+
4647
+ #### Methods <a name="Methods" id="Methods"></a>
4648
+
4649
+ | **Name** | **Description** |
4650
+ | --- | --- |
4651
+ | <code><a href="#projen-pipelines.CloudFormationOutput.toConfig">toConfig</a></code> | Convert to configuration object. |
4652
+
4653
+ ---
4654
+
4655
+ ##### `toConfig` <a name="toConfig" id="projen-pipelines.CloudFormationOutput.toConfig"></a>
4656
+
4657
+ ```typescript
4658
+ public toConfig(): any
4659
+ ```
4660
+
4661
+ Convert to configuration object.
4662
+
4663
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
4664
+
4665
+ | **Name** | **Description** |
4666
+ | --- | --- |
4667
+ | <code><a href="#projen-pipelines.CloudFormationOutput.disabled">disabled</a></code> | Disable CloudFormation outputs. |
4668
+ | <code><a href="#projen-pipelines.CloudFormationOutput.enabled">enabled</a></code> | Enable CloudFormation outputs with default configuration. |
4669
+ | <code><a href="#projen-pipelines.CloudFormationOutput.withConfig">withConfig</a></code> | Configure CloudFormation outputs with custom settings. |
4670
+
4671
+ ---
4672
+
4673
+ ##### `disabled` <a name="disabled" id="projen-pipelines.CloudFormationOutput.disabled"></a>
4674
+
4675
+ ```typescript
4676
+ import { CloudFormationOutput } from 'projen-pipelines'
4677
+
4678
+ CloudFormationOutput.disabled()
4679
+ ```
4680
+
4681
+ Disable CloudFormation outputs.
4682
+
4683
+ ##### `enabled` <a name="enabled" id="projen-pipelines.CloudFormationOutput.enabled"></a>
4684
+
4685
+ ```typescript
4686
+ import { CloudFormationOutput } from 'projen-pipelines'
4687
+
4688
+ CloudFormationOutput.enabled()
4689
+ ```
4690
+
4691
+ Enable CloudFormation outputs with default configuration.
4692
+
4693
+ ##### `withConfig` <a name="withConfig" id="projen-pipelines.CloudFormationOutput.withConfig"></a>
4694
+
4695
+ ```typescript
4696
+ import { CloudFormationOutput } from 'projen-pipelines'
4697
+
4698
+ CloudFormationOutput.withConfig(config: CloudFormationOutputConfig)
4699
+ ```
4700
+
4701
+ Configure CloudFormation outputs with custom settings.
4702
+
4703
+ ###### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.CloudFormationOutput.withConfig.parameter.config"></a>
4704
+
4705
+ - *Type:* <a href="#projen-pipelines.CloudFormationOutputConfig">CloudFormationOutputConfig</a>
4706
+
4707
+ ---
4708
+
4709
+ #### Properties <a name="Properties" id="Properties"></a>
4710
+
4711
+ | **Name** | **Type** | **Description** |
4712
+ | --- | --- | --- |
4713
+ | <code><a href="#projen-pipelines.CloudFormationOutput.property.type">type</a></code> | <code>string</code> | *No description.* |
4714
+
4715
+ ---
4716
+
4717
+ ##### `type`<sup>Required</sup> <a name="type" id="projen-pipelines.CloudFormationOutput.property.type"></a>
4718
+
4719
+ ```typescript
4720
+ public readonly type: string;
4721
+ ```
4722
+
4723
+ - *Type:* string
4724
+
4725
+ ---
4726
+
4727
+ #### Constants <a name="Constants" id="Constants"></a>
4728
+
4729
+ | **Name** | **Type** | **Description** |
4730
+ | --- | --- | --- |
4731
+ | <code><a href="#projen-pipelines.CloudFormationOutput.property.TYPE">TYPE</a></code> | <code>string</code> | *No description.* |
4732
+
4733
+ ---
4734
+
4735
+ ##### `TYPE`<sup>Required</sup> <a name="TYPE" id="projen-pipelines.CloudFormationOutput.property.TYPE"></a>
4736
+
4737
+ ```typescript
4738
+ public readonly TYPE: string;
4739
+ ```
4740
+
4741
+ - *Type:* string
4742
+
4743
+ ---
4744
+
4745
+ ### CodeArtifactLoginStep <a name="CodeArtifactLoginStep" id="projen-pipelines.CodeArtifactLoginStep"></a>
4746
+
4747
+ #### Initializers <a name="Initializers" id="projen-pipelines.CodeArtifactLoginStep.Initializer"></a>
4748
+
4749
+ ```typescript
4750
+ import { CodeArtifactLoginStep } from 'projen-pipelines'
4751
+
4752
+ new CodeArtifactLoginStep(project: Project, options: CodeArtifactLoginStepOptions)
4753
+ ```
4754
+
4755
+ | **Name** | **Type** | **Description** |
4756
+ | --- | --- | --- |
4757
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
4758
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.options">options</a></code> | <code><a href="#projen-pipelines.CodeArtifactLoginStepOptions">CodeArtifactLoginStepOptions</a></code> | *No description.* |
4759
+
4760
+ ---
4761
+
4762
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.project"></a>
4763
+
4764
+ - *Type:* projen.Project
4765
+
4766
+ The projen project reference.
4767
+
4768
+ ---
4769
+
4770
+ ##### `options`<sup>Required</sup> <a name="options" id="projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.options"></a>
4771
+
4772
+ - *Type:* <a href="#projen-pipelines.CodeArtifactLoginStepOptions">CodeArtifactLoginStepOptions</a>
4773
+
4774
+ ---
4775
+
4776
+ #### Methods <a name="Methods" id="Methods"></a>
4777
+
4778
+ | **Name** | **Description** |
4779
+ | --- | --- |
4780
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toBash">toBash</a></code> | Converts the sequence of steps into a Bash script configuration. |
4781
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the sequence of steps into a CodeCatalyst Actions step configuration. |
4782
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toGithub">toGithub</a></code> | Converts the sequence of steps into a GitHub Actions step configuration. |
4783
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toGitlab">toGitlab</a></code> | Converts the sequence of steps into a GitLab CI configuration. |
4784
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.addSteps">addSteps</a></code> | *No description.* |
4785
+ | <code><a href="#projen-pipelines.CodeArtifactLoginStep.prependSteps">prependSteps</a></code> | *No description.* |
4786
+
4787
+ ---
4788
+
4789
+ ##### `toBash` <a name="toBash" id="projen-pipelines.CodeArtifactLoginStep.toBash"></a>
4790
+
4791
+ ```typescript
4792
+ public toBash(): BashStepConfig
4793
+ ```
4794
+
4795
+ Converts the sequence of steps into a Bash script configuration.
4796
+
4797
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.CodeArtifactLoginStep.toCodeCatalyst"></a>
4798
+
4799
+ ```typescript
4800
+ public toCodeCatalyst(): CodeCatalystStepConfig
4801
+ ```
4802
+
4803
+ Converts the sequence of steps into a CodeCatalyst Actions step configuration.
4804
+
4805
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.CodeArtifactLoginStep.toGithub"></a>
4806
+
4807
+ ```typescript
4808
+ public toGithub(): GithubStepConfig
4809
+ ```
4810
+
4811
+ Converts the sequence of steps into a GitHub Actions step configuration.
4812
+
4813
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.CodeArtifactLoginStep.toGitlab"></a>
4814
+
4815
+ ```typescript
4816
+ public toGitlab(): GitlabStepConfig
4817
+ ```
4818
+
4819
+ Converts the sequence of steps into a GitLab CI configuration.
4820
+
4821
+ ##### `addSteps` <a name="addSteps" id="projen-pipelines.CodeArtifactLoginStep.addSteps"></a>
4822
+
4823
+ ```typescript
4824
+ public addSteps(steps: ...PipelineStep[]): void
4825
+ ```
4826
+
4827
+ ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.CodeArtifactLoginStep.addSteps.parameter.steps"></a>
4828
+
4829
+ - *Type:* ...<a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
4830
+
4831
+ ---
4832
+
4833
+ ##### `prependSteps` <a name="prependSteps" id="projen-pipelines.CodeArtifactLoginStep.prependSteps"></a>
4834
+
4835
+ ```typescript
4836
+ public prependSteps(steps: ...PipelineStep[]): void
4837
+ ```
4838
+
4839
+ ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.CodeArtifactLoginStep.prependSteps.parameter.steps"></a>
4840
+
4841
+ - *Type:* ...<a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
4842
+
4843
+ ---
4844
+
4845
+
4846
+
4847
+
4848
+ ### CompositeComputation <a name="CompositeComputation" id="projen-pipelines.CompositeComputation"></a>
4849
+
4850
+ Composite version computation that combines multiple strategies.
4851
+
4852
+ #### Initializers <a name="Initializers" id="projen-pipelines.CompositeComputation.Initializer"></a>
4853
+
4854
+ ```typescript
4855
+ import { CompositeComputation } from 'projen-pipelines'
4856
+
4857
+ new CompositeComputation(strategy: VersioningStrategy)
4858
+ ```
4859
+
4860
+ | **Name** | **Type** | **Description** |
4861
+ | --- | --- | --- |
4862
+ | <code><a href="#projen-pipelines.CompositeComputation.Initializer.parameter.strategy">strategy</a></code> | <code><a href="#projen-pipelines.VersioningStrategy">VersioningStrategy</a></code> | *No description.* |
4863
+
4864
+ ---
4865
+
4866
+ ##### `strategy`<sup>Required</sup> <a name="strategy" id="projen-pipelines.CompositeComputation.Initializer.parameter.strategy"></a>
4867
+
4868
+ - *Type:* <a href="#projen-pipelines.VersioningStrategy">VersioningStrategy</a>
4869
+
4870
+ ---
4871
+
4872
+ #### Methods <a name="Methods" id="Methods"></a>
4873
+
4874
+ | **Name** | **Description** |
4875
+ | --- | --- |
4876
+ | <code><a href="#projen-pipelines.CompositeComputation.computeVersion">computeVersion</a></code> | Compute version string from context. |
4877
+ | <code><a href="#projen-pipelines.CompositeComputation.createVersionInfo">createVersionInfo</a></code> | Create VersionInfo from context. |
4878
+
4879
+ ---
4880
+
4881
+ ##### `computeVersion` <a name="computeVersion" id="projen-pipelines.CompositeComputation.computeVersion"></a>
4882
+
4883
+ ```typescript
4884
+ public computeVersion(context: ComputationContext): string
4885
+ ```
4886
+
4887
+ Compute version string from context.
4888
+
4889
+ ###### `context`<sup>Required</sup> <a name="context" id="projen-pipelines.CompositeComputation.computeVersion.parameter.context"></a>
4890
+
4891
+ - *Type:* <a href="#projen-pipelines.ComputationContext">ComputationContext</a>
4892
+
4893
+ ---
4894
+
4895
+ ##### `createVersionInfo` <a name="createVersionInfo" id="projen-pipelines.CompositeComputation.createVersionInfo"></a>
4896
+
4897
+ ```typescript
4898
+ public createVersionInfo(context: ComputationContext): VersionInfo
4899
+ ```
4900
+
4901
+ Create VersionInfo from context.
4902
+
4903
+ ###### `context`<sup>Required</sup> <a name="context" id="projen-pipelines.CompositeComputation.createVersionInfo.parameter.context"></a>
4904
+
4905
+ - *Type:* <a href="#projen-pipelines.ComputationContext">ComputationContext</a>
4906
+
4907
+ ---
4908
+
4909
+
4910
+ #### Properties <a name="Properties" id="Properties"></a>
4911
+
4912
+ | **Name** | **Type** | **Description** |
4913
+ | --- | --- | --- |
4914
+ | <code><a href="#projen-pipelines.CompositeComputation.property.strategy">strategy</a></code> | <code><a href="#projen-pipelines.VersioningStrategy">VersioningStrategy</a></code> | *No description.* |
4915
+
4916
+ ---
4917
+
4918
+ ##### `strategy`<sup>Required</sup> <a name="strategy" id="projen-pipelines.CompositeComputation.property.strategy"></a>
4919
+
4920
+ ```typescript
4921
+ public readonly strategy: VersioningStrategy;
4922
+ ```
4923
+
4924
+ - *Type:* <a href="#projen-pipelines.VersioningStrategy">VersioningStrategy</a>
4925
+
4926
+ ---
4927
+
4928
+
4929
+ ### DownloadArtifactStep <a name="DownloadArtifactStep" id="projen-pipelines.DownloadArtifactStep"></a>
4930
+
4931
+ #### Initializers <a name="Initializers" id="projen-pipelines.DownloadArtifactStep.Initializer"></a>
4932
+
4933
+ ```typescript
4934
+ import { DownloadArtifactStep } from 'projen-pipelines'
4935
+
4936
+ new DownloadArtifactStep(project: Project, config: DownloadArtifactStepConfig)
4937
+ ```
4938
+
4939
+ | **Name** | **Type** | **Description** |
4940
+ | --- | --- | --- |
4941
+ | <code><a href="#projen-pipelines.DownloadArtifactStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
4942
+ | <code><a href="#projen-pipelines.DownloadArtifactStep.Initializer.parameter.config">config</a></code> | <code><a href="#projen-pipelines.DownloadArtifactStepConfig">DownloadArtifactStepConfig</a></code> | *No description.* |
4943
+
4944
+ ---
4945
+
4946
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.DownloadArtifactStep.Initializer.parameter.project"></a>
4947
+
4948
+ - *Type:* projen.Project
4949
+
4950
+ The projen project reference.
4951
+
4952
+ ---
4953
+
4954
+ ##### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.DownloadArtifactStep.Initializer.parameter.config"></a>
4955
+
4956
+ - *Type:* <a href="#projen-pipelines.DownloadArtifactStepConfig">DownloadArtifactStepConfig</a>
4957
+
4958
+ ---
4959
+
4960
+ #### Methods <a name="Methods" id="Methods"></a>
4961
+
4962
+ | **Name** | **Description** |
4963
+ | --- | --- |
4964
+ | <code><a href="#projen-pipelines.DownloadArtifactStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
4965
+ | <code><a href="#projen-pipelines.DownloadArtifactStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the step into a CodeCatalyst Actions step configuration. |
4966
+ | <code><a href="#projen-pipelines.DownloadArtifactStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
4967
+ | <code><a href="#projen-pipelines.DownloadArtifactStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
4968
+
4969
+ ---
4970
+
4971
+ ##### `toBash` <a name="toBash" id="projen-pipelines.DownloadArtifactStep.toBash"></a>
4972
+
4973
+ ```typescript
4974
+ public toBash(): BashStepConfig
4975
+ ```
4976
+
4977
+ Generates a configuration for a bash script step.
4978
+
4979
+ Should be implemented by subclasses.
4980
+
4981
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.DownloadArtifactStep.toCodeCatalyst"></a>
4982
+
4983
+ ```typescript
4984
+ public toCodeCatalyst(): CodeCatalystStepConfig
4985
+ ```
4986
+
4987
+ Converts the step into a CodeCatalyst Actions step configuration.
4988
+
4989
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.DownloadArtifactStep.toGithub"></a>
4990
+
4991
+ ```typescript
4992
+ public toGithub(): GithubStepConfig
4993
+ ```
4994
+
4995
+ Generates a configuration for a GitHub Actions step.
4996
+
4997
+ Should be implemented by subclasses.
4998
+
4999
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.DownloadArtifactStep.toGitlab"></a>
5000
+
5001
+ ```typescript
5002
+ public toGitlab(): GitlabStepConfig
5003
+ ```
5004
+
5005
+ Generates a configuration for a GitLab CI step.
5006
+
5007
+ Should be implemented by subclasses.
5008
+
5009
+
5010
+
5011
+
5012
+ ### GithubPackagesLoginStep <a name="GithubPackagesLoginStep" id="projen-pipelines.GithubPackagesLoginStep"></a>
5013
+
5014
+ #### Initializers <a name="Initializers" id="projen-pipelines.GithubPackagesLoginStep.Initializer"></a>
5015
+
5016
+ ```typescript
5017
+ import { GithubPackagesLoginStep } from 'projen-pipelines'
5018
+
5019
+ new GithubPackagesLoginStep(project: Project, options: GithubPackagesLoginStepOptions)
5020
+ ```
5021
+
5022
+ | **Name** | **Type** | **Description** |
5023
+ | --- | --- | --- |
5024
+ | <code><a href="#projen-pipelines.GithubPackagesLoginStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
5025
+ | <code><a href="#projen-pipelines.GithubPackagesLoginStep.Initializer.parameter.options">options</a></code> | <code><a href="#projen-pipelines.GithubPackagesLoginStepOptions">GithubPackagesLoginStepOptions</a></code> | *No description.* |
5026
+
5027
+ ---
5028
+
5029
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.GithubPackagesLoginStep.Initializer.parameter.project"></a>
5030
+
5031
+ - *Type:* projen.Project
5032
+
5033
+ The projen project reference.
5034
+
5035
+ ---
5036
+
5037
+ ##### `options`<sup>Required</sup> <a name="options" id="projen-pipelines.GithubPackagesLoginStep.Initializer.parameter.options"></a>
5038
+
5039
+ - *Type:* <a href="#projen-pipelines.GithubPackagesLoginStepOptions">GithubPackagesLoginStepOptions</a>
5040
+
5041
+ ---
5042
+
5043
+ #### Methods <a name="Methods" id="Methods"></a>
5044
+
5045
+ | **Name** | **Description** |
5046
+ | --- | --- |
5047
+ | <code><a href="#projen-pipelines.GithubPackagesLoginStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
5048
+ | <code><a href="#projen-pipelines.GithubPackagesLoginStep.toCodeCatalyst">toCodeCatalyst</a></code> | Generates a configuration for a CodeCatalyst Actions step. |
5049
+ | <code><a href="#projen-pipelines.GithubPackagesLoginStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
5050
+ | <code><a href="#projen-pipelines.GithubPackagesLoginStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
5051
+
5052
+ ---
5053
+
5054
+ ##### `toBash` <a name="toBash" id="projen-pipelines.GithubPackagesLoginStep.toBash"></a>
5055
+
5056
+ ```typescript
5057
+ public toBash(): BashStepConfig
5058
+ ```
5059
+
5060
+ Generates a configuration for a bash script step.
5061
+
5062
+ Should be implemented by subclasses.
5063
+
5064
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.GithubPackagesLoginStep.toCodeCatalyst"></a>
5065
+
5066
+ ```typescript
5067
+ public toCodeCatalyst(): CodeCatalystStepConfig
5068
+ ```
5069
+
5070
+ Generates a configuration for a CodeCatalyst Actions step.
5071
+
5072
+ Should be implemented by subclasses.
5073
+
5074
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.GithubPackagesLoginStep.toGithub"></a>
5075
+
5076
+ ```typescript
5077
+ public toGithub(): GithubStepConfig
5078
+ ```
5079
+
5080
+ Generates a configuration for a GitHub Actions step.
5081
+
5082
+ Should be implemented by subclasses.
5083
+
5084
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.GithubPackagesLoginStep.toGitlab"></a>
5085
+
5086
+ ```typescript
5087
+ public toGitlab(): GitlabStepConfig
5088
+ ```
5089
+
5090
+ Generates a configuration for a GitLab CI step.
5091
+
5092
+ Should be implemented by subclasses.
5093
+
5094
+
5095
+
5096
+
5097
+ ### OutputConfigBase <a name="OutputConfigBase" id="projen-pipelines.OutputConfigBase"></a>
5098
+
5099
+ Base class for output configurations.
5100
+
5101
+ #### Initializers <a name="Initializers" id="projen-pipelines.OutputConfigBase.Initializer"></a>
5102
+
5103
+ ```typescript
5104
+ import { OutputConfigBase } from 'projen-pipelines'
5105
+
5106
+ new OutputConfigBase(type: string)
5107
+ ```
5108
+
5109
+ | **Name** | **Type** | **Description** |
5110
+ | --- | --- | --- |
5111
+ | <code><a href="#projen-pipelines.OutputConfigBase.Initializer.parameter.type">type</a></code> | <code>string</code> | *No description.* |
5112
+
5113
+ ---
5114
+
5115
+ ##### `type`<sup>Required</sup> <a name="type" id="projen-pipelines.OutputConfigBase.Initializer.parameter.type"></a>
5116
+
5117
+ - *Type:* string
5118
+
5119
+ ---
5120
+
5121
+ #### Methods <a name="Methods" id="Methods"></a>
5122
+
5123
+ | **Name** | **Description** |
5124
+ | --- | --- |
5125
+ | <code><a href="#projen-pipelines.OutputConfigBase.toConfig">toConfig</a></code> | Convert to configuration object. |
5126
+
5127
+ ---
5128
+
5129
+ ##### `toConfig` <a name="toConfig" id="projen-pipelines.OutputConfigBase.toConfig"></a>
5130
+
5131
+ ```typescript
5132
+ public toConfig(): any
5133
+ ```
5134
+
5135
+ Convert to configuration object.
5136
+
5137
+
5138
+ #### Properties <a name="Properties" id="Properties"></a>
5139
+
5140
+ | **Name** | **Type** | **Description** |
5141
+ | --- | --- | --- |
5142
+ | <code><a href="#projen-pipelines.OutputConfigBase.property.type">type</a></code> | <code>string</code> | *No description.* |
5143
+
5144
+ ---
5145
+
5146
+ ##### `type`<sup>Required</sup> <a name="type" id="projen-pipelines.OutputConfigBase.property.type"></a>
5147
+
5148
+ ```typescript
5149
+ public readonly type: string;
5150
+ ```
5151
+
5152
+ - *Type:* string
5153
+
5154
+ ---
5155
+
5156
+
5157
+ ### OutputFormat <a name="OutputFormat" id="projen-pipelines.OutputFormat"></a>
5158
+
5159
+ Output format types.
5160
+
5161
+
5162
+
5163
+
5164
+ #### Constants <a name="Constants" id="Constants"></a>
5165
+
5166
+ | **Name** | **Type** | **Description** |
5167
+ | --- | --- | --- |
5168
+ | <code><a href="#projen-pipelines.OutputFormat.property.PLAIN">PLAIN</a></code> | <code>string</code> | *No description.* |
5169
+ | <code><a href="#projen-pipelines.OutputFormat.property.STRUCTURED">STRUCTURED</a></code> | <code>string</code> | *No description.* |
5170
+
5171
+ ---
5172
+
5173
+ ##### `PLAIN`<sup>Required</sup> <a name="PLAIN" id="projen-pipelines.OutputFormat.property.PLAIN"></a>
5174
+
5175
+ ```typescript
5176
+ public readonly PLAIN: string;
5177
+ ```
5178
+
5179
+ - *Type:* string
5180
+
5181
+ ---
5182
+
5183
+ ##### `STRUCTURED`<sup>Required</sup> <a name="STRUCTURED" id="projen-pipelines.OutputFormat.property.STRUCTURED"></a>
5184
+
5185
+ ```typescript
5186
+ public readonly STRUCTURED: string;
5187
+ ```
5188
+
5189
+ - *Type:* string
5190
+
5191
+ ---
5192
+
5193
+ ### ParameterStoreOutput <a name="ParameterStoreOutput" id="projen-pipelines.ParameterStoreOutput"></a>
5194
+
5195
+ SSM Parameter Store output configuration.
5196
+
5197
+ #### Methods <a name="Methods" id="Methods"></a>
5198
+
5199
+ | **Name** | **Description** |
5200
+ | --- | --- |
5201
+ | <code><a href="#projen-pipelines.ParameterStoreOutput.toConfig">toConfig</a></code> | Convert to configuration object. |
5202
+
5203
+ ---
5204
+
5205
+ ##### `toConfig` <a name="toConfig" id="projen-pipelines.ParameterStoreOutput.toConfig"></a>
5206
+
5207
+ ```typescript
5208
+ public toConfig(): any
5209
+ ```
5210
+
5211
+ Convert to configuration object.
5212
+
5213
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
5214
+
5215
+ | **Name** | **Description** |
5216
+ | --- | --- |
5217
+ | <code><a href="#projen-pipelines.ParameterStoreOutput.disabled">disabled</a></code> | Disable Parameter Store outputs. |
5218
+ | <code><a href="#projen-pipelines.ParameterStoreOutput.enabled">enabled</a></code> | Enable Parameter Store outputs with parameter name. |
5219
+ | <code><a href="#projen-pipelines.ParameterStoreOutput.hierarchical">hierarchical</a></code> | Configure Parameter Store with hierarchical parameters. |
5220
+ | <code><a href="#projen-pipelines.ParameterStoreOutput.withConfig">withConfig</a></code> | Configure Parameter Store outputs with custom settings. |
5221
+
5222
+ ---
5223
+
5224
+ ##### `disabled` <a name="disabled" id="projen-pipelines.ParameterStoreOutput.disabled"></a>
5225
+
5226
+ ```typescript
5227
+ import { ParameterStoreOutput } from 'projen-pipelines'
5228
+
5229
+ ParameterStoreOutput.disabled()
5230
+ ```
5231
+
5232
+ Disable Parameter Store outputs.
5233
+
5234
+ ##### `enabled` <a name="enabled" id="projen-pipelines.ParameterStoreOutput.enabled"></a>
5235
+
5236
+ ```typescript
5237
+ import { ParameterStoreOutput } from 'projen-pipelines'
5238
+
5239
+ ParameterStoreOutput.enabled(parameterName: string)
5240
+ ```
5241
+
5242
+ Enable Parameter Store outputs with parameter name.
5243
+
5244
+ ###### `parameterName`<sup>Required</sup> <a name="parameterName" id="projen-pipelines.ParameterStoreOutput.enabled.parameter.parameterName"></a>
5245
+
5246
+ - *Type:* string
5247
+
5248
+ ---
5249
+
5250
+ ##### `hierarchical` <a name="hierarchical" id="projen-pipelines.ParameterStoreOutput.hierarchical"></a>
5251
+
5252
+ ```typescript
5253
+ import { ParameterStoreOutput } from 'projen-pipelines'
5254
+
5255
+ ParameterStoreOutput.hierarchical(basePath: string, options?: HierarchicalParametersOptions)
5256
+ ```
5257
+
5258
+ Configure Parameter Store with hierarchical parameters.
5259
+
5260
+ ###### `basePath`<sup>Required</sup> <a name="basePath" id="projen-pipelines.ParameterStoreOutput.hierarchical.parameter.basePath"></a>
5261
+
5262
+ - *Type:* string
5263
+
5264
+ ---
5265
+
5266
+ ###### `options`<sup>Optional</sup> <a name="options" id="projen-pipelines.ParameterStoreOutput.hierarchical.parameter.options"></a>
5267
+
5268
+ - *Type:* <a href="#projen-pipelines.HierarchicalParametersOptions">HierarchicalParametersOptions</a>
5269
+
5270
+ ---
5271
+
5272
+ ##### `withConfig` <a name="withConfig" id="projen-pipelines.ParameterStoreOutput.withConfig"></a>
5273
+
5274
+ ```typescript
5275
+ import { ParameterStoreOutput } from 'projen-pipelines'
5276
+
5277
+ ParameterStoreOutput.withConfig(config: ParameterStoreConfig)
5278
+ ```
5279
+
5280
+ Configure Parameter Store outputs with custom settings.
5281
+
5282
+ ###### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.ParameterStoreOutput.withConfig.parameter.config"></a>
5283
+
5284
+ - *Type:* <a href="#projen-pipelines.ParameterStoreConfig">ParameterStoreConfig</a>
5285
+
5286
+ ---
5287
+
5288
+ #### Properties <a name="Properties" id="Properties"></a>
5289
+
5290
+ | **Name** | **Type** | **Description** |
5291
+ | --- | --- | --- |
5292
+ | <code><a href="#projen-pipelines.ParameterStoreOutput.property.type">type</a></code> | <code>string</code> | *No description.* |
5293
+
5294
+ ---
5295
+
5296
+ ##### `type`<sup>Required</sup> <a name="type" id="projen-pipelines.ParameterStoreOutput.property.type"></a>
5297
+
5298
+ ```typescript
5299
+ public readonly type: string;
5300
+ ```
5301
+
5302
+ - *Type:* string
5303
+
5304
+ ---
5305
+
5306
+ #### Constants <a name="Constants" id="Constants"></a>
5307
+
5308
+ | **Name** | **Type** | **Description** |
5309
+ | --- | --- | --- |
5310
+ | <code><a href="#projen-pipelines.ParameterStoreOutput.property.TYPE">TYPE</a></code> | <code>string</code> | *No description.* |
5311
+
5312
+ ---
5313
+
5314
+ ##### `TYPE`<sup>Required</sup> <a name="TYPE" id="projen-pipelines.ParameterStoreOutput.property.TYPE"></a>
5315
+
5316
+ ```typescript
5317
+ public readonly TYPE: string;
5318
+ ```
5319
+
5320
+ - *Type:* string
5321
+
5322
+ ---
5323
+
5324
+ ### PipelineStep <a name="PipelineStep" id="projen-pipelines.PipelineStep"></a>
5325
+
5326
+ Abstract class defining the structure of a pipeline step.
5327
+
5328
+ #### Initializers <a name="Initializers" id="projen-pipelines.PipelineStep.Initializer"></a>
5329
+
5330
+ ```typescript
5331
+ import { PipelineStep } from 'projen-pipelines'
5332
+
5333
+ new PipelineStep(project: Project)
5334
+ ```
5335
+
5336
+ | **Name** | **Type** | **Description** |
5337
+ | --- | --- | --- |
5338
+ | <code><a href="#projen-pipelines.PipelineStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
5339
+
5340
+ ---
5341
+
5342
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.PipelineStep.Initializer.parameter.project"></a>
5343
+
5344
+ - *Type:* projen.Project
5345
+
5346
+ The projen project reference.
5347
+
5348
+ ---
5349
+
5350
+ #### Methods <a name="Methods" id="Methods"></a>
5351
+
5352
+ | **Name** | **Description** |
5353
+ | --- | --- |
5354
+ | <code><a href="#projen-pipelines.PipelineStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
5355
+ | <code><a href="#projen-pipelines.PipelineStep.toCodeCatalyst">toCodeCatalyst</a></code> | Generates a configuration for a CodeCatalyst Actions step. |
5356
+ | <code><a href="#projen-pipelines.PipelineStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
5357
+ | <code><a href="#projen-pipelines.PipelineStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
5358
+
5359
+ ---
5360
+
5361
+ ##### `toBash` <a name="toBash" id="projen-pipelines.PipelineStep.toBash"></a>
5362
+
5363
+ ```typescript
5364
+ public toBash(): BashStepConfig
5365
+ ```
5366
+
5367
+ Generates a configuration for a bash script step.
5368
+
5369
+ Should be implemented by subclasses.
5370
+
5371
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.PipelineStep.toCodeCatalyst"></a>
5372
+
5373
+ ```typescript
5374
+ public toCodeCatalyst(): CodeCatalystStepConfig
5375
+ ```
5376
+
5377
+ Generates a configuration for a CodeCatalyst Actions step.
5378
+
5379
+ Should be implemented by subclasses.
5380
+
5381
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.PipelineStep.toGithub"></a>
5382
+
5383
+ ```typescript
5384
+ public toGithub(): GithubStepConfig
5385
+ ```
5386
+
5387
+ Generates a configuration for a GitHub Actions step.
5388
+
5389
+ Should be implemented by subclasses.
5390
+
5391
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.PipelineStep.toGitlab"></a>
5392
+
5393
+ ```typescript
5394
+ public toGitlab(): GitlabStepConfig
5395
+ ```
5396
+
5397
+ Generates a configuration for a GitLab CI step.
5398
+
5399
+ Should be implemented by subclasses.
5400
+
5401
+
5402
+
5403
+
5404
+ ### ProjenScriptStep <a name="ProjenScriptStep" id="projen-pipelines.ProjenScriptStep"></a>
5405
+
5406
+ #### Initializers <a name="Initializers" id="projen-pipelines.ProjenScriptStep.Initializer"></a>
5407
+
5408
+ ```typescript
5409
+ import { ProjenScriptStep } from 'projen-pipelines'
5410
+
5411
+ new ProjenScriptStep(project: Project, scriptName: string, args?: string)
5412
+ ```
5413
+
5414
+ | **Name** | **Type** | **Description** |
5415
+ | --- | --- | --- |
5416
+ | <code><a href="#projen-pipelines.ProjenScriptStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
5417
+ | <code><a href="#projen-pipelines.ProjenScriptStep.Initializer.parameter.scriptName">scriptName</a></code> | <code>string</code> | *No description.* |
5418
+ | <code><a href="#projen-pipelines.ProjenScriptStep.Initializer.parameter.args">args</a></code> | <code>string</code> | *No description.* |
5419
+
5420
+ ---
5421
+
5422
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.ProjenScriptStep.Initializer.parameter.project"></a>
5423
+
5424
+ - *Type:* projen.Project
5425
+
5426
+ The projen project reference.
5427
+
5428
+ ---
5429
+
5430
+ ##### `scriptName`<sup>Required</sup> <a name="scriptName" id="projen-pipelines.ProjenScriptStep.Initializer.parameter.scriptName"></a>
5431
+
5432
+ - *Type:* string
5433
+
5434
+ ---
5435
+
5436
+ ##### `args`<sup>Optional</sup> <a name="args" id="projen-pipelines.ProjenScriptStep.Initializer.parameter.args"></a>
5437
+
5438
+ - *Type:* string
5439
+
5440
+ ---
5441
+
5442
+ #### Methods <a name="Methods" id="Methods"></a>
5443
+
5444
+ | **Name** | **Description** |
5445
+ | --- | --- |
5446
+ | <code><a href="#projen-pipelines.ProjenScriptStep.toBash">toBash</a></code> | Converts the step into a Bash script configuration. |
5447
+ | <code><a href="#projen-pipelines.ProjenScriptStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the step into a CodeCatalyst Actions step configuration. |
5448
+ | <code><a href="#projen-pipelines.ProjenScriptStep.toGithub">toGithub</a></code> | Converts the step into a GitHub Actions step configuration. |
5449
+ | <code><a href="#projen-pipelines.ProjenScriptStep.toGitlab">toGitlab</a></code> | Converts the step into a GitLab CI configuration. |
5450
+
5451
+ ---
5452
+
5453
+ ##### `toBash` <a name="toBash" id="projen-pipelines.ProjenScriptStep.toBash"></a>
5454
+
5455
+ ```typescript
5456
+ public toBash(): BashStepConfig
5457
+ ```
5458
+
5459
+ Converts the step into a Bash script configuration.
5460
+
5461
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.ProjenScriptStep.toCodeCatalyst"></a>
5462
+
5463
+ ```typescript
5464
+ public toCodeCatalyst(): CodeCatalystStepConfig
5465
+ ```
5466
+
5467
+ Converts the step into a CodeCatalyst Actions step configuration.
5468
+
5469
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.ProjenScriptStep.toGithub"></a>
5470
+
5471
+ ```typescript
5472
+ public toGithub(): GithubStepConfig
5473
+ ```
5474
+
5475
+ Converts the step into a GitHub Actions step configuration.
5476
+
5477
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.ProjenScriptStep.toGitlab"></a>
5478
+
5479
+ ```typescript
5480
+ public toGitlab(): GitlabStepConfig
5481
+ ```
5482
+
5483
+ Converts the step into a GitLab CI configuration.
5484
+
5485
+
5486
+
5487
+
5488
+ ### SimpleCommandStep <a name="SimpleCommandStep" id="projen-pipelines.SimpleCommandStep"></a>
5489
+
5490
+ Concrete implementation of PipelineStep that executes simple commands.
5491
+
5492
+ #### Initializers <a name="Initializers" id="projen-pipelines.SimpleCommandStep.Initializer"></a>
5493
+
5494
+ ```typescript
5495
+ import { SimpleCommandStep } from 'projen-pipelines'
5496
+
5497
+ new SimpleCommandStep(project: Project, commands: string[])
5498
+ ```
5499
+
5500
+ | **Name** | **Type** | **Description** |
5501
+ | --- | --- | --- |
5502
+ | <code><a href="#projen-pipelines.SimpleCommandStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
5503
+ | <code><a href="#projen-pipelines.SimpleCommandStep.Initializer.parameter.commands">commands</a></code> | <code>string[]</code> | - Shell commands to execute. |
5504
+
5505
+ ---
5506
+
5507
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.SimpleCommandStep.Initializer.parameter.project"></a>
5508
+
5509
+ - *Type:* projen.Project
5510
+
5511
+ The projen project reference.
5512
+
5513
+ ---
5514
+
5515
+ ##### `commands`<sup>Required</sup> <a name="commands" id="projen-pipelines.SimpleCommandStep.Initializer.parameter.commands"></a>
5516
+
5517
+ - *Type:* string[]
5518
+
5519
+ Shell commands to execute.
5520
+
5521
+ ---
5522
+
5523
+ #### Methods <a name="Methods" id="Methods"></a>
5524
+
5525
+ | **Name** | **Description** |
5526
+ | --- | --- |
5527
+ | <code><a href="#projen-pipelines.SimpleCommandStep.toBash">toBash</a></code> | Converts the step into a Bash script configuration. |
5528
+ | <code><a href="#projen-pipelines.SimpleCommandStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the step into a CodeCatalyst Actions step configuration. |
5529
+ | <code><a href="#projen-pipelines.SimpleCommandStep.toGithub">toGithub</a></code> | Converts the step into a GitHub Actions step configuration. |
5530
+ | <code><a href="#projen-pipelines.SimpleCommandStep.toGitlab">toGitlab</a></code> | Converts the step into a GitLab CI configuration. |
5531
+
5532
+ ---
5533
+
5534
+ ##### `toBash` <a name="toBash" id="projen-pipelines.SimpleCommandStep.toBash"></a>
5535
+
5536
+ ```typescript
5537
+ public toBash(): BashStepConfig
5538
+ ```
5539
+
5540
+ Converts the step into a Bash script configuration.
5541
+
5542
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.SimpleCommandStep.toCodeCatalyst"></a>
5543
+
5544
+ ```typescript
5545
+ public toCodeCatalyst(): CodeCatalystStepConfig
5546
+ ```
5547
+
5548
+ Converts the step into a CodeCatalyst Actions step configuration.
5549
+
5550
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.SimpleCommandStep.toGithub"></a>
5551
+
5552
+ ```typescript
5553
+ public toGithub(): GithubStepConfig
5554
+ ```
5555
+
5556
+ Converts the step into a GitHub Actions step configuration.
5557
+
5558
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.SimpleCommandStep.toGitlab"></a>
5559
+
5560
+ ```typescript
5561
+ public toGitlab(): GitlabStepConfig
5562
+ ```
5563
+
5564
+ Converts the step into a GitLab CI configuration.
5565
+
5566
+
5567
+
5568
+
5569
+ ### StepSequence <a name="StepSequence" id="projen-pipelines.StepSequence"></a>
5570
+
5571
+ #### Initializers <a name="Initializers" id="projen-pipelines.StepSequence.Initializer"></a>
5572
+
5573
+ ```typescript
5574
+ import { StepSequence } from 'projen-pipelines'
5575
+
5576
+ new StepSequence(project: Project, steps: PipelineStep[])
5577
+ ```
5578
+
5579
+ | **Name** | **Type** | **Description** |
5580
+ | --- | --- | --- |
5581
+ | <code><a href="#projen-pipelines.StepSequence.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
5582
+ | <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. |
5583
+
5584
+ ---
5585
+
5586
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.StepSequence.Initializer.parameter.project"></a>
5587
+
5588
+ - *Type:* projen.Project
5589
+
5590
+ The projen project reference.
5591
+
5592
+ ---
5593
+
5594
+ ##### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.StepSequence.Initializer.parameter.steps"></a>
5595
+
5596
+ - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
5597
+
5598
+ The sequence of pipeline steps.
5599
+
5600
+ ---
5601
+
5602
+ #### Methods <a name="Methods" id="Methods"></a>
5603
+
5604
+ | **Name** | **Description** |
5605
+ | --- | --- |
5606
+ | <code><a href="#projen-pipelines.StepSequence.toBash">toBash</a></code> | Converts the sequence of steps into a Bash script configuration. |
5607
+ | <code><a href="#projen-pipelines.StepSequence.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the sequence of steps into a CodeCatalyst Actions step configuration. |
5608
+ | <code><a href="#projen-pipelines.StepSequence.toGithub">toGithub</a></code> | Converts the sequence of steps into a GitHub Actions step configuration. |
5609
+ | <code><a href="#projen-pipelines.StepSequence.toGitlab">toGitlab</a></code> | Converts the sequence of steps into a GitLab CI configuration. |
5610
+ | <code><a href="#projen-pipelines.StepSequence.addSteps">addSteps</a></code> | *No description.* |
5611
+ | <code><a href="#projen-pipelines.StepSequence.prependSteps">prependSteps</a></code> | *No description.* |
5612
+
5613
+ ---
5614
+
5615
+ ##### `toBash` <a name="toBash" id="projen-pipelines.StepSequence.toBash"></a>
5616
+
5617
+ ```typescript
5618
+ public toBash(): BashStepConfig
5619
+ ```
5620
+
5621
+ Converts the sequence of steps into a Bash script configuration.
5622
+
5623
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.StepSequence.toCodeCatalyst"></a>
5624
+
5625
+ ```typescript
5626
+ public toCodeCatalyst(): CodeCatalystStepConfig
5627
+ ```
5628
+
5629
+ Converts the sequence of steps into a CodeCatalyst Actions step configuration.
5630
+
5631
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.StepSequence.toGithub"></a>
5632
+
5633
+ ```typescript
5634
+ public toGithub(): GithubStepConfig
5635
+ ```
5636
+
5637
+ Converts the sequence of steps into a GitHub Actions step configuration.
5638
+
5639
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.StepSequence.toGitlab"></a>
5640
+
5641
+ ```typescript
5642
+ public toGitlab(): GitlabStepConfig
5643
+ ```
5644
+
5645
+ Converts the sequence of steps into a GitLab CI configuration.
5646
+
5647
+ ##### `addSteps` <a name="addSteps" id="projen-pipelines.StepSequence.addSteps"></a>
5648
+
5649
+ ```typescript
5650
+ public addSteps(steps: ...PipelineStep[]): void
5651
+ ```
5652
+
5653
+ ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.StepSequence.addSteps.parameter.steps"></a>
5654
+
5655
+ - *Type:* ...<a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
5656
+
5657
+ ---
5658
+
5659
+ ##### `prependSteps` <a name="prependSteps" id="projen-pipelines.StepSequence.prependSteps"></a>
5660
+
5661
+ ```typescript
5662
+ public prependSteps(steps: ...PipelineStep[]): void
5663
+ ```
5664
+
5665
+ ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.StepSequence.prependSteps.parameter.steps"></a>
5666
+
5667
+ - *Type:* ...<a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
5668
+
5669
+ ---
5670
+
5671
+
5672
+
5673
+
5674
+ ### UploadArtifactStep <a name="UploadArtifactStep" id="projen-pipelines.UploadArtifactStep"></a>
5675
+
5676
+ #### Initializers <a name="Initializers" id="projen-pipelines.UploadArtifactStep.Initializer"></a>
5677
+
5678
+ ```typescript
5679
+ import { UploadArtifactStep } from 'projen-pipelines'
5680
+
5681
+ new UploadArtifactStep(project: Project, config: UploadArtifactStepConfig)
5682
+ ```
5683
+
5684
+ | **Name** | **Type** | **Description** |
5685
+ | --- | --- | --- |
5686
+ | <code><a href="#projen-pipelines.UploadArtifactStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
5687
+ | <code><a href="#projen-pipelines.UploadArtifactStep.Initializer.parameter.config">config</a></code> | <code><a href="#projen-pipelines.UploadArtifactStepConfig">UploadArtifactStepConfig</a></code> | *No description.* |
5688
+
5689
+ ---
5690
+
5691
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.UploadArtifactStep.Initializer.parameter.project"></a>
5692
+
5693
+ - *Type:* projen.Project
5694
+
5695
+ The projen project reference.
5696
+
5697
+ ---
5698
+
5699
+ ##### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.UploadArtifactStep.Initializer.parameter.config"></a>
5700
+
5701
+ - *Type:* <a href="#projen-pipelines.UploadArtifactStepConfig">UploadArtifactStepConfig</a>
5702
+
5703
+ ---
5704
+
5705
+ #### Methods <a name="Methods" id="Methods"></a>
5706
+
5707
+ | **Name** | **Description** |
5708
+ | --- | --- |
5709
+ | <code><a href="#projen-pipelines.UploadArtifactStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
5710
+ | <code><a href="#projen-pipelines.UploadArtifactStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the step into a CodeCatalyst Actions step configuration. |
5711
+ | <code><a href="#projen-pipelines.UploadArtifactStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
5712
+ | <code><a href="#projen-pipelines.UploadArtifactStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
5713
+
5714
+ ---
5715
+
5716
+ ##### `toBash` <a name="toBash" id="projen-pipelines.UploadArtifactStep.toBash"></a>
5717
+
5718
+ ```typescript
5719
+ public toBash(): BashStepConfig
5720
+ ```
5721
+
5722
+ Generates a configuration for a bash script step.
5723
+
5724
+ Should be implemented by subclasses.
5725
+
5726
+ ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.UploadArtifactStep.toCodeCatalyst"></a>
5727
+
5728
+ ```typescript
5729
+ public toCodeCatalyst(): CodeCatalystStepConfig
5730
+ ```
5731
+
5732
+ Converts the step into a CodeCatalyst Actions step configuration.
5733
+
5734
+ ##### `toGithub` <a name="toGithub" id="projen-pipelines.UploadArtifactStep.toGithub"></a>
5735
+
5736
+ ```typescript
5737
+ public toGithub(): GithubStepConfig
5738
+ ```
5739
+
5740
+ Generates a configuration for a GitHub Actions step.
5741
+
5742
+ Should be implemented by subclasses.
5743
+
5744
+ ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.UploadArtifactStep.toGitlab"></a>
5745
+
5746
+ ```typescript
5747
+ public toGitlab(): GitlabStepConfig
5748
+ ```
5749
+
5750
+ Generates a configuration for a GitLab CI step.
5751
+
5752
+ Should be implemented by subclasses.
5753
+
5754
+
5755
+
5756
+
5757
+ ### VersionComputationStrategy <a name="VersionComputationStrategy" id="projen-pipelines.VersionComputationStrategy"></a>
5758
+
5759
+ Base class for version computation strategies.
5760
+
5761
+ #### Initializers <a name="Initializers" id="projen-pipelines.VersionComputationStrategy.Initializer"></a>
5762
+
5763
+ ```typescript
5764
+ import { VersionComputationStrategy } from 'projen-pipelines'
5765
+
5766
+ new VersionComputationStrategy(strategy: VersioningStrategy)
5767
+ ```
5768
+
5769
+ | **Name** | **Type** | **Description** |
5770
+ | --- | --- | --- |
5771
+ | <code><a href="#projen-pipelines.VersionComputationStrategy.Initializer.parameter.strategy">strategy</a></code> | <code><a href="#projen-pipelines.VersioningStrategy">VersioningStrategy</a></code> | *No description.* |
5772
+
3307
5773
  ---
3308
5774
 
3309
- ##### `path`<sup>Required</sup> <a name="path" id="projen-pipelines.UploadArtifactStepConfig.property.path"></a>
5775
+ ##### `strategy`<sup>Required</sup> <a name="strategy" id="projen-pipelines.VersionComputationStrategy.Initializer.parameter.strategy"></a>
5776
+
5777
+ - *Type:* <a href="#projen-pipelines.VersioningStrategy">VersioningStrategy</a>
5778
+
5779
+ ---
5780
+
5781
+ #### Methods <a name="Methods" id="Methods"></a>
5782
+
5783
+ | **Name** | **Description** |
5784
+ | --- | --- |
5785
+ | <code><a href="#projen-pipelines.VersionComputationStrategy.computeVersion">computeVersion</a></code> | Compute version string from context. |
5786
+ | <code><a href="#projen-pipelines.VersionComputationStrategy.createVersionInfo">createVersionInfo</a></code> | Create VersionInfo from context. |
5787
+
5788
+ ---
5789
+
5790
+ ##### `computeVersion` <a name="computeVersion" id="projen-pipelines.VersionComputationStrategy.computeVersion"></a>
3310
5791
 
3311
5792
  ```typescript
3312
- public readonly path: string;
5793
+ public computeVersion(context: ComputationContext): string
3313
5794
  ```
3314
5795
 
3315
- - *Type:* string
5796
+ Compute version string from context.
5797
+
5798
+ ###### `context`<sup>Required</sup> <a name="context" id="projen-pipelines.VersionComputationStrategy.computeVersion.parameter.context"></a>
5799
+
5800
+ - *Type:* <a href="#projen-pipelines.ComputationContext">ComputationContext</a>
3316
5801
 
3317
5802
  ---
3318
5803
 
3319
- ## Classes <a name="Classes" id="Classes"></a>
5804
+ ##### `createVersionInfo` <a name="createVersionInfo" id="projen-pipelines.VersionComputationStrategy.createVersionInfo"></a>
3320
5805
 
3321
- ### AwsAssumeRoleStep <a name="AwsAssumeRoleStep" id="projen-pipelines.AwsAssumeRoleStep"></a>
5806
+ ```typescript
5807
+ public createVersionInfo(context: ComputationContext): VersionInfo
5808
+ ```
3322
5809
 
3323
- A step that assumes a role in AWS.
5810
+ Create VersionInfo from context.
5811
+
5812
+ ###### `context`<sup>Required</sup> <a name="context" id="projen-pipelines.VersionComputationStrategy.createVersionInfo.parameter.context"></a>
5813
+
5814
+ - *Type:* <a href="#projen-pipelines.ComputationContext">ComputationContext</a>
5815
+
5816
+ ---
3324
5817
 
3325
- #### Initializers <a name="Initializers" id="projen-pipelines.AwsAssumeRoleStep.Initializer"></a>
5818
+
5819
+ #### Properties <a name="Properties" id="Properties"></a>
5820
+
5821
+ | **Name** | **Type** | **Description** |
5822
+ | --- | --- | --- |
5823
+ | <code><a href="#projen-pipelines.VersionComputationStrategy.property.strategy">strategy</a></code> | <code><a href="#projen-pipelines.VersioningStrategy">VersioningStrategy</a></code> | *No description.* |
5824
+
5825
+ ---
5826
+
5827
+ ##### `strategy`<sup>Required</sup> <a name="strategy" id="projen-pipelines.VersionComputationStrategy.property.strategy"></a>
3326
5828
 
3327
5829
  ```typescript
3328
- import { AwsAssumeRoleStep } from 'projen-pipelines'
5830
+ public readonly strategy: VersioningStrategy;
5831
+ ```
3329
5832
 
3330
- new AwsAssumeRoleStep(project: Project, config: AwsAssumeRoleStepConfig)
5833
+ - *Type:* <a href="#projen-pipelines.VersioningStrategy">VersioningStrategy</a>
5834
+
5835
+ ---
5836
+
5837
+
5838
+ ### VersionComputer <a name="VersionComputer" id="projen-pipelines.VersionComputer"></a>
5839
+
5840
+ Main version computer that handles strategy selection.
5841
+
5842
+ #### Initializers <a name="Initializers" id="projen-pipelines.VersionComputer.Initializer"></a>
5843
+
5844
+ ```typescript
5845
+ import { VersionComputer } from 'projen-pipelines'
5846
+
5847
+ new VersionComputer(strategy: IVersioningStrategy)
3331
5848
  ```
3332
5849
 
3333
5850
  | **Name** | **Type** | **Description** |
3334
5851
  | --- | --- | --- |
3335
- | <code><a href="#projen-pipelines.AwsAssumeRoleStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3336
- | <code><a href="#projen-pipelines.AwsAssumeRoleStep.Initializer.parameter.config">config</a></code> | <code><a href="#projen-pipelines.AwsAssumeRoleStepConfig">AwsAssumeRoleStepConfig</a></code> | *No description.* |
5852
+ | <code><a href="#projen-pipelines.VersionComputer.Initializer.parameter.strategy">strategy</a></code> | <code><a href="#projen-pipelines.IVersioningStrategy">IVersioningStrategy</a></code> | *No description.* |
3337
5853
 
3338
5854
  ---
3339
5855
 
3340
- ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.AwsAssumeRoleStep.Initializer.parameter.project"></a>
5856
+ ##### `strategy`<sup>Required</sup> <a name="strategy" id="projen-pipelines.VersionComputer.Initializer.parameter.strategy"></a>
3341
5857
 
3342
- - *Type:* projen.Project
5858
+ - *Type:* <a href="#projen-pipelines.IVersioningStrategy">IVersioningStrategy</a>
3343
5859
 
3344
- The projen project reference.
5860
+ ---
5861
+
5862
+ #### Methods <a name="Methods" id="Methods"></a>
5863
+
5864
+ | **Name** | **Description** |
5865
+ | --- | --- |
5866
+ | <code><a href="#projen-pipelines.VersionComputer.computeVersionInfo">computeVersionInfo</a></code> | Compute version info from context. |
3345
5867
 
3346
5868
  ---
3347
5869
 
3348
- ##### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.AwsAssumeRoleStep.Initializer.parameter.config"></a>
5870
+ ##### `computeVersionInfo` <a name="computeVersionInfo" id="projen-pipelines.VersionComputer.computeVersionInfo"></a>
3349
5871
 
3350
- - *Type:* <a href="#projen-pipelines.AwsAssumeRoleStepConfig">AwsAssumeRoleStepConfig</a>
5872
+ ```typescript
5873
+ public computeVersionInfo(context: ComputationContext): VersionInfo
5874
+ ```
5875
+
5876
+ Compute version info from context.
5877
+
5878
+ ###### `context`<sup>Required</sup> <a name="context" id="projen-pipelines.VersionComputer.computeVersionInfo.parameter.context"></a>
5879
+
5880
+ - *Type:* <a href="#projen-pipelines.ComputationContext">ComputationContext</a>
3351
5881
 
3352
5882
  ---
3353
5883
 
5884
+
5885
+
5886
+
5887
+ ### VersionInfo <a name="VersionInfo" id="projen-pipelines.VersionInfo"></a>
5888
+
5889
+ - *Implements:* <a href="#projen-pipelines.IVersionInfo">IVersionInfo</a>
5890
+
5891
+ Represents complete version information for a deployment.
5892
+
3354
5893
  #### Methods <a name="Methods" id="Methods"></a>
3355
5894
 
3356
5895
  | **Name** | **Description** |
3357
5896
  | --- | --- |
3358
- | <code><a href="#projen-pipelines.AwsAssumeRoleStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
3359
- | <code><a href="#projen-pipelines.AwsAssumeRoleStep.toCodeCatalyst">toCodeCatalyst</a></code> | Generates a configuration for a CodeCatalyst Actions step. |
3360
- | <code><a href="#projen-pipelines.AwsAssumeRoleStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
3361
- | <code><a href="#projen-pipelines.AwsAssumeRoleStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
5897
+ | <code><a href="#projen-pipelines.VersionInfo.compare">compare</a></code> | Compare with another version Returns: -1 if this < other, 0 if equal, 1 if this > other. |
5898
+ | <code><a href="#projen-pipelines.VersionInfo.displayVersion">displayVersion</a></code> | Get formatted version for display. |
5899
+ | <code><a href="#projen-pipelines.VersionInfo.exportName">exportName</a></code> | Create CloudFormation export name. |
5900
+ | <code><a href="#projen-pipelines.VersionInfo.mainBranch">mainBranch</a></code> | Check if this version is from the main branch. |
5901
+ | <code><a href="#projen-pipelines.VersionInfo.parameterName">parameterName</a></code> | Create a parameter name for SSM Parameter Store. |
5902
+ | <code><a href="#projen-pipelines.VersionInfo.taggedRelease">taggedRelease</a></code> | Check if this version is from a tagged release. |
5903
+ | <code><a href="#projen-pipelines.VersionInfo.toJson">toJson</a></code> | Convert to JSON string. |
5904
+ | <code><a href="#projen-pipelines.VersionInfo.toObject">toObject</a></code> | Convert to object. |
5905
+ | <code><a href="#projen-pipelines.VersionInfo.toString">toString</a></code> | Convert to plain version string. |
5906
+
5907
+ ---
5908
+
5909
+ ##### `compare` <a name="compare" id="projen-pipelines.VersionInfo.compare"></a>
5910
+
5911
+ ```typescript
5912
+ public compare(other: VersionInfo): number
5913
+ ```
5914
+
5915
+ Compare with another version Returns: -1 if this < other, 0 if equal, 1 if this > other.
5916
+
5917
+ ###### `other`<sup>Required</sup> <a name="other" id="projen-pipelines.VersionInfo.compare.parameter.other"></a>
5918
+
5919
+ - *Type:* <a href="#projen-pipelines.VersionInfo">VersionInfo</a>
5920
+
5921
+ ---
5922
+
5923
+ ##### `displayVersion` <a name="displayVersion" id="projen-pipelines.VersionInfo.displayVersion"></a>
5924
+
5925
+ ```typescript
5926
+ public displayVersion(): string
5927
+ ```
5928
+
5929
+ Get formatted version for display.
5930
+
5931
+ ##### `exportName` <a name="exportName" id="projen-pipelines.VersionInfo.exportName"></a>
5932
+
5933
+ ```typescript
5934
+ public exportName(template: string): string
5935
+ ```
5936
+
5937
+ Create CloudFormation export name.
5938
+
5939
+ ###### `template`<sup>Required</sup> <a name="template" id="projen-pipelines.VersionInfo.exportName.parameter.template"></a>
5940
+
5941
+ - *Type:* string
5942
+
5943
+ ---
5944
+
5945
+ ##### `mainBranch` <a name="mainBranch" id="projen-pipelines.VersionInfo.mainBranch"></a>
5946
+
5947
+ ```typescript
5948
+ public mainBranch(): boolean
5949
+ ```
5950
+
5951
+ Check if this version is from the main branch.
5952
+
5953
+ ##### `parameterName` <a name="parameterName" id="projen-pipelines.VersionInfo.parameterName"></a>
5954
+
5955
+ ```typescript
5956
+ public parameterName(template: string): string
5957
+ ```
5958
+
5959
+ Create a parameter name for SSM Parameter Store.
5960
+
5961
+ ###### `template`<sup>Required</sup> <a name="template" id="projen-pipelines.VersionInfo.parameterName.parameter.template"></a>
5962
+
5963
+ - *Type:* string
5964
+
5965
+ ---
5966
+
5967
+ ##### `taggedRelease` <a name="taggedRelease" id="projen-pipelines.VersionInfo.taggedRelease"></a>
5968
+
5969
+ ```typescript
5970
+ public taggedRelease(): boolean
5971
+ ```
5972
+
5973
+ Check if this version is from a tagged release.
5974
+
5975
+ ##### `toJson` <a name="toJson" id="projen-pipelines.VersionInfo.toJson"></a>
5976
+
5977
+ ```typescript
5978
+ public toJson(pretty?: boolean): string
5979
+ ```
5980
+
5981
+ Convert to JSON string.
5982
+
5983
+ ###### `pretty`<sup>Optional</sup> <a name="pretty" id="projen-pipelines.VersionInfo.toJson.parameter.pretty"></a>
5984
+
5985
+ - *Type:* boolean
5986
+
5987
+ ---
5988
+
5989
+ ##### `toObject` <a name="toObject" id="projen-pipelines.VersionInfo.toObject"></a>
5990
+
5991
+ ```typescript
5992
+ public toObject(): IVersionInfo
5993
+ ```
5994
+
5995
+ Convert to object.
5996
+
5997
+ ##### `toString` <a name="toString" id="projen-pipelines.VersionInfo.toString"></a>
5998
+
5999
+ ```typescript
6000
+ public toString(): string
6001
+ ```
6002
+
6003
+ Convert to plain version string.
6004
+
6005
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
6006
+
6007
+ | **Name** | **Description** |
6008
+ | --- | --- |
6009
+ | <code><a href="#projen-pipelines.VersionInfo.create">create</a></code> | Create a VersionInfo instance from raw data. |
6010
+ | <code><a href="#projen-pipelines.VersionInfo.fromEnvironment">fromEnvironment</a></code> | Create a VersionInfo instance from environment variables. |
6011
+ | <code><a href="#projen-pipelines.VersionInfo.fromJson">fromJson</a></code> | Create a VersionInfo instance from a JSON string. |
6012
+
6013
+ ---
6014
+
6015
+ ##### `create` <a name="create" id="projen-pipelines.VersionInfo.create"></a>
6016
+
6017
+ ```typescript
6018
+ import { VersionInfo } from 'projen-pipelines'
6019
+
6020
+ VersionInfo.create(props: IVersionInfo)
6021
+ ```
6022
+
6023
+ Create a VersionInfo instance from raw data.
6024
+
6025
+ ###### `props`<sup>Required</sup> <a name="props" id="projen-pipelines.VersionInfo.create.parameter.props"></a>
6026
+
6027
+ - *Type:* <a href="#projen-pipelines.IVersionInfo">IVersionInfo</a>
6028
+
6029
+ ---
6030
+
6031
+ ##### `fromEnvironment` <a name="fromEnvironment" id="projen-pipelines.VersionInfo.fromEnvironment"></a>
6032
+
6033
+ ```typescript
6034
+ import { VersionInfo } from 'projen-pipelines'
6035
+
6036
+ VersionInfo.fromEnvironment(env: {[ key: string ]: string})
6037
+ ```
6038
+
6039
+ Create a VersionInfo instance from environment variables.
6040
+
6041
+ ###### `env`<sup>Required</sup> <a name="env" id="projen-pipelines.VersionInfo.fromEnvironment.parameter.env"></a>
6042
+
6043
+ - *Type:* {[ key: string ]: string}
6044
+
6045
+ ---
6046
+
6047
+ ##### `fromJson` <a name="fromJson" id="projen-pipelines.VersionInfo.fromJson"></a>
6048
+
6049
+ ```typescript
6050
+ import { VersionInfo } from 'projen-pipelines'
6051
+
6052
+ VersionInfo.fromJson(json: string)
6053
+ ```
6054
+
6055
+ Create a VersionInfo instance from a JSON string.
6056
+
6057
+ ###### `json`<sup>Required</sup> <a name="json" id="projen-pipelines.VersionInfo.fromJson.parameter.json"></a>
6058
+
6059
+ - *Type:* string
6060
+
6061
+ ---
6062
+
6063
+ #### Properties <a name="Properties" id="Properties"></a>
6064
+
6065
+ | **Name** | **Type** | **Description** |
6066
+ | --- | --- | --- |
6067
+ | <code><a href="#projen-pipelines.VersionInfo.property.branch">branch</a></code> | <code>string</code> | *No description.* |
6068
+ | <code><a href="#projen-pipelines.VersionInfo.property.commitCount">commitCount</a></code> | <code>number</code> | Commit count information. |
6069
+ | <code><a href="#projen-pipelines.VersionInfo.property.commitHash">commitHash</a></code> | <code>string</code> | Git information (ALWAYS included). |
6070
+ | <code><a href="#projen-pipelines.VersionInfo.property.commitHashShort">commitHashShort</a></code> | <code>string</code> | *No description.* |
6071
+ | <code><a href="#projen-pipelines.VersionInfo.property.deployedAt">deployedAt</a></code> | <code>string</code> | Deployment metadata. |
6072
+ | <code><a href="#projen-pipelines.VersionInfo.property.deployedBy">deployedBy</a></code> | <code>string</code> | *No description.* |
6073
+ | <code><a href="#projen-pipelines.VersionInfo.property.environment">environment</a></code> | <code>string</code> | *No description.* |
6074
+ | <code><a href="#projen-pipelines.VersionInfo.property.version">version</a></code> | <code>string</code> | Primary version string. |
6075
+ | <code><a href="#projen-pipelines.VersionInfo.property.buildNumber">buildNumber</a></code> | <code>string</code> | *No description.* |
6076
+ | <code><a href="#projen-pipelines.VersionInfo.property.commitsSinceTag">commitsSinceTag</a></code> | <code>number</code> | *No description.* |
6077
+ | <code><a href="#projen-pipelines.VersionInfo.property.packageVersion">packageVersion</a></code> | <code>string</code> | Package.json information (if applicable). |
6078
+ | <code><a href="#projen-pipelines.VersionInfo.property.pipelineVersion">pipelineVersion</a></code> | <code>string</code> | *No description.* |
6079
+ | <code><a href="#projen-pipelines.VersionInfo.property.repository">repository</a></code> | <code>string</code> | Additional metadata. |
6080
+ | <code><a href="#projen-pipelines.VersionInfo.property.tag">tag</a></code> | <code>string</code> | Optional git tag information. |
6081
+
6082
+ ---
6083
+
6084
+ ##### `branch`<sup>Required</sup> <a name="branch" id="projen-pipelines.VersionInfo.property.branch"></a>
6085
+
6086
+ ```typescript
6087
+ public readonly branch: string;
6088
+ ```
6089
+
6090
+ - *Type:* string
6091
+
6092
+ ---
6093
+
6094
+ ##### `commitCount`<sup>Required</sup> <a name="commitCount" id="projen-pipelines.VersionInfo.property.commitCount"></a>
6095
+
6096
+ ```typescript
6097
+ public readonly commitCount: number;
6098
+ ```
6099
+
6100
+ - *Type:* number
6101
+
6102
+ Commit count information.
6103
+
6104
+ ---
6105
+
6106
+ ##### `commitHash`<sup>Required</sup> <a name="commitHash" id="projen-pipelines.VersionInfo.property.commitHash"></a>
6107
+
6108
+ ```typescript
6109
+ public readonly commitHash: string;
6110
+ ```
6111
+
6112
+ - *Type:* string
6113
+
6114
+ Git information (ALWAYS included).
6115
+
6116
+ ---
6117
+
6118
+ ##### `commitHashShort`<sup>Required</sup> <a name="commitHashShort" id="projen-pipelines.VersionInfo.property.commitHashShort"></a>
6119
+
6120
+ ```typescript
6121
+ public readonly commitHashShort: string;
6122
+ ```
6123
+
6124
+ - *Type:* string
6125
+
6126
+ ---
6127
+
6128
+ ##### `deployedAt`<sup>Required</sup> <a name="deployedAt" id="projen-pipelines.VersionInfo.property.deployedAt"></a>
6129
+
6130
+ ```typescript
6131
+ public readonly deployedAt: string;
6132
+ ```
6133
+
6134
+ - *Type:* string
6135
+
6136
+ Deployment metadata.
6137
+
6138
+ ---
6139
+
6140
+ ##### `deployedBy`<sup>Required</sup> <a name="deployedBy" id="projen-pipelines.VersionInfo.property.deployedBy"></a>
6141
+
6142
+ ```typescript
6143
+ public readonly deployedBy: string;
6144
+ ```
6145
+
6146
+ - *Type:* string
6147
+
6148
+ ---
6149
+
6150
+ ##### `environment`<sup>Required</sup> <a name="environment" id="projen-pipelines.VersionInfo.property.environment"></a>
6151
+
6152
+ ```typescript
6153
+ public readonly environment: string;
6154
+ ```
6155
+
6156
+ - *Type:* string
6157
+
6158
+ ---
6159
+
6160
+ ##### `version`<sup>Required</sup> <a name="version" id="projen-pipelines.VersionInfo.property.version"></a>
6161
+
6162
+ ```typescript
6163
+ public readonly version: string;
6164
+ ```
6165
+
6166
+ - *Type:* string
6167
+
6168
+ Primary version string.
3362
6169
 
3363
6170
  ---
3364
6171
 
3365
- ##### `toBash` <a name="toBash" id="projen-pipelines.AwsAssumeRoleStep.toBash"></a>
6172
+ ##### `buildNumber`<sup>Optional</sup> <a name="buildNumber" id="projen-pipelines.VersionInfo.property.buildNumber"></a>
3366
6173
 
3367
6174
  ```typescript
3368
- public toBash(): BashStepConfig
6175
+ public readonly buildNumber: string;
3369
6176
  ```
3370
6177
 
3371
- Generates a configuration for a bash script step.
6178
+ - *Type:* string
3372
6179
 
3373
- Should be implemented by subclasses.
6180
+ ---
3374
6181
 
3375
- ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.AwsAssumeRoleStep.toCodeCatalyst"></a>
6182
+ ##### `commitsSinceTag`<sup>Optional</sup> <a name="commitsSinceTag" id="projen-pipelines.VersionInfo.property.commitsSinceTag"></a>
3376
6183
 
3377
6184
  ```typescript
3378
- public toCodeCatalyst(): CodeCatalystStepConfig
6185
+ public readonly commitsSinceTag: number;
3379
6186
  ```
3380
6187
 
3381
- Generates a configuration for a CodeCatalyst Actions step.
6188
+ - *Type:* number
3382
6189
 
3383
- Should be implemented by subclasses.
6190
+ ---
3384
6191
 
3385
- ##### `toGithub` <a name="toGithub" id="projen-pipelines.AwsAssumeRoleStep.toGithub"></a>
6192
+ ##### `packageVersion`<sup>Optional</sup> <a name="packageVersion" id="projen-pipelines.VersionInfo.property.packageVersion"></a>
3386
6193
 
3387
6194
  ```typescript
3388
- public toGithub(): GithubStepConfig
6195
+ public readonly packageVersion: string;
3389
6196
  ```
3390
6197
 
3391
- Generates a configuration for a GitHub Actions step.
6198
+ - *Type:* string
3392
6199
 
3393
- Should be implemented by subclasses.
6200
+ Package.json information (if applicable).
3394
6201
 
3395
- ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.AwsAssumeRoleStep.toGitlab"></a>
6202
+ ---
6203
+
6204
+ ##### `pipelineVersion`<sup>Optional</sup> <a name="pipelineVersion" id="projen-pipelines.VersionInfo.property.pipelineVersion"></a>
3396
6205
 
3397
6206
  ```typescript
3398
- public toGitlab(): GitlabStepConfig
6207
+ public readonly pipelineVersion: string;
3399
6208
  ```
3400
6209
 
3401
- Generates a configuration for a GitLab CI step.
6210
+ - *Type:* string
3402
6211
 
3403
- Should be implemented by subclasses.
6212
+ ---
3404
6213
 
6214
+ ##### `repository`<sup>Optional</sup> <a name="repository" id="projen-pipelines.VersionInfo.property.repository"></a>
3405
6215
 
6216
+ ```typescript
6217
+ public readonly repository: string;
6218
+ ```
3406
6219
 
6220
+ - *Type:* string
3407
6221
 
3408
- ### CodeArtifactLoginStep <a name="CodeArtifactLoginStep" id="projen-pipelines.CodeArtifactLoginStep"></a>
6222
+ Additional metadata.
3409
6223
 
3410
- #### Initializers <a name="Initializers" id="projen-pipelines.CodeArtifactLoginStep.Initializer"></a>
6224
+ ---
3411
6225
 
3412
- ```typescript
3413
- import { CodeArtifactLoginStep } from 'projen-pipelines'
6226
+ ##### `tag`<sup>Optional</sup> <a name="tag" id="projen-pipelines.VersionInfo.property.tag"></a>
3414
6227
 
3415
- new CodeArtifactLoginStep(project: Project, options: CodeArtifactLoginStepOptions)
6228
+ ```typescript
6229
+ public readonly tag: string;
3416
6230
  ```
3417
6231
 
3418
- | **Name** | **Type** | **Description** |
3419
- | --- | --- | --- |
3420
- | <code><a href="#projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3421
- | <code><a href="#projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.options">options</a></code> | <code><a href="#projen-pipelines.CodeArtifactLoginStepOptions">CodeArtifactLoginStepOptions</a></code> | *No description.* |
6232
+ - *Type:* string
6233
+
6234
+ Optional git tag information.
3422
6235
 
3423
6236
  ---
3424
6237
 
3425
- ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.project"></a>
3426
6238
 
3427
- - *Type:* projen.Project
6239
+ ### VersionInfoBuilder <a name="VersionInfoBuilder" id="projen-pipelines.VersionInfoBuilder"></a>
3428
6240
 
3429
- The projen project reference.
6241
+ Builder class for creating VersionInfo instances.
3430
6242
 
3431
- ---
6243
+ #### Initializers <a name="Initializers" id="projen-pipelines.VersionInfoBuilder.Initializer"></a>
3432
6244
 
3433
- ##### `options`<sup>Required</sup> <a name="options" id="projen-pipelines.CodeArtifactLoginStep.Initializer.parameter.options"></a>
6245
+ ```typescript
6246
+ import { VersionInfoBuilder } from 'projen-pipelines'
3434
6247
 
3435
- - *Type:* <a href="#projen-pipelines.CodeArtifactLoginStepOptions">CodeArtifactLoginStepOptions</a>
6248
+ new VersionInfoBuilder()
6249
+ ```
6250
+
6251
+ | **Name** | **Type** | **Description** |
6252
+ | --- | --- | --- |
3436
6253
 
3437
6254
  ---
3438
6255
 
@@ -3440,357 +6257,384 @@ The projen project reference.
3440
6257
 
3441
6258
  | **Name** | **Description** |
3442
6259
  | --- | --- |
3443
- | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toBash">toBash</a></code> | Converts the sequence of steps into a Bash script configuration. |
3444
- | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the sequence of steps into a CodeCatalyst Actions step configuration. |
3445
- | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toGithub">toGithub</a></code> | Converts the sequence of steps into a GitHub Actions step configuration. |
3446
- | <code><a href="#projen-pipelines.CodeArtifactLoginStep.toGitlab">toGitlab</a></code> | Converts the sequence of steps into a GitLab CI configuration. |
3447
- | <code><a href="#projen-pipelines.CodeArtifactLoginStep.addSteps">addSteps</a></code> | *No description.* |
3448
- | <code><a href="#projen-pipelines.CodeArtifactLoginStep.prependSteps">prependSteps</a></code> | *No description.* |
6260
+ | <code><a href="#projen-pipelines.VersionInfoBuilder.create">create</a></code> | Build the VersionInfo instance. |
6261
+ | <code><a href="#projen-pipelines.VersionInfoBuilder.deploymentInfo">deploymentInfo</a></code> | Set deployment metadata. |
6262
+ | <code><a href="#projen-pipelines.VersionInfoBuilder.gitInfo">gitInfo</a></code> | Set git information. |
6263
+ | <code><a href="#projen-pipelines.VersionInfoBuilder.packageVersion">packageVersion</a></code> | Set package version. |
6264
+ | <code><a href="#projen-pipelines.VersionInfoBuilder.pipelineVersion">pipelineVersion</a></code> | Set pipeline version. |
6265
+ | <code><a href="#projen-pipelines.VersionInfoBuilder.repository">repository</a></code> | Set repository information. |
6266
+ | <code><a href="#projen-pipelines.VersionInfoBuilder.version">version</a></code> | Set the version string. |
3449
6267
 
3450
6268
  ---
3451
6269
 
3452
- ##### `toBash` <a name="toBash" id="projen-pipelines.CodeArtifactLoginStep.toBash"></a>
6270
+ ##### `create` <a name="create" id="projen-pipelines.VersionInfoBuilder.create"></a>
3453
6271
 
3454
6272
  ```typescript
3455
- public toBash(): BashStepConfig
6273
+ public create(): VersionInfo
3456
6274
  ```
3457
6275
 
3458
- Converts the sequence of steps into a Bash script configuration.
6276
+ Build the VersionInfo instance.
3459
6277
 
3460
- ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.CodeArtifactLoginStep.toCodeCatalyst"></a>
6278
+ ##### `deploymentInfo` <a name="deploymentInfo" id="projen-pipelines.VersionInfoBuilder.deploymentInfo"></a>
3461
6279
 
3462
6280
  ```typescript
3463
- public toCodeCatalyst(): CodeCatalystStepConfig
6281
+ public deploymentInfo(info: DeploymentInfoInput): VersionInfoBuilder
3464
6282
  ```
3465
6283
 
3466
- Converts the sequence of steps into a CodeCatalyst Actions step configuration.
6284
+ Set deployment metadata.
3467
6285
 
3468
- ##### `toGithub` <a name="toGithub" id="projen-pipelines.CodeArtifactLoginStep.toGithub"></a>
6286
+ ###### `info`<sup>Required</sup> <a name="info" id="projen-pipelines.VersionInfoBuilder.deploymentInfo.parameter.info"></a>
3469
6287
 
3470
- ```typescript
3471
- public toGithub(): GithubStepConfig
3472
- ```
6288
+ - *Type:* <a href="#projen-pipelines.DeploymentInfoInput">DeploymentInfoInput</a>
3473
6289
 
3474
- Converts the sequence of steps into a GitHub Actions step configuration.
6290
+ ---
3475
6291
 
3476
- ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.CodeArtifactLoginStep.toGitlab"></a>
6292
+ ##### `gitInfo` <a name="gitInfo" id="projen-pipelines.VersionInfoBuilder.gitInfo"></a>
3477
6293
 
3478
6294
  ```typescript
3479
- public toGitlab(): GitlabStepConfig
6295
+ public gitInfo(info: GitInfoInput): VersionInfoBuilder
3480
6296
  ```
3481
6297
 
3482
- Converts the sequence of steps into a GitLab CI configuration.
6298
+ Set git information.
3483
6299
 
3484
- ##### `addSteps` <a name="addSteps" id="projen-pipelines.CodeArtifactLoginStep.addSteps"></a>
6300
+ ###### `info`<sup>Required</sup> <a name="info" id="projen-pipelines.VersionInfoBuilder.gitInfo.parameter.info"></a>
6301
+
6302
+ - *Type:* <a href="#projen-pipelines.GitInfoInput">GitInfoInput</a>
6303
+
6304
+ ---
6305
+
6306
+ ##### `packageVersion` <a name="packageVersion" id="projen-pipelines.VersionInfoBuilder.packageVersion"></a>
3485
6307
 
3486
6308
  ```typescript
3487
- public addSteps(steps: ...PipelineStep[]): void
6309
+ public packageVersion(version: string): VersionInfoBuilder
3488
6310
  ```
3489
6311
 
3490
- ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.CodeArtifactLoginStep.addSteps.parameter.steps"></a>
6312
+ Set package version.
3491
6313
 
3492
- - *Type:* ...<a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
6314
+ ###### `version`<sup>Required</sup> <a name="version" id="projen-pipelines.VersionInfoBuilder.packageVersion.parameter.version"></a>
6315
+
6316
+ - *Type:* string
3493
6317
 
3494
6318
  ---
3495
6319
 
3496
- ##### `prependSteps` <a name="prependSteps" id="projen-pipelines.CodeArtifactLoginStep.prependSteps"></a>
6320
+ ##### `pipelineVersion` <a name="pipelineVersion" id="projen-pipelines.VersionInfoBuilder.pipelineVersion"></a>
3497
6321
 
3498
6322
  ```typescript
3499
- public prependSteps(steps: ...PipelineStep[]): void
6323
+ public pipelineVersion(version: string): VersionInfoBuilder
3500
6324
  ```
3501
6325
 
3502
- ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.CodeArtifactLoginStep.prependSteps.parameter.steps"></a>
6326
+ Set pipeline version.
3503
6327
 
3504
- - *Type:* ...<a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
6328
+ ###### `version`<sup>Required</sup> <a name="version" id="projen-pipelines.VersionInfoBuilder.pipelineVersion.parameter.version"></a>
6329
+
6330
+ - *Type:* string
3505
6331
 
3506
6332
  ---
3507
6333
 
6334
+ ##### `repository` <a name="repository" id="projen-pipelines.VersionInfoBuilder.repository"></a>
3508
6335
 
6336
+ ```typescript
6337
+ public repository(repo: string): VersionInfoBuilder
6338
+ ```
3509
6339
 
6340
+ Set repository information.
3510
6341
 
3511
- ### DownloadArtifactStep <a name="DownloadArtifactStep" id="projen-pipelines.DownloadArtifactStep"></a>
6342
+ ###### `repo`<sup>Required</sup> <a name="repo" id="projen-pipelines.VersionInfoBuilder.repository.parameter.repo"></a>
3512
6343
 
3513
- #### Initializers <a name="Initializers" id="projen-pipelines.DownloadArtifactStep.Initializer"></a>
6344
+ - *Type:* string
3514
6345
 
3515
- ```typescript
3516
- import { DownloadArtifactStep } from 'projen-pipelines'
6346
+ ---
3517
6347
 
3518
- new DownloadArtifactStep(project: Project, config: DownloadArtifactStepConfig)
6348
+ ##### `version` <a name="version" id="projen-pipelines.VersionInfoBuilder.version"></a>
6349
+
6350
+ ```typescript
6351
+ public version(version: string): VersionInfoBuilder
3519
6352
  ```
3520
6353
 
3521
- | **Name** | **Type** | **Description** |
3522
- | --- | --- | --- |
3523
- | <code><a href="#projen-pipelines.DownloadArtifactStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3524
- | <code><a href="#projen-pipelines.DownloadArtifactStep.Initializer.parameter.config">config</a></code> | <code><a href="#projen-pipelines.DownloadArtifactStepConfig">DownloadArtifactStepConfig</a></code> | *No description.* |
6354
+ Set the version string.
6355
+
6356
+ ###### `version`<sup>Required</sup> <a name="version" id="projen-pipelines.VersionInfoBuilder.version.parameter.version"></a>
6357
+
6358
+ - *Type:* string
3525
6359
 
3526
6360
  ---
3527
6361
 
3528
- ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.DownloadArtifactStep.Initializer.parameter.project"></a>
3529
6362
 
3530
- - *Type:* projen.Project
3531
6363
 
3532
- The projen project reference.
3533
6364
 
3534
- ---
6365
+ ### VersioningConfigurations <a name="VersioningConfigurations" id="projen-pipelines.VersioningConfigurations"></a>
3535
6366
 
3536
- ##### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.DownloadArtifactStep.Initializer.parameter.config"></a>
6367
+ Main versioning configuration class with factory methods.
3537
6368
 
3538
- - *Type:* <a href="#projen-pipelines.DownloadArtifactStepConfig">DownloadArtifactStepConfig</a>
6369
+ #### Initializers <a name="Initializers" id="projen-pipelines.VersioningConfigurations.Initializer"></a>
6370
+
6371
+ ```typescript
6372
+ import { VersioningConfigurations } from 'projen-pipelines'
6373
+
6374
+ new VersioningConfigurations()
6375
+ ```
6376
+
6377
+ | **Name** | **Type** | **Description** |
6378
+ | --- | --- | --- |
3539
6379
 
3540
6380
  ---
3541
6381
 
3542
- #### Methods <a name="Methods" id="Methods"></a>
6382
+
6383
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
3543
6384
 
3544
6385
  | **Name** | **Description** |
3545
6386
  | --- | --- |
3546
- | <code><a href="#projen-pipelines.DownloadArtifactStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
3547
- | <code><a href="#projen-pipelines.DownloadArtifactStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the step into a CodeCatalyst Actions step configuration. |
3548
- | <code><a href="#projen-pipelines.DownloadArtifactStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
3549
- | <code><a href="#projen-pipelines.DownloadArtifactStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
6387
+ | <code><a href="#projen-pipelines.VersioningConfigurations.custom">custom</a></code> | Create a custom configuration. |
6388
+ | <code><a href="#projen-pipelines.VersioningConfigurations.minimal">minimal</a></code> | Minimal configuration for testing. |
6389
+ | <code><a href="#projen-pipelines.VersioningConfigurations.standard">standard</a></code> | Standard configuration with commit count strategy. |
3550
6390
 
3551
6391
  ---
3552
6392
 
3553
- ##### `toBash` <a name="toBash" id="projen-pipelines.DownloadArtifactStep.toBash"></a>
6393
+ ##### `custom` <a name="custom" id="projen-pipelines.VersioningConfigurations.custom"></a>
3554
6394
 
3555
6395
  ```typescript
3556
- public toBash(): BashStepConfig
3557
- ```
6396
+ import { VersioningConfigurations } from 'projen-pipelines'
3558
6397
 
3559
- Generates a configuration for a bash script step.
6398
+ VersioningConfigurations.custom(config: CustomVersioningConfig)
6399
+ ```
3560
6400
 
3561
- Should be implemented by subclasses.
6401
+ Create a custom configuration.
3562
6402
 
3563
- ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.DownloadArtifactStep.toCodeCatalyst"></a>
6403
+ ###### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.VersioningConfigurations.custom.parameter.config"></a>
3564
6404
 
3565
- ```typescript
3566
- public toCodeCatalyst(): CodeCatalystStepConfig
3567
- ```
6405
+ - *Type:* <a href="#projen-pipelines.CustomVersioningConfig">CustomVersioningConfig</a>
3568
6406
 
3569
- Converts the step into a CodeCatalyst Actions step configuration.
6407
+ ---
3570
6408
 
3571
- ##### `toGithub` <a name="toGithub" id="projen-pipelines.DownloadArtifactStep.toGithub"></a>
6409
+ ##### `minimal` <a name="minimal" id="projen-pipelines.VersioningConfigurations.minimal"></a>
3572
6410
 
3573
6411
  ```typescript
3574
- public toGithub(): GithubStepConfig
3575
- ```
6412
+ import { VersioningConfigurations } from 'projen-pipelines'
3576
6413
 
3577
- Generates a configuration for a GitHub Actions step.
6414
+ VersioningConfigurations.minimal()
6415
+ ```
3578
6416
 
3579
- Should be implemented by subclasses.
6417
+ Minimal configuration for testing.
3580
6418
 
3581
- ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.DownloadArtifactStep.toGitlab"></a>
6419
+ ##### `standard` <a name="standard" id="projen-pipelines.VersioningConfigurations.standard"></a>
3582
6420
 
3583
6421
  ```typescript
3584
- public toGitlab(): GitlabStepConfig
6422
+ import { VersioningConfigurations } from 'projen-pipelines'
6423
+
6424
+ VersioningConfigurations.standard(options?: StandardConfigOptions)
3585
6425
  ```
3586
6426
 
3587
- Generates a configuration for a GitLab CI step.
6427
+ Standard configuration with commit count strategy.
3588
6428
 
3589
- Should be implemented by subclasses.
6429
+ ###### `options`<sup>Optional</sup> <a name="options" id="projen-pipelines.VersioningConfigurations.standard.parameter.options"></a>
6430
+
6431
+ - *Type:* <a href="#projen-pipelines.StandardConfigOptions">StandardConfigOptions</a>
3590
6432
 
6433
+ ---
3591
6434
 
3592
6435
 
3593
6436
 
3594
- ### GithubPackagesLoginStep <a name="GithubPackagesLoginStep" id="projen-pipelines.GithubPackagesLoginStep"></a>
6437
+ ### VersioningConfigUtils <a name="VersioningConfigUtils" id="projen-pipelines.VersioningConfigUtils"></a>
3595
6438
 
3596
- #### Initializers <a name="Initializers" id="projen-pipelines.GithubPackagesLoginStep.Initializer"></a>
6439
+ Utility functions for versioning configuration.
6440
+
6441
+ #### Initializers <a name="Initializers" id="projen-pipelines.VersioningConfigUtils.Initializer"></a>
3597
6442
 
3598
6443
  ```typescript
3599
- import { GithubPackagesLoginStep } from 'projen-pipelines'
6444
+ import { VersioningConfigUtils } from 'projen-pipelines'
3600
6445
 
3601
- new GithubPackagesLoginStep(project: Project, options: GithubPackagesLoginStepOptions)
6446
+ new VersioningConfigUtils()
3602
6447
  ```
3603
6448
 
3604
6449
  | **Name** | **Type** | **Description** |
3605
6450
  | --- | --- | --- |
3606
- | <code><a href="#projen-pipelines.GithubPackagesLoginStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3607
- | <code><a href="#projen-pipelines.GithubPackagesLoginStep.Initializer.parameter.options">options</a></code> | <code><a href="#projen-pipelines.GithubPackagesLoginStepOptions">GithubPackagesLoginStepOptions</a></code> | *No description.* |
3608
6451
 
3609
6452
  ---
3610
6453
 
3611
- ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.GithubPackagesLoginStep.Initializer.parameter.project"></a>
3612
-
3613
- - *Type:* projen.Project
3614
-
3615
- The projen project reference.
3616
-
3617
- ---
3618
-
3619
- ##### `options`<sup>Required</sup> <a name="options" id="projen-pipelines.GithubPackagesLoginStep.Initializer.parameter.options"></a>
3620
-
3621
- - *Type:* <a href="#projen-pipelines.GithubPackagesLoginStepOptions">GithubPackagesLoginStepOptions</a>
3622
-
3623
- ---
3624
6454
 
3625
- #### Methods <a name="Methods" id="Methods"></a>
6455
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
3626
6456
 
3627
6457
  | **Name** | **Description** |
3628
6458
  | --- | --- |
3629
- | <code><a href="#projen-pipelines.GithubPackagesLoginStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
3630
- | <code><a href="#projen-pipelines.GithubPackagesLoginStep.toCodeCatalyst">toCodeCatalyst</a></code> | Generates a configuration for a CodeCatalyst Actions step. |
3631
- | <code><a href="#projen-pipelines.GithubPackagesLoginStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
3632
- | <code><a href="#projen-pipelines.GithubPackagesLoginStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
6459
+ | <code><a href="#projen-pipelines.VersioningConfigUtils.default">default</a></code> | Get default configuration. |
6460
+ | <code><a href="#projen-pipelines.VersioningConfigUtils.resolveForStage">resolveForStage</a></code> | Resolve configuration for a specific stage. |
6461
+ | <code><a href="#projen-pipelines.VersioningConfigUtils.validate">validate</a></code> | Validate configuration. |
3633
6462
 
3634
6463
  ---
3635
6464
 
3636
- ##### `toBash` <a name="toBash" id="projen-pipelines.GithubPackagesLoginStep.toBash"></a>
6465
+ ##### `default` <a name="default" id="projen-pipelines.VersioningConfigUtils.default"></a>
3637
6466
 
3638
6467
  ```typescript
3639
- public toBash(): BashStepConfig
3640
- ```
6468
+ import { VersioningConfigUtils } from 'projen-pipelines'
3641
6469
 
3642
- Generates a configuration for a bash script step.
6470
+ VersioningConfigUtils.default()
6471
+ ```
3643
6472
 
3644
- Should be implemented by subclasses.
6473
+ Get default configuration.
3645
6474
 
3646
- ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.GithubPackagesLoginStep.toCodeCatalyst"></a>
6475
+ ##### `resolveForStage` <a name="resolveForStage" id="projen-pipelines.VersioningConfigUtils.resolveForStage"></a>
3647
6476
 
3648
6477
  ```typescript
3649
- public toCodeCatalyst(): CodeCatalystStepConfig
6478
+ import { VersioningConfigUtils } from 'projen-pipelines'
6479
+
6480
+ VersioningConfigUtils.resolveForStage(config: VersioningConfig, stage: string)
3650
6481
  ```
3651
6482
 
3652
- Generates a configuration for a CodeCatalyst Actions step.
6483
+ Resolve configuration for a specific stage.
3653
6484
 
3654
- Should be implemented by subclasses.
6485
+ ###### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.VersioningConfigUtils.resolveForStage.parameter.config"></a>
3655
6486
 
3656
- ##### `toGithub` <a name="toGithub" id="projen-pipelines.GithubPackagesLoginStep.toGithub"></a>
6487
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
3657
6488
 
3658
- ```typescript
3659
- public toGithub(): GithubStepConfig
3660
- ```
6489
+ ---
3661
6490
 
3662
- Generates a configuration for a GitHub Actions step.
6491
+ ###### `stage`<sup>Required</sup> <a name="stage" id="projen-pipelines.VersioningConfigUtils.resolveForStage.parameter.stage"></a>
3663
6492
 
3664
- Should be implemented by subclasses.
6493
+ - *Type:* string
3665
6494
 
3666
- ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.GithubPackagesLoginStep.toGitlab"></a>
6495
+ ---
6496
+
6497
+ ##### `validate` <a name="validate" id="projen-pipelines.VersioningConfigUtils.validate"></a>
3667
6498
 
3668
6499
  ```typescript
3669
- public toGitlab(): GitlabStepConfig
6500
+ import { VersioningConfigUtils } from 'projen-pipelines'
6501
+
6502
+ VersioningConfigUtils.validate(config: VersioningConfig)
3670
6503
  ```
3671
6504
 
3672
- Generates a configuration for a GitLab CI step.
6505
+ Validate configuration.
3673
6506
 
3674
- Should be implemented by subclasses.
6507
+ ###### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.VersioningConfigUtils.validate.parameter.config"></a>
3675
6508
 
6509
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
3676
6510
 
6511
+ ---
3677
6512
 
3678
6513
 
3679
- ### PipelineStep <a name="PipelineStep" id="projen-pipelines.PipelineStep"></a>
3680
6514
 
3681
- Abstract class defining the structure of a pipeline step.
6515
+ ### VersioningOutputs <a name="VersioningOutputs" id="projen-pipelines.VersioningOutputs"></a>
3682
6516
 
3683
- #### Initializers <a name="Initializers" id="projen-pipelines.PipelineStep.Initializer"></a>
6517
+ Factory class for output configurations.
6518
+
6519
+ #### Initializers <a name="Initializers" id="projen-pipelines.VersioningOutputs.Initializer"></a>
3684
6520
 
3685
6521
  ```typescript
3686
- import { PipelineStep } from 'projen-pipelines'
6522
+ import { VersioningOutputs } from 'projen-pipelines'
3687
6523
 
3688
- new PipelineStep(project: Project)
6524
+ new VersioningOutputs()
3689
6525
  ```
3690
6526
 
3691
6527
  | **Name** | **Type** | **Description** |
3692
6528
  | --- | --- | --- |
3693
- | <code><a href="#projen-pipelines.PipelineStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3694
6529
 
3695
6530
  ---
3696
6531
 
3697
- ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.PipelineStep.Initializer.parameter.project"></a>
3698
-
3699
- - *Type:* projen.Project
3700
-
3701
- The projen project reference.
3702
-
3703
- ---
3704
6532
 
3705
- #### Methods <a name="Methods" id="Methods"></a>
6533
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
3706
6534
 
3707
6535
  | **Name** | **Description** |
3708
6536
  | --- | --- |
3709
- | <code><a href="#projen-pipelines.PipelineStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
3710
- | <code><a href="#projen-pipelines.PipelineStep.toCodeCatalyst">toCodeCatalyst</a></code> | Generates a configuration for a CodeCatalyst Actions step. |
3711
- | <code><a href="#projen-pipelines.PipelineStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
3712
- | <code><a href="#projen-pipelines.PipelineStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
6537
+ | <code><a href="#projen-pipelines.VersioningOutputs.cloudFormationOnly">cloudFormationOnly</a></code> | Create output configuration with only CloudFormation. |
6538
+ | <code><a href="#projen-pipelines.VersioningOutputs.hierarchicalParameters">hierarchicalParameters</a></code> | Create output configuration with hierarchical SSM parameters. |
6539
+ | <code><a href="#projen-pipelines.VersioningOutputs.minimal">minimal</a></code> | Create minimal output configuration (CloudFormation only, plain format). |
6540
+ | <code><a href="#projen-pipelines.VersioningOutputs.standard">standard</a></code> | Create output configuration with CloudFormation and SSM Parameter Store. |
3713
6541
 
3714
6542
  ---
3715
6543
 
3716
- ##### `toBash` <a name="toBash" id="projen-pipelines.PipelineStep.toBash"></a>
6544
+ ##### `cloudFormationOnly` <a name="cloudFormationOnly" id="projen-pipelines.VersioningOutputs.cloudFormationOnly"></a>
3717
6545
 
3718
6546
  ```typescript
3719
- public toBash(): BashStepConfig
6547
+ import { VersioningOutputs } from 'projen-pipelines'
6548
+
6549
+ VersioningOutputs.cloudFormationOnly(options?: CloudFormationOnlyOptions)
3720
6550
  ```
3721
6551
 
3722
- Generates a configuration for a bash script step.
6552
+ Create output configuration with only CloudFormation.
3723
6553
 
3724
- Should be implemented by subclasses.
6554
+ ###### `options`<sup>Optional</sup> <a name="options" id="projen-pipelines.VersioningOutputs.cloudFormationOnly.parameter.options"></a>
3725
6555
 
3726
- ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.PipelineStep.toCodeCatalyst"></a>
6556
+ - *Type:* <a href="#projen-pipelines.CloudFormationOnlyOptions">CloudFormationOnlyOptions</a>
6557
+
6558
+ ---
6559
+
6560
+ ##### `hierarchicalParameters` <a name="hierarchicalParameters" id="projen-pipelines.VersioningOutputs.hierarchicalParameters"></a>
3727
6561
 
3728
6562
  ```typescript
3729
- public toCodeCatalyst(): CodeCatalystStepConfig
6563
+ import { VersioningOutputs } from 'projen-pipelines'
6564
+
6565
+ VersioningOutputs.hierarchicalParameters(basePath: string, options?: HierarchicalParametersOptions)
3730
6566
  ```
3731
6567
 
3732
- Generates a configuration for a CodeCatalyst Actions step.
6568
+ Create output configuration with hierarchical SSM parameters.
3733
6569
 
3734
- Should be implemented by subclasses.
6570
+ ###### `basePath`<sup>Required</sup> <a name="basePath" id="projen-pipelines.VersioningOutputs.hierarchicalParameters.parameter.basePath"></a>
3735
6571
 
3736
- ##### `toGithub` <a name="toGithub" id="projen-pipelines.PipelineStep.toGithub"></a>
6572
+ - *Type:* string
6573
+
6574
+ ---
6575
+
6576
+ ###### `options`<sup>Optional</sup> <a name="options" id="projen-pipelines.VersioningOutputs.hierarchicalParameters.parameter.options"></a>
6577
+
6578
+ - *Type:* <a href="#projen-pipelines.HierarchicalParametersOptions">HierarchicalParametersOptions</a>
6579
+
6580
+ ---
6581
+
6582
+ ##### `minimal` <a name="minimal" id="projen-pipelines.VersioningOutputs.minimal"></a>
3737
6583
 
3738
6584
  ```typescript
3739
- public toGithub(): GithubStepConfig
3740
- ```
6585
+ import { VersioningOutputs } from 'projen-pipelines'
3741
6586
 
3742
- Generates a configuration for a GitHub Actions step.
6587
+ VersioningOutputs.minimal()
6588
+ ```
3743
6589
 
3744
- Should be implemented by subclasses.
6590
+ Create minimal output configuration (CloudFormation only, plain format).
3745
6591
 
3746
- ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.PipelineStep.toGitlab"></a>
6592
+ ##### `standard` <a name="standard" id="projen-pipelines.VersioningOutputs.standard"></a>
3747
6593
 
3748
6594
  ```typescript
3749
- public toGitlab(): GitlabStepConfig
6595
+ import { VersioningOutputs } from 'projen-pipelines'
6596
+
6597
+ VersioningOutputs.standard(options?: StandardOutputOptions)
3750
6598
  ```
3751
6599
 
3752
- Generates a configuration for a GitLab CI step.
6600
+ Create output configuration with CloudFormation and SSM Parameter Store.
3753
6601
 
3754
- Should be implemented by subclasses.
6602
+ ###### `options`<sup>Optional</sup> <a name="options" id="projen-pipelines.VersioningOutputs.standard.parameter.options"></a>
3755
6603
 
6604
+ - *Type:* <a href="#projen-pipelines.StandardOutputOptions">StandardOutputOptions</a>
3756
6605
 
6606
+ ---
3757
6607
 
3758
6608
 
3759
- ### ProjenScriptStep <a name="ProjenScriptStep" id="projen-pipelines.ProjenScriptStep"></a>
3760
6609
 
3761
- #### Initializers <a name="Initializers" id="projen-pipelines.ProjenScriptStep.Initializer"></a>
6610
+ ### VersioningSetup <a name="VersioningSetup" id="projen-pipelines.VersioningSetup"></a>
6611
+
6612
+ Sets up versioning tasks and integration for a project.
6613
+
6614
+ #### Initializers <a name="Initializers" id="projen-pipelines.VersioningSetup.Initializer"></a>
3762
6615
 
3763
6616
  ```typescript
3764
- import { ProjenScriptStep } from 'projen-pipelines'
6617
+ import { VersioningSetup } from 'projen-pipelines'
3765
6618
 
3766
- new ProjenScriptStep(project: Project, scriptName: string, args?: string)
6619
+ new VersioningSetup(project: Project, config: VersioningConfig)
3767
6620
  ```
3768
6621
 
3769
6622
  | **Name** | **Type** | **Description** |
3770
6623
  | --- | --- | --- |
3771
- | <code><a href="#projen-pipelines.ProjenScriptStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3772
- | <code><a href="#projen-pipelines.ProjenScriptStep.Initializer.parameter.scriptName">scriptName</a></code> | <code>string</code> | *No description.* |
3773
- | <code><a href="#projen-pipelines.ProjenScriptStep.Initializer.parameter.args">args</a></code> | <code>string</code> | *No description.* |
6624
+ | <code><a href="#projen-pipelines.VersioningSetup.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | *No description.* |
6625
+ | <code><a href="#projen-pipelines.VersioningSetup.Initializer.parameter.config">config</a></code> | <code><a href="#projen-pipelines.VersioningConfig">VersioningConfig</a></code> | *No description.* |
3774
6626
 
3775
6627
  ---
3776
6628
 
3777
- ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.ProjenScriptStep.Initializer.parameter.project"></a>
6629
+ ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.VersioningSetup.Initializer.parameter.project"></a>
3778
6630
 
3779
6631
  - *Type:* projen.Project
3780
6632
 
3781
- The projen project reference.
3782
-
3783
- ---
3784
-
3785
- ##### `scriptName`<sup>Required</sup> <a name="scriptName" id="projen-pipelines.ProjenScriptStep.Initializer.parameter.scriptName"></a>
3786
-
3787
- - *Type:* string
3788
-
3789
6633
  ---
3790
6634
 
3791
- ##### `args`<sup>Optional</sup> <a name="args" id="projen-pipelines.ProjenScriptStep.Initializer.parameter.args"></a>
6635
+ ##### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.VersioningSetup.Initializer.parameter.config"></a>
3792
6636
 
3793
- - *Type:* string
6637
+ - *Type:* <a href="#projen-pipelines.VersioningConfig">VersioningConfig</a>
3794
6638
 
3795
6639
  ---
3796
6640
 
@@ -3798,317 +6642,382 @@ The projen project reference.
3798
6642
 
3799
6643
  | **Name** | **Description** |
3800
6644
  | --- | --- |
3801
- | <code><a href="#projen-pipelines.ProjenScriptStep.toBash">toBash</a></code> | Converts the step into a Bash script configuration. |
3802
- | <code><a href="#projen-pipelines.ProjenScriptStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the step into a CodeCatalyst Actions step configuration. |
3803
- | <code><a href="#projen-pipelines.ProjenScriptStep.toGithub">toGithub</a></code> | Converts the step into a GitHub Actions step configuration. |
3804
- | <code><a href="#projen-pipelines.ProjenScriptStep.toGitlab">toGitlab</a></code> | Converts the step into a GitLab CI configuration. |
6645
+ | <code><a href="#projen-pipelines.VersioningSetup.setup">setup</a></code> | Set up all versioning-related tasks and configurations. |
3805
6646
 
3806
6647
  ---
3807
6648
 
3808
- ##### `toBash` <a name="toBash" id="projen-pipelines.ProjenScriptStep.toBash"></a>
6649
+ ##### `setup` <a name="setup" id="projen-pipelines.VersioningSetup.setup"></a>
3809
6650
 
3810
6651
  ```typescript
3811
- public toBash(): BashStepConfig
6652
+ public setup(): void
3812
6653
  ```
3813
6654
 
3814
- Converts the step into a Bash script configuration.
6655
+ Set up all versioning-related tasks and configurations.
3815
6656
 
3816
- ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.ProjenScriptStep.toCodeCatalyst"></a>
3817
6657
 
3818
- ```typescript
3819
- public toCodeCatalyst(): CodeCatalystStepConfig
3820
- ```
3821
6658
 
3822
- Converts the step into a CodeCatalyst Actions step configuration.
3823
6659
 
3824
- ##### `toGithub` <a name="toGithub" id="projen-pipelines.ProjenScriptStep.toGithub"></a>
6660
+ ### VersioningStrategy <a name="VersioningStrategy" id="projen-pipelines.VersioningStrategy"></a>
3825
6661
 
3826
- ```typescript
3827
- public toGithub(): GithubStepConfig
3828
- ```
6662
+ - *Implements:* <a href="#projen-pipelines.IVersioningStrategy">IVersioningStrategy</a>
3829
6663
 
3830
- Converts the step into a GitHub Actions step configuration.
6664
+ Composite versioning strategy that combines multiple strategies.
3831
6665
 
3832
- ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.ProjenScriptStep.toGitlab"></a>
3833
6666
 
3834
- ```typescript
3835
- public toGitlab(): GitlabStepConfig
3836
- ```
6667
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
3837
6668
 
3838
- Converts the step into a GitLab CI configuration.
6669
+ | **Name** | **Description** |
6670
+ | --- | --- |
6671
+ | <code><a href="#projen-pipelines.VersioningStrategy.buildNumber">buildNumber</a></code> | Create a build number based strategy. |
6672
+ | <code><a href="#projen-pipelines.VersioningStrategy.commitCount">commitCount</a></code> | *No description.* |
6673
+ | <code><a href="#projen-pipelines.VersioningStrategy.commitHash">commitHash</a></code> | *No description.* |
6674
+ | <code><a href="#projen-pipelines.VersioningStrategy.create">create</a></code> | Create a composite strategy with custom format and components. |
6675
+ | <code><a href="#projen-pipelines.VersioningStrategy.gitTag">gitTag</a></code> | *No description.* |
6676
+ | <code><a href="#projen-pipelines.VersioningStrategy.packageJson">packageJson</a></code> | *No description.* |
3839
6677
 
6678
+ ---
3840
6679
 
6680
+ ##### `buildNumber` <a name="buildNumber" id="projen-pipelines.VersioningStrategy.buildNumber"></a>
3841
6681
 
6682
+ ```typescript
6683
+ import { VersioningStrategy } from 'projen-pipelines'
3842
6684
 
3843
- ### SimpleCommandStep <a name="SimpleCommandStep" id="projen-pipelines.SimpleCommandStep"></a>
6685
+ VersioningStrategy.buildNumber(config?: BuildNumberConfig)
6686
+ ```
3844
6687
 
3845
- Concrete implementation of PipelineStep that executes simple commands.
6688
+ Create a build number based strategy.
3846
6689
 
3847
- #### Initializers <a name="Initializers" id="projen-pipelines.SimpleCommandStep.Initializer"></a>
6690
+ ###### `config`<sup>Optional</sup> <a name="config" id="projen-pipelines.VersioningStrategy.buildNumber.parameter.config"></a>
6691
+
6692
+ - *Type:* <a href="#projen-pipelines.BuildNumberConfig">BuildNumberConfig</a>
6693
+
6694
+ ---
6695
+
6696
+ ##### `commitCount` <a name="commitCount" id="projen-pipelines.VersioningStrategy.commitCount"></a>
3848
6697
 
3849
6698
  ```typescript
3850
- import { SimpleCommandStep } from 'projen-pipelines'
6699
+ import { VersioningStrategy } from 'projen-pipelines'
3851
6700
 
3852
- new SimpleCommandStep(project: Project, commands: string[])
6701
+ VersioningStrategy.commitCount(config?: CommitCountConfig)
3853
6702
  ```
3854
6703
 
3855
- | **Name** | **Type** | **Description** |
3856
- | --- | --- | --- |
3857
- | <code><a href="#projen-pipelines.SimpleCommandStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3858
- | <code><a href="#projen-pipelines.SimpleCommandStep.Initializer.parameter.commands">commands</a></code> | <code>string[]</code> | - Shell commands to execute. |
6704
+ ###### `config`<sup>Optional</sup> <a name="config" id="projen-pipelines.VersioningStrategy.commitCount.parameter.config"></a>
6705
+
6706
+ - *Type:* <a href="#projen-pipelines.CommitCountConfig">CommitCountConfig</a>
3859
6707
 
3860
6708
  ---
3861
6709
 
3862
- ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.SimpleCommandStep.Initializer.parameter.project"></a>
6710
+ ##### `commitHash` <a name="commitHash" id="projen-pipelines.VersioningStrategy.commitHash"></a>
3863
6711
 
3864
- - *Type:* projen.Project
6712
+ ```typescript
6713
+ import { VersioningStrategy } from 'projen-pipelines'
3865
6714
 
3866
- The projen project reference.
6715
+ VersioningStrategy.commitHash()
6716
+ ```
3867
6717
 
3868
- ---
6718
+ ##### `create` <a name="create" id="projen-pipelines.VersioningStrategy.create"></a>
3869
6719
 
3870
- ##### `commands`<sup>Required</sup> <a name="commands" id="projen-pipelines.SimpleCommandStep.Initializer.parameter.commands"></a>
6720
+ ```typescript
6721
+ import { VersioningStrategy } from 'projen-pipelines'
3871
6722
 
3872
- - *Type:* string[]
6723
+ VersioningStrategy.create(format: string, components: VersioningStrategyComponents)
6724
+ ```
3873
6725
 
3874
- Shell commands to execute.
6726
+ Create a composite strategy with custom format and components.
6727
+
6728
+ ###### `format`<sup>Required</sup> <a name="format" id="projen-pipelines.VersioningStrategy.create.parameter.format"></a>
6729
+
6730
+ - *Type:* string
3875
6731
 
3876
6732
  ---
3877
6733
 
3878
- #### Methods <a name="Methods" id="Methods"></a>
6734
+ ###### `components`<sup>Required</sup> <a name="components" id="projen-pipelines.VersioningStrategy.create.parameter.components"></a>
3879
6735
 
3880
- | **Name** | **Description** |
3881
- | --- | --- |
3882
- | <code><a href="#projen-pipelines.SimpleCommandStep.toBash">toBash</a></code> | Converts the step into a Bash script configuration. |
3883
- | <code><a href="#projen-pipelines.SimpleCommandStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the step into a CodeCatalyst Actions step configuration. |
3884
- | <code><a href="#projen-pipelines.SimpleCommandStep.toGithub">toGithub</a></code> | Converts the step into a GitHub Actions step configuration. |
3885
- | <code><a href="#projen-pipelines.SimpleCommandStep.toGitlab">toGitlab</a></code> | Converts the step into a GitLab CI configuration. |
6736
+ - *Type:* <a href="#projen-pipelines.VersioningStrategyComponents">VersioningStrategyComponents</a>
3886
6737
 
3887
6738
  ---
3888
6739
 
3889
- ##### `toBash` <a name="toBash" id="projen-pipelines.SimpleCommandStep.toBash"></a>
6740
+ ##### `gitTag` <a name="gitTag" id="projen-pipelines.VersioningStrategy.gitTag"></a>
3890
6741
 
3891
6742
  ```typescript
3892
- public toBash(): BashStepConfig
6743
+ import { VersioningStrategy } from 'projen-pipelines'
6744
+
6745
+ VersioningStrategy.gitTag(config?: GitTagConfig)
3893
6746
  ```
3894
6747
 
3895
- Converts the step into a Bash script configuration.
6748
+ ###### `config`<sup>Optional</sup> <a name="config" id="projen-pipelines.VersioningStrategy.gitTag.parameter.config"></a>
3896
6749
 
3897
- ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.SimpleCommandStep.toCodeCatalyst"></a>
6750
+ - *Type:* <a href="#projen-pipelines.GitTagConfig">GitTagConfig</a>
6751
+
6752
+ ---
6753
+
6754
+ ##### `packageJson` <a name="packageJson" id="projen-pipelines.VersioningStrategy.packageJson"></a>
3898
6755
 
3899
6756
  ```typescript
3900
- public toCodeCatalyst(): CodeCatalystStepConfig
6757
+ import { VersioningStrategy } from 'projen-pipelines'
6758
+
6759
+ VersioningStrategy.packageJson(config?: PackageJsonConfig)
3901
6760
  ```
3902
6761
 
3903
- Converts the step into a CodeCatalyst Actions step configuration.
6762
+ ###### `config`<sup>Optional</sup> <a name="config" id="projen-pipelines.VersioningStrategy.packageJson.parameter.config"></a>
3904
6763
 
3905
- ##### `toGithub` <a name="toGithub" id="projen-pipelines.SimpleCommandStep.toGithub"></a>
6764
+ - *Type:* <a href="#projen-pipelines.PackageJsonConfig">PackageJsonConfig</a>
6765
+
6766
+ ---
6767
+
6768
+ #### Properties <a name="Properties" id="Properties"></a>
6769
+
6770
+ | **Name** | **Type** | **Description** |
6771
+ | --- | --- | --- |
6772
+ | <code><a href="#projen-pipelines.VersioningStrategy.property.components">components</a></code> | <code><a href="#projen-pipelines.VersioningStrategyComponents">VersioningStrategyComponents</a></code> | Components to include. |
6773
+ | <code><a href="#projen-pipelines.VersioningStrategy.property.format">format</a></code> | <code>string</code> | Version format template Variables: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {commit-hash:8}, {branch}, {build-number}. |
6774
+
6775
+ ---
6776
+
6777
+ ##### `components`<sup>Required</sup> <a name="components" id="projen-pipelines.VersioningStrategy.property.components"></a>
3906
6778
 
3907
6779
  ```typescript
3908
- public toGithub(): GithubStepConfig
6780
+ public readonly components: VersioningStrategyComponents;
3909
6781
  ```
3910
6782
 
3911
- Converts the step into a GitHub Actions step configuration.
6783
+ - *Type:* <a href="#projen-pipelines.VersioningStrategyComponents">VersioningStrategyComponents</a>
3912
6784
 
3913
- ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.SimpleCommandStep.toGitlab"></a>
6785
+ Components to include.
6786
+
6787
+ ---
6788
+
6789
+ ##### `format`<sup>Required</sup> <a name="format" id="projen-pipelines.VersioningStrategy.property.format"></a>
3914
6790
 
3915
6791
  ```typescript
3916
- public toGitlab(): GitlabStepConfig
6792
+ public readonly format: string;
3917
6793
  ```
3918
6794
 
3919
- Converts the step into a GitLab CI configuration.
6795
+ - *Type:* string
3920
6796
 
6797
+ Version format template Variables: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {commit-hash:8}, {branch}, {build-number}.
3921
6798
 
6799
+ ---
3922
6800
 
3923
6801
 
3924
- ### StepSequence <a name="StepSequence" id="projen-pipelines.StepSequence"></a>
6802
+ ## Protocols <a name="Protocols" id="Protocols"></a>
3925
6803
 
3926
- #### Initializers <a name="Initializers" id="projen-pipelines.StepSequence.Initializer"></a>
6804
+ ### IVersionInfo <a name="IVersionInfo" id="projen-pipelines.IVersionInfo"></a>
3927
6805
 
3928
- ```typescript
3929
- import { StepSequence } from 'projen-pipelines'
6806
+ - *Implemented By:* <a href="#projen-pipelines.VersionInfo">VersionInfo</a>, <a href="#projen-pipelines.IVersionInfo">IVersionInfo</a>
3930
6807
 
3931
- new StepSequence(project: Project, steps: PipelineStep[])
3932
- ```
6808
+
6809
+ #### Properties <a name="Properties" id="Properties"></a>
3933
6810
 
3934
6811
  | **Name** | **Type** | **Description** |
3935
6812
  | --- | --- | --- |
3936
- | <code><a href="#projen-pipelines.StepSequence.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
3937
- | <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. |
6813
+ | <code><a href="#projen-pipelines.IVersionInfo.property.branch">branch</a></code> | <code>string</code> | *No description.* |
6814
+ | <code><a href="#projen-pipelines.IVersionInfo.property.commitCount">commitCount</a></code> | <code>number</code> | Commit count information. |
6815
+ | <code><a href="#projen-pipelines.IVersionInfo.property.commitHash">commitHash</a></code> | <code>string</code> | Git information (ALWAYS included). |
6816
+ | <code><a href="#projen-pipelines.IVersionInfo.property.commitHashShort">commitHashShort</a></code> | <code>string</code> | *No description.* |
6817
+ | <code><a href="#projen-pipelines.IVersionInfo.property.deployedAt">deployedAt</a></code> | <code>string</code> | Deployment metadata. |
6818
+ | <code><a href="#projen-pipelines.IVersionInfo.property.deployedBy">deployedBy</a></code> | <code>string</code> | *No description.* |
6819
+ | <code><a href="#projen-pipelines.IVersionInfo.property.environment">environment</a></code> | <code>string</code> | *No description.* |
6820
+ | <code><a href="#projen-pipelines.IVersionInfo.property.version">version</a></code> | <code>string</code> | Primary version string. |
6821
+ | <code><a href="#projen-pipelines.IVersionInfo.property.buildNumber">buildNumber</a></code> | <code>string</code> | *No description.* |
6822
+ | <code><a href="#projen-pipelines.IVersionInfo.property.commitsSinceTag">commitsSinceTag</a></code> | <code>number</code> | *No description.* |
6823
+ | <code><a href="#projen-pipelines.IVersionInfo.property.packageVersion">packageVersion</a></code> | <code>string</code> | Package.json information (if applicable). |
6824
+ | <code><a href="#projen-pipelines.IVersionInfo.property.pipelineVersion">pipelineVersion</a></code> | <code>string</code> | *No description.* |
6825
+ | <code><a href="#projen-pipelines.IVersionInfo.property.repository">repository</a></code> | <code>string</code> | Additional metadata. |
6826
+ | <code><a href="#projen-pipelines.IVersionInfo.property.tag">tag</a></code> | <code>string</code> | Optional git tag information. |
3938
6827
 
3939
6828
  ---
3940
6829
 
3941
- ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.StepSequence.Initializer.parameter.project"></a>
6830
+ ##### `branch`<sup>Required</sup> <a name="branch" id="projen-pipelines.IVersionInfo.property.branch"></a>
3942
6831
 
3943
- - *Type:* projen.Project
6832
+ ```typescript
6833
+ public readonly branch: string;
6834
+ ```
3944
6835
 
3945
- The projen project reference.
6836
+ - *Type:* string
3946
6837
 
3947
6838
  ---
3948
6839
 
3949
- ##### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.StepSequence.Initializer.parameter.steps"></a>
6840
+ ##### `commitCount`<sup>Required</sup> <a name="commitCount" id="projen-pipelines.IVersionInfo.property.commitCount"></a>
3950
6841
 
3951
- - *Type:* <a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
6842
+ ```typescript
6843
+ public readonly commitCount: number;
6844
+ ```
3952
6845
 
3953
- The sequence of pipeline steps.
6846
+ - *Type:* number
6847
+
6848
+ Commit count information.
3954
6849
 
3955
6850
  ---
3956
6851
 
3957
- #### Methods <a name="Methods" id="Methods"></a>
6852
+ ##### `commitHash`<sup>Required</sup> <a name="commitHash" id="projen-pipelines.IVersionInfo.property.commitHash"></a>
3958
6853
 
3959
- | **Name** | **Description** |
3960
- | --- | --- |
3961
- | <code><a href="#projen-pipelines.StepSequence.toBash">toBash</a></code> | Converts the sequence of steps into a Bash script configuration. |
3962
- | <code><a href="#projen-pipelines.StepSequence.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the sequence of steps into a CodeCatalyst Actions step configuration. |
3963
- | <code><a href="#projen-pipelines.StepSequence.toGithub">toGithub</a></code> | Converts the sequence of steps into a GitHub Actions step configuration. |
3964
- | <code><a href="#projen-pipelines.StepSequence.toGitlab">toGitlab</a></code> | Converts the sequence of steps into a GitLab CI configuration. |
3965
- | <code><a href="#projen-pipelines.StepSequence.addSteps">addSteps</a></code> | *No description.* |
3966
- | <code><a href="#projen-pipelines.StepSequence.prependSteps">prependSteps</a></code> | *No description.* |
6854
+ ```typescript
6855
+ public readonly commitHash: string;
6856
+ ```
6857
+
6858
+ - *Type:* string
6859
+
6860
+ Git information (ALWAYS included).
3967
6861
 
3968
6862
  ---
3969
6863
 
3970
- ##### `toBash` <a name="toBash" id="projen-pipelines.StepSequence.toBash"></a>
6864
+ ##### `commitHashShort`<sup>Required</sup> <a name="commitHashShort" id="projen-pipelines.IVersionInfo.property.commitHashShort"></a>
3971
6865
 
3972
6866
  ```typescript
3973
- public toBash(): BashStepConfig
6867
+ public readonly commitHashShort: string;
3974
6868
  ```
3975
6869
 
3976
- Converts the sequence of steps into a Bash script configuration.
6870
+ - *Type:* string
3977
6871
 
3978
- ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.StepSequence.toCodeCatalyst"></a>
6872
+ ---
6873
+
6874
+ ##### `deployedAt`<sup>Required</sup> <a name="deployedAt" id="projen-pipelines.IVersionInfo.property.deployedAt"></a>
3979
6875
 
3980
6876
  ```typescript
3981
- public toCodeCatalyst(): CodeCatalystStepConfig
6877
+ public readonly deployedAt: string;
3982
6878
  ```
3983
6879
 
3984
- Converts the sequence of steps into a CodeCatalyst Actions step configuration.
6880
+ - *Type:* string
3985
6881
 
3986
- ##### `toGithub` <a name="toGithub" id="projen-pipelines.StepSequence.toGithub"></a>
6882
+ Deployment metadata.
6883
+
6884
+ ---
6885
+
6886
+ ##### `deployedBy`<sup>Required</sup> <a name="deployedBy" id="projen-pipelines.IVersionInfo.property.deployedBy"></a>
3987
6887
 
3988
6888
  ```typescript
3989
- public toGithub(): GithubStepConfig
6889
+ public readonly deployedBy: string;
3990
6890
  ```
3991
6891
 
3992
- Converts the sequence of steps into a GitHub Actions step configuration.
6892
+ - *Type:* string
3993
6893
 
3994
- ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.StepSequence.toGitlab"></a>
6894
+ ---
6895
+
6896
+ ##### `environment`<sup>Required</sup> <a name="environment" id="projen-pipelines.IVersionInfo.property.environment"></a>
3995
6897
 
3996
6898
  ```typescript
3997
- public toGitlab(): GitlabStepConfig
6899
+ public readonly environment: string;
3998
6900
  ```
3999
6901
 
4000
- Converts the sequence of steps into a GitLab CI configuration.
6902
+ - *Type:* string
4001
6903
 
4002
- ##### `addSteps` <a name="addSteps" id="projen-pipelines.StepSequence.addSteps"></a>
6904
+ ---
6905
+
6906
+ ##### `version`<sup>Required</sup> <a name="version" id="projen-pipelines.IVersionInfo.property.version"></a>
4003
6907
 
4004
6908
  ```typescript
4005
- public addSteps(steps: ...PipelineStep[]): void
6909
+ public readonly version: string;
4006
6910
  ```
4007
6911
 
4008
- ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.StepSequence.addSteps.parameter.steps"></a>
6912
+ - *Type:* string
4009
6913
 
4010
- - *Type:* ...<a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
6914
+ Primary version string.
4011
6915
 
4012
6916
  ---
4013
6917
 
4014
- ##### `prependSteps` <a name="prependSteps" id="projen-pipelines.StepSequence.prependSteps"></a>
6918
+ ##### `buildNumber`<sup>Optional</sup> <a name="buildNumber" id="projen-pipelines.IVersionInfo.property.buildNumber"></a>
4015
6919
 
4016
6920
  ```typescript
4017
- public prependSteps(steps: ...PipelineStep[]): void
6921
+ public readonly buildNumber: string;
4018
6922
  ```
4019
6923
 
4020
- ###### `steps`<sup>Required</sup> <a name="steps" id="projen-pipelines.StepSequence.prependSteps.parameter.steps"></a>
4021
-
4022
- - *Type:* ...<a href="#projen-pipelines.PipelineStep">PipelineStep</a>[]
6924
+ - *Type:* string
4023
6925
 
4024
6926
  ---
4025
6927
 
6928
+ ##### `commitsSinceTag`<sup>Optional</sup> <a name="commitsSinceTag" id="projen-pipelines.IVersionInfo.property.commitsSinceTag"></a>
4026
6929
 
6930
+ ```typescript
6931
+ public readonly commitsSinceTag: number;
6932
+ ```
4027
6933
 
6934
+ - *Type:* number
4028
6935
 
4029
- ### UploadArtifactStep <a name="UploadArtifactStep" id="projen-pipelines.UploadArtifactStep"></a>
6936
+ ---
4030
6937
 
4031
- #### Initializers <a name="Initializers" id="projen-pipelines.UploadArtifactStep.Initializer"></a>
6938
+ ##### `packageVersion`<sup>Optional</sup> <a name="packageVersion" id="projen-pipelines.IVersionInfo.property.packageVersion"></a>
4032
6939
 
4033
6940
  ```typescript
4034
- import { UploadArtifactStep } from 'projen-pipelines'
4035
-
4036
- new UploadArtifactStep(project: Project, config: UploadArtifactStepConfig)
6941
+ public readonly packageVersion: string;
4037
6942
  ```
4038
6943
 
4039
- | **Name** | **Type** | **Description** |
4040
- | --- | --- | --- |
4041
- | <code><a href="#projen-pipelines.UploadArtifactStep.Initializer.parameter.project">project</a></code> | <code>projen.Project</code> | - The projen project reference. |
4042
- | <code><a href="#projen-pipelines.UploadArtifactStep.Initializer.parameter.config">config</a></code> | <code><a href="#projen-pipelines.UploadArtifactStepConfig">UploadArtifactStepConfig</a></code> | *No description.* |
6944
+ - *Type:* string
6945
+
6946
+ Package.json information (if applicable).
4043
6947
 
4044
6948
  ---
4045
6949
 
4046
- ##### `project`<sup>Required</sup> <a name="project" id="projen-pipelines.UploadArtifactStep.Initializer.parameter.project"></a>
6950
+ ##### `pipelineVersion`<sup>Optional</sup> <a name="pipelineVersion" id="projen-pipelines.IVersionInfo.property.pipelineVersion"></a>
4047
6951
 
4048
- - *Type:* projen.Project
6952
+ ```typescript
6953
+ public readonly pipelineVersion: string;
6954
+ ```
4049
6955
 
4050
- The projen project reference.
6956
+ - *Type:* string
4051
6957
 
4052
6958
  ---
4053
6959
 
4054
- ##### `config`<sup>Required</sup> <a name="config" id="projen-pipelines.UploadArtifactStep.Initializer.parameter.config"></a>
4055
-
4056
- - *Type:* <a href="#projen-pipelines.UploadArtifactStepConfig">UploadArtifactStepConfig</a>
6960
+ ##### `repository`<sup>Optional</sup> <a name="repository" id="projen-pipelines.IVersionInfo.property.repository"></a>
4057
6961
 
4058
- ---
6962
+ ```typescript
6963
+ public readonly repository: string;
6964
+ ```
4059
6965
 
4060
- #### Methods <a name="Methods" id="Methods"></a>
6966
+ - *Type:* string
4061
6967
 
4062
- | **Name** | **Description** |
4063
- | --- | --- |
4064
- | <code><a href="#projen-pipelines.UploadArtifactStep.toBash">toBash</a></code> | Generates a configuration for a bash script step. |
4065
- | <code><a href="#projen-pipelines.UploadArtifactStep.toCodeCatalyst">toCodeCatalyst</a></code> | Converts the step into a CodeCatalyst Actions step configuration. |
4066
- | <code><a href="#projen-pipelines.UploadArtifactStep.toGithub">toGithub</a></code> | Generates a configuration for a GitHub Actions step. |
4067
- | <code><a href="#projen-pipelines.UploadArtifactStep.toGitlab">toGitlab</a></code> | Generates a configuration for a GitLab CI step. |
6968
+ Additional metadata.
4068
6969
 
4069
6970
  ---
4070
6971
 
4071
- ##### `toBash` <a name="toBash" id="projen-pipelines.UploadArtifactStep.toBash"></a>
6972
+ ##### `tag`<sup>Optional</sup> <a name="tag" id="projen-pipelines.IVersionInfo.property.tag"></a>
4072
6973
 
4073
6974
  ```typescript
4074
- public toBash(): BashStepConfig
6975
+ public readonly tag: string;
4075
6976
  ```
4076
6977
 
4077
- Generates a configuration for a bash script step.
6978
+ - *Type:* string
4078
6979
 
4079
- Should be implemented by subclasses.
6980
+ Optional git tag information.
4080
6981
 
4081
- ##### `toCodeCatalyst` <a name="toCodeCatalyst" id="projen-pipelines.UploadArtifactStep.toCodeCatalyst"></a>
6982
+ ---
4082
6983
 
4083
- ```typescript
4084
- public toCodeCatalyst(): CodeCatalystStepConfig
4085
- ```
6984
+ ### IVersioningStrategy <a name="IVersioningStrategy" id="projen-pipelines.IVersioningStrategy"></a>
4086
6985
 
4087
- Converts the step into a CodeCatalyst Actions step configuration.
6986
+ - *Implemented By:* <a href="#projen-pipelines.VersioningStrategy">VersioningStrategy</a>, <a href="#projen-pipelines.IVersioningStrategy">IVersioningStrategy</a>
4088
6987
 
4089
- ##### `toGithub` <a name="toGithub" id="projen-pipelines.UploadArtifactStep.toGithub"></a>
4090
6988
 
4091
- ```typescript
4092
- public toGithub(): GithubStepConfig
4093
- ```
6989
+ #### Properties <a name="Properties" id="Properties"></a>
4094
6990
 
4095
- Generates a configuration for a GitHub Actions step.
6991
+ | **Name** | **Type** | **Description** |
6992
+ | --- | --- | --- |
6993
+ | <code><a href="#projen-pipelines.IVersioningStrategy.property.components">components</a></code> | <code><a href="#projen-pipelines.VersioningStrategyComponents">VersioningStrategyComponents</a></code> | Components to include. |
6994
+ | <code><a href="#projen-pipelines.IVersioningStrategy.property.format">format</a></code> | <code>string</code> | Version format template Variables: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {commit-hash:8}, {branch}, {build-number}. |
4096
6995
 
4097
- Should be implemented by subclasses.
6996
+ ---
4098
6997
 
4099
- ##### `toGitlab` <a name="toGitlab" id="projen-pipelines.UploadArtifactStep.toGitlab"></a>
6998
+ ##### `components`<sup>Required</sup> <a name="components" id="projen-pipelines.IVersioningStrategy.property.components"></a>
4100
6999
 
4101
7000
  ```typescript
4102
- public toGitlab(): GitlabStepConfig
7001
+ public readonly components: VersioningStrategyComponents;
4103
7002
  ```
4104
7003
 
4105
- Generates a configuration for a GitLab CI step.
7004
+ - *Type:* <a href="#projen-pipelines.VersioningStrategyComponents">VersioningStrategyComponents</a>
4106
7005
 
4107
- Should be implemented by subclasses.
7006
+ Components to include.
7007
+
7008
+ ---
7009
+
7010
+ ##### `format`<sup>Required</sup> <a name="format" id="projen-pipelines.IVersioningStrategy.property.format"></a>
4108
7011
 
7012
+ ```typescript
7013
+ public readonly format: string;
7014
+ ```
4109
7015
 
7016
+ - *Type:* string
4110
7017
 
7018
+ Version format template Variables: {git-tag}, {package-version}, {commit-count}, {commit-hash}, {commit-hash:8}, {branch}, {build-number}.
4111
7019
 
7020
+ ---
4112
7021
 
4113
7022
  ## Enums <a name="Enums" id="Enums"></a>
4114
7023