cdklabs-projen-project-types 0.3.2 → 0.3.3

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
@@ -14853,8 +14853,8 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14853
14853
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
14854
14854
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
14855
14855
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
14856
- | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
14857
- | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
14856
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
14857
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
14858
14858
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
14859
14859
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
14860
14860
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -14922,6 +14922,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14922
14922
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
14923
14923
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
14924
14924
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
14925
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
14925
14926
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
14926
14927
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
14927
14928
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
@@ -14960,6 +14961,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14960
14961
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
14961
14962
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
14962
14963
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
14964
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
14963
14965
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
14964
14966
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
14965
14967
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -15581,7 +15583,7 @@ public readonly codeCov: boolean;
15581
15583
  - *Type:* boolean
15582
15584
  - *Default:* false
15583
15585
 
15584
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
15586
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
15585
15587
 
15586
15588
  ---
15587
15589
 
@@ -15592,9 +15594,9 @@ public readonly codeCovTokenSecret: string;
15592
15594
  ```
15593
15595
 
15594
15596
  - *Type:* string
15595
- - *Default:* if this option is not specified, only public repositories are supported
15597
+ - *Default:* OIDC auth is used
15596
15598
 
15597
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
15599
+ Define the secret name for a specified https://codecov.io/ token.
15598
15600
 
15599
15601
  ---
15600
15602
 
@@ -16572,6 +16574,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
16572
16574
 
16573
16575
  ---
16574
16576
 
16577
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmTrustedPublishing"></a>
16578
+
16579
+ ```typescript
16580
+ public readonly npmTrustedPublishing: boolean;
16581
+ ```
16582
+
16583
+ - *Type:* boolean
16584
+ - *Default:* false
16585
+
16586
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
16587
+
16588
+ ---
16589
+
16575
16590
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.outdir"></a>
16576
16591
 
16577
16592
  ```typescript
@@ -17101,6 +17116,25 @@ be provided for the default branch.
17101
17116
 
17102
17117
  ---
17103
17118
 
17119
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseEnvironment"></a>
17120
+
17121
+ ```typescript
17122
+ public readonly releaseEnvironment: string;
17123
+ ```
17124
+
17125
+ - *Type:* string
17126
+ - *Default:* no environment used, unless set at the artifact level
17127
+
17128
+ The GitHub Actions environment used for the release.
17129
+
17130
+ This can be used to add an explicit approval step to the release
17131
+ or limit who can initiate a release through environment protection rules.
17132
+
17133
+ When multiple artifacts are released, the environment can be overwritten
17134
+ on a per artifact basis.
17135
+
17136
+ ---
17137
+
17104
17138
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseEveryCommit"></a>
17105
17139
 
17106
17140
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -17746,8 +17780,8 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17746
17780
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
17747
17781
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
17748
17782
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
17749
- | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
17750
- | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
17783
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
17784
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
17751
17785
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
17752
17786
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
17753
17787
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -17808,6 +17842,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17808
17842
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
17809
17843
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
17810
17844
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
17845
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
17811
17846
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
17812
17847
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
17813
17848
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
@@ -17846,6 +17881,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17846
17881
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
17847
17882
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
17848
17883
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
17884
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
17849
17885
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
17850
17886
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
17851
17887
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -18315,7 +18351,7 @@ public readonly codeCov: boolean;
18315
18351
  - *Type:* boolean
18316
18352
  - *Default:* false
18317
18353
 
18318
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
18354
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
18319
18355
 
18320
18356
  ---
18321
18357
 
@@ -18326,9 +18362,9 @@ public readonly codeCovTokenSecret: string;
18326
18362
  ```
18327
18363
 
18328
18364
  - *Type:* string
18329
- - *Default:* if this option is not specified, only public repositories are supported
18365
+ - *Default:* OIDC auth is used
18330
18366
 
18331
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
18367
+ Define the secret name for a specified https://codecov.io/ token.
18332
18368
 
18333
18369
  ---
18334
18370
 
@@ -19223,6 +19259,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
19223
19259
 
19224
19260
  ---
19225
19261
 
19262
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmTrustedPublishing"></a>
19263
+
19264
+ ```typescript
19265
+ public readonly npmTrustedPublishing: boolean;
19266
+ ```
19267
+
19268
+ - *Type:* boolean
19269
+ - *Default:* false
19270
+
19271
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
19272
+
19273
+ ---
19274
+
19226
19275
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.outdir"></a>
19227
19276
 
19228
19277
  ```typescript
