mrpj 0.2.3 → 0.2.5

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
@@ -5169,8 +5169,8 @@ const constructProjectOptions: ConstructProjectOptions = { ... }
5169
5169
  | <code><a href="#mrpj.ConstructProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
5170
5170
  | <code><a href="#mrpj.ConstructProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
5171
5171
  | <code><a href="#mrpj.ConstructProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
5172
- | <code><a href="#mrpj.ConstructProjectOptions.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`. |
5173
- | <code><a href="#mrpj.ConstructProjectOptions.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. |
5172
+ | <code><a href="#mrpj.ConstructProjectOptions.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`. |
5173
+ | <code><a href="#mrpj.ConstructProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
5174
5174
  | <code><a href="#mrpj.ConstructProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
5175
5175
  | <code><a href="#mrpj.ConstructProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
5176
5176
  | <code><a href="#mrpj.ConstructProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -5230,6 +5230,7 @@ const constructProjectOptions: ConstructProjectOptions = { ... }
5230
5230
  | <code><a href="#mrpj.ConstructProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
5231
5231
  | <code><a href="#mrpj.ConstructProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
5232
5232
  | <code><a href="#mrpj.ConstructProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
5233
+ | <code><a href="#mrpj.ConstructProjectOptions.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. |
5233
5234
  | <code><a href="#mrpj.ConstructProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
5234
5235
  | <code><a href="#mrpj.ConstructProjectOptions.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`). |
5235
5236
  | <code><a href="#mrpj.ConstructProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
@@ -5264,11 +5265,13 @@ const constructProjectOptions: ConstructProjectOptions = { ... }
5264
5265
  | <code><a href="#mrpj.ConstructProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
5265
5266
  | <code><a href="#mrpj.ConstructProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
5266
5267
  | <code><a href="#mrpj.ConstructProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
5268
+ | <code><a href="#mrpj.ConstructProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
5267
5269
  | <code><a href="#mrpj.ConstructProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
5268
5270
  | <code><a href="#mrpj.ConstructProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
5269
5271
  | <code><a href="#mrpj.ConstructProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. |
5270
5272
  | <code><a href="#mrpj.ConstructProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
5271
5273
  | <code><a href="#mrpj.ConstructProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
5274
+ | <code><a href="#mrpj.ConstructProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
5272
5275
  | <code><a href="#mrpj.ConstructProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
5273
5276
  | <code><a href="#mrpj.ConstructProjectOptions.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. |
5274
5277
  | <code><a href="#mrpj.ConstructProjectOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
@@ -5806,7 +5809,7 @@ public readonly codeCov: boolean;
5806
5809
  - *Type:* boolean
5807
5810
  - *Default:* false
5808
5811
 
5809
- 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`.
5812
+ 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`.
5810
5813
 
5811
5814
  ---
5812
5815
 
@@ -5817,9 +5820,9 @@ public readonly codeCovTokenSecret: string;
5817
5820
  ```
5818
5821
 
5819
5822
  - *Type:* string
5820
- - *Default:* if this option is not specified, only public repositories are supported
5823
+ - *Default:* OIDC auth is used
5821
5824
 
5822
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
5825
+ Define the secret name for a specified https://codecov.io/ token.
5823
5826
 
5824
5827
  ---
5825
5828
 
@@ -6156,7 +6159,7 @@ public readonly eslint: boolean;
6156
6159
  ```
6157
6160
 
6158
6161
  - *Type:* boolean
6159
- - *Default:* true
6162
+ - *Default:* true, unless biome is enabled
6160
6163
 
6161
6164
  Setup eslint.
6162
6165
 
@@ -6352,7 +6355,7 @@ public readonly jsiiVersion: string;
6352
6355
  ```
6353
6356
 
6354
6357
  - *Type:* string
6355
- - *Default:* "~5.6.0"
6358
+ - *Default:* "~5.8.0"
6356
6359
 
6357
6360
  Version of the jsii compiler to use.
6358
6361
 
@@ -6682,6 +6685,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
6682
6685
 
6683
6686
  ---
6684
6687
 
6688
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="mrpj.ConstructProjectOptions.property.npmTrustedPublishing"></a>
6689
+
6690
+ ```typescript
6691
+ public readonly npmTrustedPublishing: boolean;
6692
+ ```
6693
+
6694
+ - *Type:* boolean
6695
+ - *Default:* false
6696
+
6697
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
6698
+
6699
+ ---
6700
+
6685
6701
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="mrpj.ConstructProjectOptions.property.outdir"></a>
6686
6702
 
6687
6703
  ```typescript
