cdklabs-projen-project-types 0.3.5 → 0.3.6
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/.jsii +263 -148
- package/API.md +156 -16
- package/lib/cdk-construct-library-options.d.ts +7 -2
- package/lib/cdk-construct-library-options.js +1 -1
- package/lib/cdk-jsii-options.d.ts +7 -2
- package/lib/cdk-jsii-options.js +1 -1
- package/lib/cdk.js +3 -3
- package/lib/cdklabs.js +3 -3
- package/lib/common-options.js +10 -8
- package/lib/jsii.js +1 -1
- package/lib/retryautomerge.d.ts +11 -0
- package/lib/retryautomerge.js +49 -0
- package/lib/rosetta.js +1 -1
- package/lib/yarn/monorepo-options.d.ts +6 -1
- package/lib/yarn/monorepo-options.js +1 -1
- package/lib/yarn/monorepo-release-options.d.ts +5 -0
- package/lib/yarn/monorepo-release-options.js +1 -1
- package/lib/yarn/monorepo-release.js +1 -1
- package/lib/yarn/monorepo.js +2 -2
- package/lib/yarn/typescript-workspace-options.d.ts +6 -1
- package/lib/yarn/typescript-workspace-options.js +1 -1
- package/lib/yarn/typescript-workspace-release.js +1 -1
- package/lib/yarn/typescript-workspace.js +1 -1
- package/package.json +6 -6
package/API.md
CHANGED
|
@@ -14970,6 +14970,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
14970
14970
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
14971
14971
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
14972
14972
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
14973
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
14973
14974
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
14974
14975
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
14975
14976
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -16171,7 +16172,7 @@ public readonly jsiiVersion: string;
|
|
|
16171
16172
|
```
|
|
16172
16173
|
|
|
16173
16174
|
- *Type:* string
|
|
16174
|
-
- *Default:* "~5.
|
|
16175
|
+
- *Default:* "~5.8.0"
|
|
16175
16176
|
|
|
16176
16177
|
Version of the jsii compiler to use.
|
|
16177
16178
|
|
|
@@ -17253,6 +17254,19 @@ DEPRECATED: renamed to `release`.
|
|
|
17253
17254
|
|
|
17254
17255
|
---
|
|
17255
17256
|
|
|
17257
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseWorkflowEnv"></a>
|
|
17258
|
+
|
|
17259
|
+
```typescript
|
|
17260
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
17261
|
+
```
|
|
17262
|
+
|
|
17263
|
+
- *Type:* {[ key: string ]: string}
|
|
17264
|
+
- *Default:* {}
|
|
17265
|
+
|
|
17266
|
+
Build environment variables for release workflows.
|
|
17267
|
+
|
|
17268
|
+
---
|
|
17269
|
+
|
|
17256
17270
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseWorkflowName"></a>
|
|
17257
17271
|
|
|
17258
17272
|
```typescript
|
|
@@ -17664,7 +17678,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
17664
17678
|
```
|
|
17665
17679
|
|
|
17666
17680
|
- *Type:* projen.github.GitIdentity
|
|
17667
|
-
- *Default:* GitHub Actions
|
|
17681
|
+
- *Default:* default GitHub Actions user
|
|
17668
17682
|
|
|
17669
17683
|
The git identity to use in workflows.
|
|
17670
17684
|
|
|
@@ -17890,6 +17904,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
17890
17904
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
17891
17905
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
17892
17906
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
17907
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
17893
17908
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
17894
17909
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
17895
17910
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -18887,7 +18902,7 @@ public readonly jsiiVersion: string;
|
|
|
18887
18902
|
```
|
|
18888
18903
|
|
|
18889
18904
|
- *Type:* string
|
|
18890
|
-
- *Default:* "~5.
|
|
18905
|
+
- *Default:* "~5.8.0"
|
|
18891
18906
|
|
|
18892
18907
|
Version of the jsii compiler to use.
|
|
18893
18908
|
|
|
@@ -19938,6 +19953,19 @@ DEPRECATED: renamed to `release`.
|
|
|
19938
19953
|
|
|
19939
19954
|
---
|
|
19940
19955
|
|
|
19956
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseWorkflowEnv"></a>
|
|
19957
|
+
|
|
19958
|
+
```typescript
|
|
19959
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
19960
|
+
```
|
|
19961
|
+
|
|
19962
|
+
- *Type:* {[ key: string ]: string}
|
|
19963
|
+
- *Default:* {}
|
|
19964
|
+
|
|
19965
|
+
Build environment variables for release workflows.
|
|
19966
|
+
|
|
19967
|
+
---
|
|
19968
|
+
|
|
19941
19969
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseWorkflowName"></a>
|
|
19942
19970
|
|
|
19943
19971
|
```typescript
|
|
@@ -20337,7 +20365,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
20337
20365
|
```
|
|
20338
20366
|
|
|
20339
20367
|
- *Type:* projen.github.GitIdentity
|
|
20340
|
-
- *Default:* GitHub Actions
|
|
20368
|
+
- *Default:* default GitHub Actions user
|
|
20341
20369
|
|
|
20342
20370
|
The git identity to use in workflows.
|
|
20343
20371
|
|
|
@@ -20579,6 +20607,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
20579
20607
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
20580
20608
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
20581
20609
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
20610
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
20582
20611
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
20583
20612
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
20584
20613
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -21782,7 +21811,7 @@ public readonly jsiiVersion: string;
|
|
|
21782
21811
|
```
|
|
21783
21812
|
|
|
21784
21813
|
- *Type:* string
|
|
21785
|
-
- *Default:* "~5.
|
|
21814
|
+
- *Default:* "~5.8.0"
|
|
21786
21815
|
|
|
21787
21816
|
Version of the jsii compiler to use.
|
|
21788
21817
|
|
|
@@ -22864,6 +22893,19 @@ DEPRECATED: renamed to `release`.
|
|
|
22864
22893
|
|
|
22865
22894
|
---
|
|
22866
22895
|
|
|
22896
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseWorkflowEnv"></a>
|
|
22897
|
+
|
|
22898
|
+
```typescript
|
|
22899
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
22900
|
+
```
|
|
22901
|
+
|
|
22902
|
+
- *Type:* {[ key: string ]: string}
|
|
22903
|
+
- *Default:* {}
|
|
22904
|
+
|
|
22905
|
+
Build environment variables for release workflows.
|
|
22906
|
+
|
|
22907
|
+
---
|
|
22908
|
+
|
|
22867
22909
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseWorkflowName"></a>
|
|
22868
22910
|
|
|
22869
22911
|
```typescript
|
|
@@ -23275,7 +23317,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
23275
23317
|
```
|
|
23276
23318
|
|
|
23277
23319
|
- *Type:* projen.github.GitIdentity
|
|
23278
|
-
- *Default:* GitHub Actions
|
|
23320
|
+
- *Default:* default GitHub Actions user
|
|
23279
23321
|
|
|
23280
23322
|
The git identity to use in workflows.
|
|
23281
23323
|
|
|
@@ -23538,6 +23580,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
23538
23580
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
23539
23581
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
23540
23582
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
23583
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
23541
23584
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
23542
23585
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
23543
23586
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -24537,7 +24580,7 @@ public readonly jsiiVersion: string;
|
|
|
24537
24580
|
```
|
|
24538
24581
|
|
|
24539
24582
|
- *Type:* string
|
|
24540
|
-
- *Default:* "~5.
|
|
24583
|
+
- *Default:* "~5.8.0"
|
|
24541
24584
|
|
|
24542
24585
|
Version of the jsii compiler to use.
|
|
24543
24586
|
|
|
@@ -25588,6 +25631,19 @@ DEPRECATED: renamed to `release`.
|
|
|
25588
25631
|
|
|
25589
25632
|
---
|
|
25590
25633
|
|
|
25634
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseWorkflowEnv"></a>
|
|
25635
|
+
|
|
25636
|
+
```typescript
|
|
25637
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
25638
|
+
```
|
|
25639
|
+
|
|
25640
|
+
- *Type:* {[ key: string ]: string}
|
|
25641
|
+
- *Default:* {}
|
|
25642
|
+
|
|
25643
|
+
Build environment variables for release workflows.
|
|
25644
|
+
|
|
25645
|
+
---
|
|
25646
|
+
|
|
25591
25647
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseWorkflowName"></a>
|
|
25592
25648
|
|
|
25593
25649
|
```typescript
|
|
@@ -25987,7 +26043,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
25987
26043
|
```
|
|
25988
26044
|
|
|
25989
26045
|
- *Type:* projen.github.GitIdentity
|
|
25990
|
-
- *Default:* GitHub Actions
|
|
26046
|
+
- *Default:* default GitHub Actions user
|
|
25991
26047
|
|
|
25992
26048
|
The git identity to use in workflows.
|
|
25993
26049
|
|
|
@@ -26236,6 +26292,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
26236
26292
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
26237
26293
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
26238
26294
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
26295
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
26239
26296
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
26240
26297
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
26241
26298
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -28019,6 +28076,19 @@ DEPRECATED: renamed to `release`.
|
|
|
28019
28076
|
|
|
28020
28077
|
---
|
|
28021
28078
|
|
|
28079
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseWorkflowEnv"></a>
|
|
28080
|
+
|
|
28081
|
+
```typescript
|
|
28082
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
28083
|
+
```
|
|
28084
|
+
|
|
28085
|
+
- *Type:* {[ key: string ]: string}
|
|
28086
|
+
- *Default:* {}
|
|
28087
|
+
|
|
28088
|
+
Build environment variables for release workflows.
|
|
28089
|
+
|
|
28090
|
+
---
|
|
28091
|
+
|
|
28022
28092
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseWorkflowName"></a>
|
|
28023
28093
|
|
|
28024
28094
|
```typescript
|
|
@@ -28358,7 +28428,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
28358
28428
|
```
|
|
28359
28429
|
|
|
28360
28430
|
- *Type:* projen.github.GitIdentity
|
|
28361
|
-
- *Default:* GitHub Actions
|
|
28431
|
+
- *Default:* default GitHub Actions user
|
|
28362
28432
|
|
|
28363
28433
|
The git identity to use in workflows.
|
|
28364
28434
|
|
|
@@ -28587,6 +28657,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
28587
28657
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
28588
28658
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
|
|
28589
28659
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
28660
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
28590
28661
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
28591
28662
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
28592
28663
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -29985,6 +30056,19 @@ The release trigger to use.
|
|
|
29985
30056
|
|
|
29986
30057
|
---
|
|
29987
30058
|
|
|
30059
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseWorkflowEnv"></a>
|
|
30060
|
+
|
|
30061
|
+
```typescript
|
|
30062
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
30063
|
+
```
|
|
30064
|
+
|
|
30065
|
+
- *Type:* {[ key: string ]: string}
|
|
30066
|
+
- *Default:* {}
|
|
30067
|
+
|
|
30068
|
+
Build environment variables for release workflows.
|
|
30069
|
+
|
|
30070
|
+
---
|
|
30071
|
+
|
|
29988
30072
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseWorkflowName"></a>
|
|
29989
30073
|
|
|
29990
30074
|
```typescript
|
|
@@ -30581,7 +30665,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
30581
30665
|
```
|
|
30582
30666
|
|
|
30583
30667
|
- *Type:* projen.github.GitIdentity
|
|
30584
|
-
- *Default:* GitHub Actions
|
|
30668
|
+
- *Default:* default GitHub Actions user
|
|
30585
30669
|
|
|
30586
30670
|
The git identity to use in workflows.
|
|
30587
30671
|
|
|
@@ -31053,6 +31137,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
31053
31137
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
31054
31138
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
|
|
31055
31139
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
31140
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
31056
31141
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
31057
31142
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
31058
31143
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -32451,6 +32536,19 @@ The release trigger to use.
|
|
|
32451
32536
|
|
|
32452
32537
|
---
|
|
32453
32538
|
|
|
32539
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseWorkflowEnv"></a>
|
|
32540
|
+
|
|
32541
|
+
```typescript
|
|
32542
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
32543
|
+
```
|
|
32544
|
+
|
|
32545
|
+
- *Type:* {[ key: string ]: string}
|
|
32546
|
+
- *Default:* {}
|
|
32547
|
+
|
|
32548
|
+
Build environment variables for release workflows.
|
|
32549
|
+
|
|
32550
|
+
---
|
|
32551
|
+
|
|
32454
32552
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseWorkflowName"></a>
|
|
32455
32553
|
|
|
32456
32554
|
```typescript
|
|
@@ -33047,7 +33145,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
33047
33145
|
```
|
|
33048
33146
|
|
|
33049
33147
|
- *Type:* projen.github.GitIdentity
|
|
33050
|
-
- *Default:* GitHub Actions
|
|
33148
|
+
- *Default:* default GitHub Actions user
|
|
33051
33149
|
|
|
33052
33150
|
The git identity to use in workflows.
|
|
33053
33151
|
|
|
@@ -33556,6 +33654,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
33556
33654
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
33557
33655
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
33558
33656
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
33657
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
33559
33658
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
33560
33659
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
33561
33660
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -35339,6 +35438,19 @@ DEPRECATED: renamed to `release`.
|
|
|
35339
35438
|
|
|
35340
35439
|
---
|
|
35341
35440
|
|
|
35441
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseWorkflowEnv"></a>
|
|
35442
|
+
|
|
35443
|
+
```typescript
|
|
35444
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
35445
|
+
```
|
|
35446
|
+
|
|
35447
|
+
- *Type:* {[ key: string ]: string}
|
|
35448
|
+
- *Default:* {}
|
|
35449
|
+
|
|
35450
|
+
Build environment variables for release workflows.
|
|
35451
|
+
|
|
35452
|
+
---
|
|
35453
|
+
|
|
35342
35454
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseWorkflowName"></a>
|
|
35343
35455
|
|
|
35344
35456
|
```typescript
|
|
@@ -35678,7 +35790,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
35678
35790
|
```
|
|
35679
35791
|
|
|
35680
35792
|
- *Type:* projen.github.GitIdentity
|
|
35681
|
-
- *Default:* GitHub Actions
|
|
35793
|
+
- *Default:* default GitHub Actions user
|
|
35682
35794
|
|
|
35683
35795
|
The git identity to use in workflows.
|
|
35684
35796
|
|
|
@@ -35780,6 +35892,7 @@ const monorepoReleaseOptions: yarn.MonorepoReleaseOptions = { ... }
|
|
|
35780
35892
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
35781
35893
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
35782
35894
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
35895
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
35783
35896
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
35784
35897
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
35785
35898
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
|
|
@@ -36036,6 +36149,19 @@ The release trigger to use.
|
|
|
36036
36149
|
|
|
36037
36150
|
---
|
|
36038
36151
|
|
|
36152
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseWorkflowEnv"></a>
|
|
36153
|
+
|
|
36154
|
+
```typescript
|
|
36155
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
36156
|
+
```
|
|
36157
|
+
|
|
36158
|
+
- *Type:* {[ key: string ]: string}
|
|
36159
|
+
- *Default:* {}
|
|
36160
|
+
|
|
36161
|
+
Build environment variables for release workflows.
|
|
36162
|
+
|
|
36163
|
+
---
|
|
36164
|
+
|
|
36039
36165
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseWorkflowName"></a>
|
|
36040
36166
|
|
|
36041
36167
|
```typescript
|
|
@@ -36319,6 +36445,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
36319
36445
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
36320
36446
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
36321
36447
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
36448
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
36322
36449
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
36323
36450
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
|
|
36324
36451
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -36837,7 +36964,7 @@ Options for dependabot.
|
|
|
36837
36964
|
##### `deps`<sup>Optional</sup> <a name="deps" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.deps"></a>
|
|
36838
36965
|
|
|
36839
36966
|
```typescript
|
|
36840
|
-
public readonly deps: string | IWorkspaceReference[];
|
|
36967
|
+
public readonly deps: (string | IWorkspaceReference)[];
|
|
36841
36968
|
```
|
|
36842
36969
|
|
|
36843
36970
|
- *Type:* string | cdklabs-projen-project-types.yarn.IWorkspaceReference[]
|
|
@@ -36900,7 +37027,7 @@ Add a VSCode development environment (used for GitHub Codespaces).
|
|
|
36900
37027
|
##### `devDeps`<sup>Optional</sup> <a name="devDeps" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.devDeps"></a>
|
|
36901
37028
|
|
|
36902
37029
|
```typescript
|
|
36903
|
-
public readonly devDeps: string | IWorkspaceReference[];
|
|
37030
|
+
public readonly devDeps: (string | IWorkspaceReference)[];
|
|
36904
37031
|
```
|
|
36905
37032
|
|
|
36906
37033
|
- *Type:* string | cdklabs-projen-project-types.yarn.IWorkspaceReference[]
|
|
@@ -37584,7 +37711,7 @@ Options for `peerDeps`.
|
|
|
37584
37711
|
##### `peerDeps`<sup>Optional</sup> <a name="peerDeps" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.peerDeps"></a>
|
|
37585
37712
|
|
|
37586
37713
|
```typescript
|
|
37587
|
-
public readonly peerDeps: string | IWorkspaceReference[];
|
|
37714
|
+
public readonly peerDeps: (string | IWorkspaceReference)[];
|
|
37588
37715
|
```
|
|
37589
37716
|
|
|
37590
37717
|
- *Type:* string | cdklabs-projen-project-types.yarn.IWorkspaceReference[]
|
|
@@ -38088,6 +38215,19 @@ DEPRECATED: renamed to `release`.
|
|
|
38088
38215
|
|
|
38089
38216
|
---
|
|
38090
38217
|
|
|
38218
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseWorkflowEnv"></a>
|
|
38219
|
+
|
|
38220
|
+
```typescript
|
|
38221
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
38222
|
+
```
|
|
38223
|
+
|
|
38224
|
+
- *Type:* {[ key: string ]: string}
|
|
38225
|
+
- *Default:* {}
|
|
38226
|
+
|
|
38227
|
+
Build environment variables for release workflows.
|
|
38228
|
+
|
|
38229
|
+
---
|
|
38230
|
+
|
|
38091
38231
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseWorkflowName"></a>
|
|
38092
38232
|
|
|
38093
38233
|
```typescript
|
|
@@ -38402,7 +38542,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
38402
38542
|
```
|
|
38403
38543
|
|
|
38404
38544
|
- *Type:* projen.github.GitIdentity
|
|
38405
|
-
- *Default:* GitHub Actions
|
|
38545
|
+
- *Default:* default GitHub Actions user
|
|
38406
38546
|
|
|
38407
38547
|
The git identity to use in workflows.
|
|
38408
38548
|
|
|
@@ -480,7 +480,7 @@ export interface CdkConstructLibraryOptions {
|
|
|
480
480
|
* NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned
|
|
481
481
|
* and should remain on the same minor, so we recommend using a `~` dependency
|
|
482
482
|
* (e.g. `~5.0.0`).
|
|
483
|
-
* @default "~5.
|
|
483
|
+
* @default "~5.8.0"
|
|
484
484
|
*/
|
|
485
485
|
readonly jsiiVersion?: string;
|
|
486
486
|
/**
|
|
@@ -947,6 +947,11 @@ export interface CdkConstructLibraryOptions {
|
|
|
947
947
|
* @deprecated see `release`.
|
|
948
948
|
*/
|
|
949
949
|
readonly releaseWorkflow?: boolean;
|
|
950
|
+
/**
|
|
951
|
+
* Build environment variables for release workflows.
|
|
952
|
+
* @default {}
|
|
953
|
+
*/
|
|
954
|
+
readonly releaseWorkflowEnv?: Record<string, string>;
|
|
950
955
|
/**
|
|
951
956
|
* The name of the default release workflow.
|
|
952
957
|
* @default "release"
|
|
@@ -1107,7 +1112,7 @@ export interface CdkConstructLibraryOptions {
|
|
|
1107
1112
|
readonly workflowContainerImage?: string;
|
|
1108
1113
|
/**
|
|
1109
1114
|
* The git identity to use in workflows.
|
|
1110
|
-
* @default - GitHub Actions
|
|
1115
|
+
* @default - default GitHub Actions user
|
|
1111
1116
|
*/
|
|
1112
1117
|
readonly workflowGitIdentity?: github.GitIdentity;
|
|
1113
1118
|
/**
|