@@ -19752,6 +19801,25 @@ be provided for the default branch.
19752
19801
 
19753
19802
  ---
19754
19803
 
19804
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseEnvironment"></a>
19805
+
19806
+ ```typescript
19807
+ public readonly releaseEnvironment: string;
19808
+ ```
19809
+
19810
+ - *Type:* string
19811
+ - *Default:* no environment used, unless set at the artifact level
19812
+
19813
+ The GitHub Actions environment used for the release.
19814
+
19815
+ This can be used to add an explicit approval step to the release
19816
+ or limit who can initiate a release through environment protection rules.
19817
+
19818
+ When multiple artifacts are released, the environment can be overwritten
19819
+ on a per artifact basis.
19820
+
19821
+ ---
19822
+
19755
19823
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseEveryCommit"></a>
19756
19824
 
19757
19825
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -20394,8 +20462,8 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
20394
20462
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
20395
20463
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
20396
20464
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
20397
- | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
20398
- | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
20465
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
20466
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
20399
20467
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
20400
20468
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
20401
20469
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -20463,6 +20531,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
20463
20531
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
20464
20532
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
20465
20533
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
20534
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
20466
20535
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
20467
20536
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
20468
20537
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
@@ -20501,6 +20570,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
20501
20570
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
20502
20571
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
20503
20572
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
20573
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
20504
20574
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
20505
20575
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
20506
20576
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -21124,7 +21194,7 @@ public readonly codeCov: boolean;
21124
21194
  - *Type:* boolean
21125
21195
  - *Default:* false
21126
21196
 
21127
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
21197
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
21128
21198
 
21129
21199
  ---
21130
21200
 
@@ -21135,9 +21205,9 @@ public readonly codeCovTokenSecret: string;
21135
21205
  ```
21136
21206
 
21137
21207
  - *Type:* string
21138
- - *Default:* if this option is not specified, only public repositories are supported
21208
+ - *Default:* OIDC auth is used
21139
21209
 
21140
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
21210
+ Define the secret name for a specified https://codecov.io/ token.
21141
21211
 
21142
21212
  ---
21143
21213
 
@@ -22115,6 +22185,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
22115
22185
 
22116
22186
  ---
22117
22187
 
22188
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmTrustedPublishing"></a>
22189
+
22190
+ ```typescript
22191
+ public readonly npmTrustedPublishing: boolean;
22192
+ ```
22193
+
22194
+ - *Type:* boolean
22195
+ - *Default:* false
22196
+
22197
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
22198
+
22199
+ ---
22200
+
22118
22201
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.outdir"></a>
22119
22202
 
22120
22203
  ```typescript
@@ -22644,6 +22727,25 @@ be provided for the default branch.
22644
22727
 
22645
22728
  ---
22646
22729
 
22730
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseEnvironment"></a>
22731
+
22732
+ ```typescript
22733
+ public readonly releaseEnvironment: string;
22734
+ ```
22735
+
22736
+ - *Type:* string
22737
+ - *Default:* no environment used, unless set at the artifact level
22738
+
22739
+ The GitHub Actions environment used for the release.
22740
+
22741
+ This can be used to add an explicit approval step to the release
22742
+ or limit who can initiate a release through environment protection rules.
22743
+
22744
+ When multiple artifacts are released, the environment can be overwritten
22745
+ on a per artifact basis.
22746
+
22747
+ ---
22748
+
22647
22749
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseEveryCommit"></a>
22648
22750
 
22649
22751
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -23326,8 +23428,8 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
23326
23428
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
23327
23429
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
23328
23430
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
23329
- | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
23330
- | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
23431
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
23432
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
23331
23433
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
23332
23434
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
23333
23435
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -23388,6 +23490,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
23388
23490
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
23389
23491
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
23390
23492
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
23493
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
23391
23494
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
23392
23495
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
23393
23496
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
@@ -23426,6 +23529,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
23426
23529
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
23427
23530
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
23428
23531
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
23532
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
23429
23533
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
23430
23534
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
23431
23535
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -23897,7 +24001,7 @@ public readonly codeCov: boolean;
23897
24001
  - *Type:* boolean