@@ -7151,6 +7167,25 @@ be provided for the default branch.
7151
7167
 
7152
7168
  ---
7153
7169
 
7170
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="mrpj.ConstructProjectOptions.property.releaseEnvironment"></a>
7171
+
7172
+ ```typescript
7173
+ public readonly releaseEnvironment: string;
7174
+ ```
7175
+
7176
+ - *Type:* string
7177
+ - *Default:* no environment used, unless set at the artifact level
7178
+
7179
+ The GitHub Actions environment used for the release.
7180
+
7181
+ This can be used to add an explicit approval step to the release
7182
+ or limit who can initiate a release through environment protection rules.
7183
+
7184
+ When multiple artifacts are released, the environment can be overwritten
7185
+ on a per artifact basis.
7186
+
7187
+ ---
7188
+
7154
7189
  ##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="mrpj.ConstructProjectOptions.property.releaseFailureIssue"></a>
7155
7190
 
7156
7191
  ```typescript
@@ -7224,6 +7259,19 @@ The release trigger to use.
7224
7259
 
7225
7260
  ---
7226
7261
 
7262
+ ##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="mrpj.ConstructProjectOptions.property.releaseWorkflowEnv"></a>
7263
+
7264
+ ```typescript
7265
+ public readonly releaseWorkflowEnv: {[ key: string ]: string};
7266
+ ```
7267
+
7268
+ - *Type:* {[ key: string ]: string}
7269
+ - *Default:* {}
7270
+
7271
+ Build environment variables for release workflows.
7272
+
7273
+ ---
7274
+
7227
7275
  ##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="mrpj.ConstructProjectOptions.property.releaseWorkflowName"></a>
7228
7276
 
7229
7277
  ```typescript
@@ -7542,7 +7590,7 @@ public readonly workflowGitIdentity: GitIdentity;
7542
7590
  ```
7543
7591
 
7544
7592
  - *Type:* projen.github.GitIdentity
7545
- - *Default:* GitHub Actions
7593
+ - *Default:* default GitHub Actions user
7546
7594
 
7547
7595
  The git identity to use in workflows.
7548
7596
 
@@ -8039,8 +8087,8 @@ const projenProjectOptions: ProjenProjectOptions = { ... }
8039
8087
  | <code><a href="#mrpj.ProjenProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
8040
8088
  | <code><a href="#mrpj.ProjenProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
8041
8089
  | <code><a href="#mrpj.ProjenProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
8042
- | <code><a href="#mrpj.ProjenProjectOptions.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`. |
8043
- | <code><a href="#mrpj.ProjenProjectOptions.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. |
8090
+ | <code><a href="#mrpj.ProjenProjectOptions.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`. |
8091
+ | <code><a href="#mrpj.ProjenProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
8044
8092
  | <code><a href="#mrpj.ProjenProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
8045
8093
  | <code><a href="#mrpj.ProjenProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
8046
8094
  | <code><a href="#mrpj.ProjenProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -8095,6 +8143,7 @@ const projenProjectOptions: ProjenProjectOptions = { ... }
8095
8143
  | <code><a href="#mrpj.ProjenProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
8096
8144
  | <code><a href="#mrpj.ProjenProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
8097
8145
  | <code><a href="#mrpj.ProjenProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
8146
+ | <code><a href="#mrpj.ProjenProjectOptions.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. |
8098
8147
  | <code><a href="#mrpj.ProjenProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
8099
8148
  | <code><a href="#mrpj.ProjenProjectOptions.property.ownerCanSelfApprovePRs">ownerCanSelfApprovePRs</a></code> | <code>boolean</code> | Allow the repo owner to self approve PRs by putting a label on it. |
8100
8149
  | <code><a href="#mrpj.ProjenProjectOptions.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`). |
@@ -8129,11 +8178,13 @@ const projenProjectOptions: ProjenProjectOptions = { ... }
8129
8178
  | <code><a href="#mrpj.ProjenProjectOptions.property.releasableCommitTypes">releasableCommitTypes</a></code> | <code>string[]</code> | Which conventional commit types should be released. |
8130
8179
  | <code><a href="#mrpj.ProjenProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
8131
8180
  | <code><a href="#mrpj.ProjenProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
8181
+ | <code><a href="#mrpj.ProjenProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
8132
8182
  | <code><a href="#mrpj.ProjenProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
8133
8183
  | <code><a href="#mrpj.ProjenProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
8134
8184
  | <code><a href="#mrpj.ProjenProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. |