23898
24002
  - *Default:* false
23899
24003
 
23900
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
24004
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
23901
24005
 
23902
24006
  ---
23903
24007
 
@@ -23908,9 +24012,9 @@ public readonly codeCovTokenSecret: string;
23908
24012
  ```
23909
24013
 
23910
24014
  - *Type:* string
23911
- - *Default:* if this option is not specified, only public repositories are supported
24015
+ - *Default:* OIDC auth is used
23912
24016
 
23913
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
24017
+ Define the secret name for a specified https://codecov.io/ token.
23914
24018
 
23915
24019
  ---
23916
24020
 
@@ -24805,6 +24909,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
24805
24909
 
24806
24910
  ---
24807
24911
 
24912
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmTrustedPublishing"></a>
24913
+
24914
+ ```typescript
24915
+ public readonly npmTrustedPublishing: boolean;
24916
+ ```
24917
+
24918
+ - *Type:* boolean
24919
+ - *Default:* false
24920
+
24921
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
24922
+
24923
+ ---
24924
+
24808
24925
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.outdir"></a>
24809
24926
 
24810
24927
  ```typescript
@@ -25334,6 +25451,25 @@ be provided for the default branch.
25334
25451
 
25335
25452
  ---
25336
25453
 
25454
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseEnvironment"></a>
25455
+
25456
+ ```typescript
25457
+ public readonly releaseEnvironment: string;
25458
+ ```
25459
+
25460
+ - *Type:* string
25461
+ - *Default:* no environment used, unless set at the artifact level
25462
+
25463
+ The GitHub Actions environment used for the release.
25464
+
25465
+ This can be used to add an explicit approval step to the release
25466
+ or limit who can initiate a release through environment protection rules.
25467
+
25468
+ When multiple artifacts are released, the environment can be overwritten
25469
+ on a per artifact basis.
25470
+
25471
+ ---
25472
+
25337
25473
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseEveryCommit"></a>
25338
25474
 
25339
25475
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -26007,8 +26143,8 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
26007
26143
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
26008
26144
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
26009
26145
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
26010
- | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
26011
- | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
26146
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
26147
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
26012
26148
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
26013
26149
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
26014
26150
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -26057,6 +26193,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
26057
26193
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
26058
26194
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
26059
26195
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
26196
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
26060
26197
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.nx">nx</a></code> | <code>boolean</code> | Enable the integration with Nx in the monorepo. |
26061
26198
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
26062
26199
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
@@ -26089,6 +26226,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
26089
26226
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
26090
26227
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.release">release</a></code> | <code>boolean</code> | Whether or not to add release workflows for this repository. |
26091
26228
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
26229
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
26092
26230
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
26093
26231
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
26094
26232
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -26541,7 +26679,7 @@ public readonly codeCov: boolean;
26541
26679
  - *Type:* boolean
26542
26680
  - *Default:* false
26543
26681
 
26544
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
26682
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
26545
26683
 
26546
26684
  ---
26547
26685
 
@@ -26552,9 +26690,9 @@ public readonly codeCovTokenSecret: string;
26552
26690
  ```
26553
26691
 
26554
26692
  - *Type:* string
26555
- - *Default:* if this option is not specified, only public repositories are supported
26693
+ - *Default:* OIDC auth is used
26556
26694
 
26557
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
26695
+ Define the secret name for a specified https://codecov.io/ token.
26558
26696
 
26559
26697
  ---
26560
26698
 
@@ -27269,6 +27407,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
27269
27407
 
27270
27408
  ---
27271
27409
 
27410
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmTrustedPublishing"></a>
27411
+
27412
+ ```typescript
27413
+ public readonly npmTrustedPublishing: boolean;
27414
+ ```
27415
+
27416
+ - *Type:* boolean
27417
+ - *Default:* false
27418
+
27419
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
27420
+
27421
+ ---
27422
+
27272
27423
  ##### `nx`<sup>Optional</sup> <a name="nx" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.nx"></a>
27273
27424
 
27274
27425
  ```typescript
@@ -27719,6 +27870,25 @@ be provided for the default branch.
27719
27870
 
27720
27871
  ---
27721
27872
 
27873
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseEnvironment"></a>
27874
+
27875
+ ```typescript
27876
+ public readonly releaseEnvironment: string;
27877
+ ```
27878
+
27879
+ - *Type:* string
27880
+ - *Default:* no environment used, unless set at the artifact level
27881
+
27882
+ The GitHub Actions environment used for the release.
27883
+
27884
+ This can be used to add an explicit approval step to the release
27885
+ or limit who can initiate a release through environment protection rules.
27886
+
27887
+ When multiple artifacts are released, the environment can be overwritten
27888
+ on a per artifact basis.
27889
+
27890
+ ---
27891
+
27722
27892
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseEveryCommit"></a>
27723
27893
 
27724
27894
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -28386,6 +28556,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
28386
28556
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
28387
28557
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
28388
28558
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
28559
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
28389
28560
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
28390
28561
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
28391
28562
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
@@ -28409,6 +28580,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
28409
28580
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
28410
28581
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
28411
28582
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
28583
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
28412
28584
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
28413
28585
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
28414
28586
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -28431,8 +28603,8 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
28431
28603
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
28432
28604
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
28433
28605
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
28434
- | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
28435
- | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
28606
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
28607
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
28436
28608
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
28437
28609
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
28438
28610
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -29333,6 +29505,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
29333
29505
 
29334
29506
  ---
29335
29507
 
29508
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmTrustedPublishing"></a>
29509
+
29510
+ ```typescript
29511
+ public readonly npmTrustedPublishing: boolean;
29512
+ ```
29513
+
29514
+ - *Type:* boolean
29515
+ - *Default:* false
29516
+
29517
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
29518
+
29519
+ ---
29520
+
29336
29521
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.packageManager"></a>
29337
29522
 
29338
29523
  ```typescript
@@ -29692,6 +29877,25 @@ be provided for the default branch.
29692
29877
 
29693
29878
  ---
29694
29879
 
29880
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseEnvironment"></a>
29881
+
29882
+ ```typescript
29883
+ public readonly releaseEnvironment: string;
29884
+ ```
29885
+
29886
+ - *Type:* string
29887
+ - *Default:* no environment used, unless set at the artifact level
29888
+
29889
+ The GitHub Actions environment used for the release.
29890
+
29891
+ This can be used to add an explicit approval step to the release
29892
+ or limit who can initiate a release through environment protection rules.
29893
+
29894
+ When multiple artifacts are released, the environment can be overwritten
29895
+ on a per artifact basis.
29896
+
29897
+ ---
29898
+
29695
29899
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseEveryCommit"></a>
29696
29900
 
29697
29901
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -30002,7 +30206,7 @@ public readonly codeCov: boolean;
30002
30206
  - *Type:* boolean
30003
30207
  - *Default:* false
30004
30208
 
30005
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
30209
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
30006
30210
 
30007
30211
  ---
30008
30212
 
@@ -30013,9 +30217,9 @@ public readonly codeCovTokenSecret: string;
30013
30217
  ```
30014
30218
 
30015
30219
  - *Type:* string
30016
- - *Default:* if this option is not specified, only public repositories are supported
30220
+ - *Default:* OIDC auth is used
30017
30221
 
30018
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
30222
+ Define the secret name for a specified https://codecov.io/ token.
30019
30223
 
30020
30224
  ---
30021
30225
 
@@ -30818,6 +31022,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
30818
31022
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
30819
31023
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
30820
31024
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
31025
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
30821
31026
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
30822
31027
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
30823
31028
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
@@ -30841,6 +31046,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
30841
31046
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
30842
31047
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
30843
31048
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
31049
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
30844
31050
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
30845
31051
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
30846
31052
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -30863,8 +31069,8 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
30863
31069
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
30864
31070
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
30865
31071
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
30866
- | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
30867
- | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
31072
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
31073
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
30868
31074
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
30869
31075
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
30870
31076
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -31765,6 +31971,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
31765
31971
 
31766
31972
  ---
31767
31973
 
31974
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmTrustedPublishing"></a>
31975
+
31976
+ ```typescript
31977
+ public readonly npmTrustedPublishing: boolean;
31978
+ ```
31979
+
31980
+ - *Type:* boolean
31981
+ - *Default:* false
31982
+
31983
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
31984
+
31985
+ ---
31986
+
31768
31987
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.packageManager"></a>
31769
31988
 