8135
8185
  | <code><a href="#mrpj.ProjenProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
8136
8186
  | <code><a href="#mrpj.ProjenProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
8187
+ | <code><a href="#mrpj.ProjenProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
8137
8188
  | <code><a href="#mrpj.ProjenProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
8138
8189
  | <code><a href="#mrpj.ProjenProjectOptions.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. |
8139
8190
  | <code><a href="#mrpj.ProjenProjectOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
@@ -8561,7 +8612,7 @@ public readonly codeCov: boolean;
8561
8612
  - *Type:* boolean
8562
8613
  - *Default:* false
8563
8614
 
8564
- 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`.
8615
+ 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`.
8565
8616
 
8566
8617
  ---
8567
8618
 
@@ -8572,9 +8623,9 @@ public readonly codeCovTokenSecret: string;
8572
8623
  ```
8573
8624
 
8574
8625
  - *Type:* string
8575
- - *Default:* if this option is not specified, only public repositories are supported
8626
+ - *Default:* OIDC auth is used
8576
8627
 
8577
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
8628
+ Define the secret name for a specified https://codecov.io/ token.
8578
8629
 
8579
8630
  ---
8580
8631
 
@@ -8898,7 +8949,7 @@ public readonly eslint: boolean;
8898
8949
  ```
8899
8950
 
8900
8951
  - *Type:* boolean
8901
- - *Default:* true
8952
+ - *Default:* true, unless biome is enabled
8902
8953
 
8903
8954
  Setup eslint.
8904
8955
 
@@ -9366,6 +9417,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
9366
9417
 
9367
9418
  ---
9368
9419
 
9420
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="mrpj.ProjenProjectOptions.property.npmTrustedPublishing"></a>
9421
+
9422
+ ```typescript
9423
+ public readonly npmTrustedPublishing: boolean;
9424
+ ```
9425
+
9426
+ - *Type:* boolean
9427
+ - *Default:* false
9428
+
9429
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
9430
+
9431
+ ---
9432
+
9369
9433
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="mrpj.ProjenProjectOptions.property.outdir"></a>
9370
9434
 
9371
9435
  ```typescript
@@ -9835,6 +9899,25 @@ be provided for the default branch.
9835
9899
 
9836
9900
  ---
9837
9901
 
9902
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="mrpj.ProjenProjectOptions.property.releaseEnvironment"></a>
9903
+
9904
+ ```typescript
9905
+ public readonly releaseEnvironment: string;
9906
+ ```
9907
+
9908
+ - *Type:* string
9909
+ - *Default:* no environment used, unless set at the artifact level
9910
+
9911
+ The GitHub Actions environment used for the release.
9912
+
9913
+ This can be used to add an explicit approval step to the release
9914
+ or limit who can initiate a release through environment protection rules.
9915
+
9916
+ When multiple artifacts are released, the environment can be overwritten
9917
+ on a per artifact basis.
9918
+
9919
+ ---
9920
+
9838
9921
  ##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="mrpj.ProjenProjectOptions.property.releaseFailureIssue"></a>
9839
9922
 
9840
9923
  ```typescript
@@ -9908,6 +9991,19 @@ The release trigger to use.
9908
9991
 
9909
9992
  ---
9910
9993
 
9994
+ ##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="mrpj.ProjenProjectOptions.property.releaseWorkflowEnv"></a>
9995
+
9996
+ ```typescript
9997
+ public readonly releaseWorkflowEnv: {[ key: string ]: string};
9998
+ ```
9999
+
10000
+ - *Type:* {[ key: string ]: string}
10001
+ - *Default:* {}
10002
+
10003
+ Build environment variables for release workflows.
10004
+
10005
+ ---
10006
+
9911
10007
  ##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="mrpj.ProjenProjectOptions.property.releaseWorkflowName"></a>
9912
10008
 
9913
10009
  ```typescript
@@ -10223,7 +10319,7 @@ public readonly workflowGitIdentity: GitIdentity;
10223
10319
  ```
10224
10320
 
10225
10321
  - *Type:* projen.github.GitIdentity
10226
- - *Default:* GitHub Actions
10322
+ - *Default:* default GitHub Actions user
10227
10323
 
10228
10324
  The git identity to use in workflows.
10229
10325
 
@@ -10530,8 +10626,8 @@ const typeScriptProjectOptions: TypeScriptProjectOptions = { ... }
10530
10626
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
10531
10627
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
10532
10628
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
10533
- | <code><a href="#mrpj.TypeScriptProjectOptions.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`. |
10534
- | <code><a href="#mrpj.TypeScriptProjectOptions.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. |
10629
+ | <code><a href="#mrpj.TypeScriptProjectOptions.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`. |
10630
+ | <code><a href="#mrpj.TypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
10535
10631
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
10536
10632
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
10537
10633
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -10581,6 +10677,7 @@ const typeScriptProjectOptions: TypeScriptProjectOptions = { ... }
10581
10677
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
10582
10678
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
10583
10679
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
10680
+ | <code><a href="#mrpj.TypeScriptProjectOptions.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. |
10584
10681
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
10585
10682
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.ownerCanSelfApprovePRs">ownerCanSelfApprovePRs</a></code> | <code>boolean</code> | Allow the repo owner to self approve PRs by putting a label on it. |
10586
10683
  | <code><a href="#mrpj.TypeScriptProjectOptions.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`). |
@@ -10611,11 +10708,13 @@ const typeScriptProjectOptions: TypeScriptProjectOptions = { ... }
10611
10708
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.releasableCommitTypes">releasableCommitTypes</a></code> | <code>string[]</code> | Which conventional commit types should be released. |
10612
10709
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
10613
10710
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
10711
+ | <code><a href="#mrpj.TypeScriptProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
10614
10712
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
10615
10713
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
10616
10714
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. |
10617
10715
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
10618
10716
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
10717
+ | <code><a href="#mrpj.TypeScriptProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
10619
10718
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
10620
10719
  | <code><a href="#mrpj.TypeScriptProjectOptions.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. |
10621
10720
  | <code><a href="#mrpj.TypeScriptProjectOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
@@ -11042,7 +11141,7 @@ public readonly codeCov: boolean;
11042
11141
  - *Type:* boolean
11043
11142
  - *Default:* false
11044
11143
 
11045
- 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`.
11144
+ 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`.
11046
11145
 
11047
11146
  ---
11048
11147
 
@@ -11053,9 +11152,9 @@ public readonly codeCovTokenSecret: string;
11053
11152
  ```
11054
11153
 
11055
11154
  - *Type:* string
11056
- - *Default:* if this option is not specified, only public repositories are supported
11155
+ - *Default:* OIDC auth is used
11057
11156
 
11058
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
11157
+ Define the secret name for a specified https://codecov.io/ token.
11059
11158
 
11060
11159
  ---
11061
11160
 
@@ -11324,7 +11423,7 @@ public readonly eslint: boolean;
11324
11423
  ```
11325
11424
 
11326
11425
  - *Type:* boolean
11327
- - *Default:* true
11426
+ - *Default:* true, unless biome is enabled
11328
11427
 
11329
11428
  Setup eslint.
11330
11429
 
@@ -11776,6 +11875,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
11776
11875
 
11777
11876
  ---
11778
11877
 
11878
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="mrpj.TypeScriptProjectOptions.property.npmTrustedPublishing"></a>
11879
+
11880
+ ```typescript
11881
+ public readonly npmTrustedPublishing: boolean;
11882
+ ```
11883
+
11884
+ - *Type:* boolean
11885
+ - *Default:* false
11886
+
11887
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
11888
+
11889
+ ---
11890
+
11779
11891
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="mrpj.TypeScriptProjectOptions.property.outdir"></a>
11780
11892
 
11781
11893
  ```typescript
@@ -12193,6 +12305,25 @@ be provided for the default branch.
12193
12305
 
12194
12306
  ---
12195
12307
 
12308
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="mrpj.TypeScriptProjectOptions.property.releaseEnvironment"></a>
12309
+
12310
+ ```typescript
12311
+ public readonly releaseEnvironment: string;
12312
+ ```
12313
+
12314
+ - *Type:* string
12315
+ - *Default:* no environment used, unless set at the artifact level
12316
+
12317
+ The GitHub Actions environment used for the release.
12318
+
12319
+ This can be used to add an explicit approval step to the release
12320
+ or limit who can initiate a release through environment protection rules.
12321
+
12322
+ When multiple artifacts are released, the environment can be overwritten
12323
+ on a per artifact basis.
12324
+
12325
+ ---
12326
+
12196
12327
  ##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="mrpj.TypeScriptProjectOptions.property.releaseFailureIssue"></a>
12197
12328
 
12198
12329
  ```typescript
@@ -12266,6 +12397,19 @@ The release trigger to use.
12266
12397
 
12267
12398
  ---
12268
12399
 