31770
31989
  ```typescript
@@ -32124,6 +32343,25 @@ be provided for the default branch.
32124
32343
 
32125
32344
  ---
32126
32345
 
32346
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseEnvironment"></a>
32347
+
32348
+ ```typescript
32349
+ public readonly releaseEnvironment: string;
32350
+ ```
32351
+
32352
+ - *Type:* string
32353
+ - *Default:* no environment used, unless set at the artifact level
32354
+
32355
+ The GitHub Actions environment used for the release.
32356
+
32357
+ This can be used to add an explicit approval step to the release
32358
+ or limit who can initiate a release through environment protection rules.
32359
+
32360
+ When multiple artifacts are released, the environment can be overwritten
32361
+ on a per artifact basis.
32362
+
32363
+ ---
32364
+
32127
32365
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseEveryCommit"></a>
32128
32366
 
32129
32367
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -32434,7 +32672,7 @@ public readonly codeCov: boolean;
32434
32672
  - *Type:* boolean
32435
32673
  - *Default:* false
32436
32674
 
32437
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
32675
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
32438
32676
 
32439
32677
  ---
32440
32678
 
@@ -32445,9 +32683,9 @@ public readonly codeCovTokenSecret: string;
32445
32683
  ```
32446
32684
 
32447
32685
  - *Type:* string
32448
- - *Default:* if this option is not specified, only public repositories are supported
32686
+ - *Default:* OIDC auth is used
32449
32687
 
32450
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
32688
+ Define the secret name for a specified https://codecov.io/ token.
32451
32689
 
32452
32690
  ---
32453
32691
 
@@ -33225,8 +33463,8 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
33225
33463
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
33226
33464
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
33227
33465
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
33228
- | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
33229
- | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
33466
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
33467
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
33230
33468
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
33231
33469
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
33232
33470
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -33275,6 +33513,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
33275
33513
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
33276
33514
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
33277
33515
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
33516
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
33278
33517
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.nx">nx</a></code> | <code>boolean</code> | Enable the integration with Nx in the monorepo. |
33279
33518
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
33280
33519
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
@@ -33307,6 +33546,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
33307
33546
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
33308
33547
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.release">release</a></code> | <code>boolean</code> | Whether or not to add release workflows for this repository. |
33309
33548
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
33549
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
33310
33550
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
33311
33551
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
33312
33552
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -33759,7 +33999,7 @@ public readonly codeCov: boolean;
33759
33999
  - *Type:* boolean
33760
34000
  - *Default:* false
33761
34001
 
33762
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
34002
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
33763
34003
 
33764
34004
  ---
33765
34005
 
@@ -33770,9 +34010,9 @@ public readonly codeCovTokenSecret: string;
33770
34010
  ```
33771
34011
 
33772
34012
  - *Type:* string
33773
- - *Default:* if this option is not specified, only public repositories are supported
34013
+ - *Default:* OIDC auth is used
33774
34014
 
33775
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
34015
+ Define the secret name for a specified https://codecov.io/ token.
33776
34016
 
33777
34017
  ---
33778
34018
 
@@ -34487,6 +34727,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
34487
34727
 
34488
34728
  ---
34489
34729
 
34730
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmTrustedPublishing"></a>
34731
+
34732
+ ```typescript
34733
+ public readonly npmTrustedPublishing: boolean;
34734
+ ```
34735
+
34736
+ - *Type:* boolean
34737
+ - *Default:* false
34738
+
34739
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
34740
+
34741
+ ---
34742
+
34490
34743
  ##### `nx`<sup>Optional</sup> <a name="nx" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.nx"></a>
34491
34744
 
34492
34745
  ```typescript
@@ -34937,6 +35190,25 @@ be provided for the default branch.
34937
35190
 
34938
35191
  ---
34939
35192
 
35193
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseEnvironment"></a>
35194
+
35195
+ ```typescript
35196
+ public readonly releaseEnvironment: string;
35197
+ ```
35198
+
35199
+ - *Type:* string
35200
+ - *Default:* no environment used, unless set at the artifact level
35201
+
35202
+ The GitHub Actions environment used for the release.
35203
+
35204
+ This can be used to add an explicit approval step to the release
35205
+ or limit who can initiate a release through environment protection rules.
35206
+
35207
+ When multiple artifacts are released, the environment can be overwritten
35208
+ on a per artifact basis.
35209
+
35210
+ ---
35211
+
34940
35212
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseEveryCommit"></a>
34941
35213
 