12400
+ ##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="mrpj.TypeScriptProjectOptions.property.releaseWorkflowEnv"></a>
12401
+
12402
+ ```typescript
12403
+ public readonly releaseWorkflowEnv: {[ key: string ]: string};
12404
+ ```
12405
+
12406
+ - *Type:* {[ key: string ]: string}
12407
+ - *Default:* {}
12408
+
12409
+ Build environment variables for release workflows.
12410
+
12411
+ ---
12412
+
12269
12413
  ##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="mrpj.TypeScriptProjectOptions.property.releaseWorkflowName"></a>
12270
12414
 
12271
12415
  ```typescript
@@ -12586,7 +12730,7 @@ public readonly workflowGitIdentity: GitIdentity;
12586
12730
  ```
12587
12731
 
12588
12732
  - *Type:* projen.github.GitIdentity
12589
- - *Default:* GitHub Actions
12733
+ - *Default:* default GitHub Actions user
12590
12734
 
12591
12735
  The git identity to use in workflows.
12592
12736
 
@@ -128,9 +128,9 @@ export interface ConstructProjectOptions {
128
128
  * NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned
129
129
  * and should remain on the same minor, so we recommend using a `~` dependency
130
130
  * (e.g. `~5.0.0`).
131
- * @default "~5.6.0"
131
+ * @default "~5.8.0"
132
132
  * @stability stable
133
- * @pjnew "~5.8.0"
133
+ * @pjnew "~5.9.0"
134
134
  */
135
135
  readonly jsiiVersion?: string;
136
136
  /**
@@ -266,7 +266,7 @@ export interface ConstructProjectOptions {
266
266
  readonly eslintOptions?: javascript.EslintOptions;
267
267
  /**
268
268
  * Setup eslint.
269
- * @default true
269
+ * @default - true, unless biome is enabled
270
270
  * @stability stable
271
271
  */
272
272
  readonly eslint?: boolean;
@@ -315,7 +315,7 @@ export interface ConstructProjectOptions {
315
315
  readonly workflowNodeVersion?: string;
316
316
  /**
317
317
  * The git identity to use in workflows.
318
- * @default - GitHub Actions
318
+ * @default - default GitHub Actions user
319
319
  * @stability stable
320
320
  */
321
321
  readonly workflowGitIdentity?: github.GitIdentity;
@@ -458,13 +458,13 @@ export interface ConstructProjectOptions {
458
458
  */
459
459
  readonly copyrightOwner?: string;
460
460
  /**
461
- * Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
462
- * @default - if this option is not specified, only public repositories are supported
461
+ * Define the secret name for a specified https://codecov.io/ token.
462
+ * @default - OIDC auth is used
463
463
  * @stability stable
464
464
  */
465
465
  readonly codeCovTokenSecret?: string;
466
466
  /**
467
- * 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`.
467
+ * 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`.
468
468
  * @default false
469
469
  * @stability stable
470
470
  */
@@ -562,6 +562,12 @@ export interface ConstructProjectOptions {
562
562
  * @stability stable
563
563
  */
564
564
  readonly releaseWorkflowName?: string;
565
+ /**
566
+ * Build environment variables for release workflows.
567
+ * @default {}
568
+ * @stability stable
569
+ */
570
+ readonly releaseWorkflowEnv?: Record<string, string>;
565
571
  /**
566
572
  * The release trigger to use.
567
573
  * @default - Continuous releases (`ReleaseTrigger.continuous()`)
@@ -591,6 +597,17 @@ export interface ConstructProjectOptions {
591
597
  * @stability stable
592
598
  */
593
599
  readonly releaseFailureIssue?: boolean;
600
+ /**
601
+ * The GitHub Actions environment used for the release.
602
+ * This can be used to add an explicit approval step to the release
603
+ * or limit who can initiate a release through environment protection rules.
604
+ *
605
+ * When multiple artifacts are released, the environment can be overwritten
606
+ * on a per artifact basis.
607
+ * @default - no environment used, unless set at the artifact level
608
+ * @stability stable
609
+ */
610
+ readonly releaseEnvironment?: string;
594
611
  /**
595
612
  * Defines additional release branches.
596
613
  * A workflow will be created for each
@@ -770,6 +787,12 @@ export interface ConstructProjectOptions {
770
787
  * @stability stable
771
788
  */
772
789
  readonly packageManager?: javascript.NodePackageManager;
790
+ /**
791
+ * Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
792
+ * @default - false
793
+ * @stability stable
794
+ */
795
+ readonly npmTrustedPublishing?: boolean;
773
796
  /**
774
797
  * GitHub secret which contains the NPM token to use when publishing packages.
775
798
  * @default "NPM_TOKEN"