34942
35214
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -35506,6 +35778,7 @@ const monorepoReleaseOptions: yarn.MonorepoReleaseOptions = { ... }
35506
35778
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
35507
35779
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.publishToNpm">publishToNpm</a></code> | <code>boolean</code> | Publish packages to npm. |
35508
35780
  | <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
+ | <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. |
35509
35782
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
35510
35783
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
35511
35784
  | <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. |
@@ -35731,6 +36004,25 @@ Find commits that should be considered releasable Used to decide if a release is
35731
36004
 
35732
36005
  ---
35733
36006
 
36007
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseEnvironment"></a>
36008
+
36009
+ ```typescript
36010
+ public readonly releaseEnvironment: string;
36011
+ ```
36012
+
36013
+ - *Type:* string
36014
+ - *Default:* no environment used, unless set at the artifact level
36015
+
36016
+ The GitHub Actions environment used for the release.
36017
+
36018
+ This can be used to add an explicit approval step to the release
36019
+ or limit who can initiate a release through environment protection rules.
36020
+
36021
+ When multiple artifacts are released, the environment can be overwritten
36022
+ on a per artifact basis.
36023
+
36024
+ ---
36025
+
35734
36026
  ##### `releaseTrigger`<sup>Optional</sup> <a name="releaseTrigger" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseTrigger"></a>
35735
36027
 
35736
36028
  ```typescript
@@ -35934,8 +36226,8 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
35934
36226
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
35935
36227
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
35936
36228
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
35937
- | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
35938
- | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
36229
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
36230
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
35939
36231
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
35940
36232
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
35941
36233
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -35987,6 +36279,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
35987
36279
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
35988
36280
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
35989
36281
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
36282
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. |
35990
36283
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
35991
36284
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
35992
36285
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
@@ -36017,6 +36310,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
36017
36310
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
36018
36311
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
36019
36312
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
36313
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
36020
36314
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
36021
36315
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
36022
36316
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -36456,7 +36750,7 @@ public readonly codeCov: boolean;
36456
36750
  - *Type:* boolean
36457
36751
  - *Default:* false
36458
36752
 
36459
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
36753
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
36460
36754
 
36461
36755
  ---
36462
36756
 
@@ -36467,9 +36761,9 @@ public readonly codeCovTokenSecret: string;
36467
36761
  ```
36468
36762
 
36469
36763
  - *Type:* string
36470
- - *Default:* if this option is not specified, only public repositories are supported
36764
+ - *Default:* OIDC auth is used
36471
36765
 
36472
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
36766
+ Define the secret name for a specified https://codecov.io/ token.
36473
36767
 
36474
36768
  ---
36475
36769
 
@@ -37223,6 +37517,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
37223
37517
 
37224
37518
  ---
37225
37519
 
37520
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmTrustedPublishing"></a>
37521
+
37522
+ ```typescript
37523
+ public readonly npmTrustedPublishing: boolean;
37524
+ ```
37525
+
37526
+ - *Type:* boolean
37527
+ - *Default:* false
37528
+
37529
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
37530
+
37531
+ ---
37532
+
37226
37533
  ##### `package`<sup>Optional</sup> <a name="package" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.package"></a>
37227
37534
 
37228
37535
  ```typescript
@@ -37644,6 +37951,25 @@ be provided for the default branch.
37644
37951
 
37645
37952
  ---
37646
37953
 
37954
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseEnvironment"></a>
37955
+
37956
+ ```typescript
37957
+ public readonly releaseEnvironment: string;
37958
+ ```
37959
+
37960
+ - *Type:* string
37961
+ - *Default:* no environment used, unless set at the artifact level
37962
+
37963
+ The GitHub Actions environment used for the release.
37964
+
37965
+ This can be used to add an explicit approval step to the release
37966
+ or limit who can initiate a release through environment protection rules.
37967
+
37968
+ When multiple artifacts are released, the environment can be overwritten
37969
+ on a per artifact basis.
37970
+
37971
+ ---
37972
+
37647
37973
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseEveryCommit"></a>
37648
37974
 
37649
37975
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead