projen-modules 1.0.171 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +531 -351
- package/API.md +171 -27
- package/lib/components/readme/elements/section.js +1 -1
- package/lib/components/readme/index.js +1 -1
- package/lib/projects/cdk-ts/cdk-typescript-app-options.d.ts +34 -8
- package/lib/projects/cdk-ts/cdk-typescript-app-options.js +1 -1
- package/lib/projects/cdk-ts/index.js +1 -1
- package/lib/projects/jsii/index.js +1 -1
- package/lib/projects/jsii/jsii-project-options.d.ts +30 -7
- package/lib/projects/jsii/jsii-project-options.js +1 -1
- package/lib/projects/npm/index.js +1 -1
- package/lib/projects/npm/npm-package-options.d.ts +28 -5
- package/lib/projects/npm/npm-package-options.js +1 -1
- package/lib/projects/python/index.js +1 -1
- package/package.json +5 -5
package/API.md
CHANGED
|
@@ -5977,8 +5977,8 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
5977
5977
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
5978
5978
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
5979
5979
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
5980
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.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@
|
|
5981
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token
|
|
5980
|
+
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.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`. |
|
|
5981
|
+
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
5982
5982
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
5983
5983
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.constructsVersion">constructsVersion</a></code> | <code>string</code> | Minimum version of the `constructs` library to depend on. |
|
|
5984
5984
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.context">context</a></code> | <code>{[ key: string ]: any}</code> | Additional context to include in `cdk.json`. |
|
|
@@ -6003,7 +6003,7 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6003
6003
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.eslint">eslint</a></code> | <code>boolean</code> | Setup eslint. |
|
|
6004
6004
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.eslintOptions">eslintOptions</a></code> | <code>projen.javascript.EslintOptions</code> | Eslint options. |
|
|
6005
6005
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.experimentalIntegRunner">experimentalIntegRunner</a></code> | <code>boolean</code> | Enable experimental support for the AWS CDK integ-runner. |
|
|
6006
|
-
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.featureFlags">featureFlags</a></code> | <code>
|
|
6006
|
+
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.featureFlags">featureFlags</a></code> | <code>projen.awscdk.ICdkFeatureFlags</code> | Feature flags that should be enabled in `cdk.json`. Make sure to double-check any changes to feature flags in `cdk.json` before deploying. Unexpected changes may cause breaking changes in your CDK app. You can overwrite any feature flag by passing it into the context field. |
|
|
6007
6007
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
6008
6008
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
6009
6009
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
@@ -6040,6 +6040,7 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6040
6040
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
6041
6041
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
6042
6042
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
6043
|
+
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.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. |
|
|
6043
6044
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
|
|
6044
6045
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.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`). |
|
|
6045
6046
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
@@ -6072,6 +6073,7 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6072
6073
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
6073
6074
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
6074
6075
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
6076
|
+
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
6075
6077
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
6076
6078
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
6077
6079
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
@@ -6080,6 +6082,7 @@ const cdkTypeScriptAppOptions: CdkTypeScriptAppOptions = { ... }
|
|
|
6080
6082
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
6081
6083
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
6082
6084
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
6085
|
+
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
6083
6086
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
6084
6087
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.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. |
|
|
6085
6088
|
| <code><a href="#projen-modules.CdkTypeScriptAppOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -6695,7 +6698,7 @@ public readonly codeCov: boolean;
|
|
|
6695
6698
|
- *Type:* boolean
|
|
6696
6699
|
- *Default:* false
|
|
6697
6700
|
|
|
6698
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
6701
|
+
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`.
|
|
6699
6702
|
|
|
6700
6703
|
---
|
|
6701
6704
|
|
|
@@ -6706,9 +6709,9 @@ public readonly codeCovTokenSecret: string;
|
|
|
6706
6709
|
```
|
|
6707
6710
|
|
|
6708
6711
|
- *Type:* string
|
|
6709
|
-
- *Default:*
|
|
6712
|
+
- *Default:* OIDC auth is used
|
|
6710
6713
|
|
|
6711
|
-
Define the secret name for a specified https://codecov.io/ token
|
|
6714
|
+
Define the secret name for a specified https://codecov.io/ token.
|
|
6712
6715
|
|
|
6713
6716
|
---
|
|
6714
6717
|
|
|
@@ -7016,7 +7019,7 @@ public readonly eslint: boolean;
|
|
|
7016
7019
|
```
|
|
7017
7020
|
|
|
7018
7021
|
- *Type:* boolean
|
|
7019
|
-
- *Default:* true
|
|
7022
|
+
- *Default:* true, unless biome is enabled
|
|
7020
7023
|
|
|
7021
7024
|
Setup eslint.
|
|
7022
7025
|
|
|
@@ -7051,13 +7054,13 @@ Enable experimental support for the AWS CDK integ-runner.
|
|
|
7051
7054
|
##### `featureFlags`<sup>Optional</sup> <a name="featureFlags" id="projen-modules.CdkTypeScriptAppOptions.property.featureFlags"></a>
|
|
7052
7055
|
|
|
7053
7056
|
```typescript
|
|
7054
|
-
public readonly featureFlags:
|
|
7057
|
+
public readonly featureFlags: ICdkFeatureFlags;
|
|
7055
7058
|
```
|
|
7056
7059
|
|
|
7057
|
-
- *Type:*
|
|
7058
|
-
- *Default:*
|
|
7060
|
+
- *Type:* projen.awscdk.ICdkFeatureFlags
|
|
7061
|
+
- *Default:* no feature flags are enabled by default
|
|
7059
7062
|
|
|
7060
|
-
|
|
7063
|
+
Feature flags that should be enabled in `cdk.json`. Make sure to double-check any changes to feature flags in `cdk.json` before deploying. Unexpected changes may cause breaking changes in your CDK app. You can overwrite any feature flag by passing it into the context field.
|
|
7061
7064
|
|
|
7062
7065
|
---
|
|
7063
7066
|
|
|
@@ -7600,6 +7603,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
7600
7603
|
|
|
7601
7604
|
---
|
|
7602
7605
|
|
|
7606
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="projen-modules.CdkTypeScriptAppOptions.property.npmTrustedPublishing"></a>
|
|
7607
|
+
|
|
7608
|
+
```typescript
|
|
7609
|
+
public readonly npmTrustedPublishing: boolean;
|
|
7610
|
+
```
|
|
7611
|
+
|
|
7612
|
+
- *Type:* boolean
|
|
7613
|
+
- *Default:* false
|
|
7614
|
+
|
|
7615
|
+
Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
7616
|
+
|
|
7617
|
+
---
|
|
7618
|
+
|
|
7603
7619
|
##### `outdir`<sup>Optional</sup> <a name="outdir" id="projen-modules.CdkTypeScriptAppOptions.property.outdir"></a>
|
|
7604
7620
|
|
|
7605
7621
|
```typescript
|
|
@@ -8049,6 +8065,25 @@ be provided for the default branch.
|
|
|
8049
8065
|
|
|
8050
8066
|
---
|
|
8051
8067
|
|
|
8068
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="projen-modules.CdkTypeScriptAppOptions.property.releaseEnvironment"></a>
|
|
8069
|
+
|
|
8070
|
+
```typescript
|
|
8071
|
+
public readonly releaseEnvironment: string;
|
|
8072
|
+
```
|
|
8073
|
+
|
|
8074
|
+
- *Type:* string
|
|
8075
|
+
- *Default:* no environment used, unless set at the artifact level
|
|
8076
|
+
|
|
8077
|
+
The GitHub Actions environment used for the release.
|
|
8078
|
+
|
|
8079
|
+
This can be used to add an explicit approval step to the release
|
|
8080
|
+
or limit who can initiate a release through environment protection rules.
|
|
8081
|
+
|
|
8082
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
8083
|
+
on a per artifact basis.
|
|
8084
|
+
|
|
8085
|
+
---
|
|
8086
|
+
|
|
8052
8087
|
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="projen-modules.CdkTypeScriptAppOptions.property.releaseEveryCommit"></a>
|
|
8053
8088
|
|
|
8054
8089
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
@@ -8167,6 +8202,19 @@ DEPRECATED: renamed to `release`.
|
|
|
8167
8202
|
|
|
8168
8203
|
---
|
|
8169
8204
|
|
|
8205
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflowEnv"></a>
|
|
8206
|
+
|
|
8207
|
+
```typescript
|
|
8208
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
8209
|
+
```
|
|
8210
|
+
|
|
8211
|
+
- *Type:* {[ key: string ]: string}
|
|
8212
|
+
- *Default:* {}
|
|
8213
|
+
|
|
8214
|
+
Build environment variables for release workflows.
|
|
8215
|
+
|
|
8216
|
+
---
|
|
8217
|
+
|
|
8170
8218
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="projen-modules.CdkTypeScriptAppOptions.property.releaseWorkflowName"></a>
|
|
8171
8219
|
|
|
8172
8220
|
```typescript
|
|
@@ -8532,7 +8580,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
8532
8580
|
```
|
|
8533
8581
|
|
|
8534
8582
|
- *Type:* projen.github.GitIdentity
|
|
8535
|
-
- *Default:* GitHub Actions
|
|
8583
|
+
- *Default:* default GitHub Actions user
|
|
8536
8584
|
|
|
8537
8585
|
The git identity to use in workflows.
|
|
8538
8586
|
|
|
@@ -8651,8 +8699,8 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
8651
8699
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
8652
8700
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
8653
8701
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
8654
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.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@
|
|
8655
|
-
| <code><a href="#projen-modules.JsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token
|
|
8702
|
+
| <code><a href="#projen-modules.JsiiProjectOptions.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`. |
|
|
8703
|
+
| <code><a href="#projen-modules.JsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
8656
8704
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
8657
8705
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
|
|
8658
8706
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
|
|
@@ -8712,6 +8760,7 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
8712
8760
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
8713
8761
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
8714
8762
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
8763
|
+
| <code><a href="#projen-modules.JsiiProjectOptions.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. |
|
|
8715
8764
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
|
|
8716
8765
|
| <code><a href="#projen-modules.JsiiProjectOptions.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`). |
|
|
8717
8766
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
@@ -8749,6 +8798,7 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
8749
8798
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
8750
8799
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
8751
8800
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
8801
|
+
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
8752
8802
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
8753
8803
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
8754
8804
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
@@ -8757,6 +8807,7 @@ const jsiiProjectOptions: JsiiProjectOptions = { ... }
|
|
|
8757
8807
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
8758
8808
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
8759
8809
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
8810
|
+
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
8760
8811
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
8761
8812
|
| <code><a href="#projen-modules.JsiiProjectOptions.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. |
|
|
8762
8813
|
| <code><a href="#projen-modules.JsiiProjectOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -9225,7 +9276,7 @@ public readonly codeCov: boolean;
|
|
|
9225
9276
|
- *Type:* boolean
|
|
9226
9277
|
- *Default:* false
|
|
9227
9278
|
|
|
9228
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
9279
|
+
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`.
|
|
9229
9280
|
|
|
9230
9281
|
---
|
|
9231
9282
|
|
|
@@ -9236,9 +9287,9 @@ public readonly codeCovTokenSecret: string;
|
|
|
9236
9287
|
```
|
|
9237
9288
|
|
|
9238
9289
|
- *Type:* string
|
|
9239
|
-
- *Default:*
|
|
9290
|
+
- *Default:* OIDC auth is used
|
|
9240
9291
|
|
|
9241
|
-
Define the secret name for a specified https://codecov.io/ token
|
|
9292
|
+
Define the secret name for a specified https://codecov.io/ token.
|
|
9242
9293
|
|
|
9243
9294
|
---
|
|
9244
9295
|
|
|
@@ -9574,7 +9625,7 @@ public readonly eslint: boolean;
|
|
|
9574
9625
|
```
|
|
9575
9626
|
|
|
9576
9627
|
- *Type:* boolean
|
|
9577
|
-
- *Default:* true
|
|
9628
|
+
- *Default:* true, unless biome is enabled
|
|
9578
9629
|
|
|
9579
9630
|
Setup eslint.
|
|
9580
9631
|
|
|
@@ -9744,7 +9795,7 @@ public readonly jsiiVersion: string;
|
|
|
9744
9795
|
```
|
|
9745
9796
|
|
|
9746
9797
|
- *Type:* string
|
|
9747
|
-
- *Default:* "~5.
|
|
9798
|
+
- *Default:* "~5.8.0"
|
|
9748
9799
|
|
|
9749
9800
|
Version of the jsii compiler to use.
|
|
9750
9801
|
|
|
@@ -10116,6 +10167,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
10116
10167
|
|
|
10117
10168
|
---
|
|
10118
10169
|
|
|
10170
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="projen-modules.JsiiProjectOptions.property.npmTrustedPublishing"></a>
|
|
10171
|
+
|
|
10172
|
+
```typescript
|
|
10173
|
+
public readonly npmTrustedPublishing: boolean;
|
|
10174
|
+
```
|
|
10175
|
+
|
|
10176
|
+
- *Type:* boolean
|
|
10177
|
+
- *Default:* false
|
|
10178
|
+
|
|
10179
|
+
Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
10180
|
+
|
|
10181
|
+
---
|
|
10182
|
+
|
|
10119
10183
|
##### `outdir`<sup>Optional</sup> <a name="outdir" id="projen-modules.JsiiProjectOptions.property.outdir"></a>
|
|
10120
10184
|
|
|
10121
10185
|
```typescript
|
|
@@ -10629,6 +10693,25 @@ be provided for the default branch.
|
|
|
10629
10693
|
|
|
10630
10694
|
---
|
|
10631
10695
|
|
|
10696
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="projen-modules.JsiiProjectOptions.property.releaseEnvironment"></a>
|
|
10697
|
+
|
|
10698
|
+
```typescript
|
|
10699
|
+
public readonly releaseEnvironment: string;
|
|
10700
|
+
```
|
|
10701
|
+
|
|
10702
|
+
- *Type:* string
|
|
10703
|
+
- *Default:* no environment used, unless set at the artifact level
|
|
10704
|
+
|
|
10705
|
+
The GitHub Actions environment used for the release.
|
|
10706
|
+
|
|
10707
|
+
This can be used to add an explicit approval step to the release
|
|
10708
|
+
or limit who can initiate a release through environment protection rules.
|
|
10709
|
+
|
|
10710
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
10711
|
+
on a per artifact basis.
|
|
10712
|
+
|
|
10713
|
+
---
|
|
10714
|
+
|
|
10632
10715
|
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="projen-modules.JsiiProjectOptions.property.releaseEveryCommit"></a>
|
|
10633
10716
|
|
|
10634
10717
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
@@ -10747,6 +10830,19 @@ DEPRECATED: renamed to `release`.
|
|
|
10747
10830
|
|
|
10748
10831
|
---
|
|
10749
10832
|
|
|
10833
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="projen-modules.JsiiProjectOptions.property.releaseWorkflowEnv"></a>
|
|
10834
|
+
|
|
10835
|
+
```typescript
|
|
10836
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
10837
|
+
```
|
|
10838
|
+
|
|
10839
|
+
- *Type:* {[ key: string ]: string}
|
|
10840
|
+
- *Default:* {}
|
|
10841
|
+
|
|
10842
|
+
Build environment variables for release workflows.
|
|
10843
|
+
|
|
10844
|
+
---
|
|
10845
|
+
|
|
10750
10846
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="projen-modules.JsiiProjectOptions.property.releaseWorkflowName"></a>
|
|
10751
10847
|
|
|
10752
10848
|
```typescript
|
|
@@ -11084,7 +11180,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
11084
11180
|
```
|
|
11085
11181
|
|
|
11086
11182
|
- *Type:* projen.github.GitIdentity
|
|
11087
|
-
- *Default:* GitHub Actions
|
|
11183
|
+
- *Default:* default GitHub Actions user
|
|
11088
11184
|
|
|
11089
11185
|
The git identity to use in workflows.
|
|
11090
11186
|
|
|
@@ -11200,8 +11296,8 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11200
11296
|
| <code><a href="#projen-modules.NpmPackageOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
11201
11297
|
| <code><a href="#projen-modules.NpmPackageOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
|
|
11202
11298
|
| <code><a href="#projen-modules.NpmPackageOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
|
|
11203
|
-
| <code><a href="#projen-modules.NpmPackageOptions.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@
|
|
11204
|
-
| <code><a href="#projen-modules.NpmPackageOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token
|
|
11299
|
+
| <code><a href="#projen-modules.NpmPackageOptions.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`. |
|
|
11300
|
+
| <code><a href="#projen-modules.NpmPackageOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
11205
11301
|
| <code><a href="#projen-modules.NpmPackageOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
|
|
11206
11302
|
| <code><a href="#projen-modules.NpmPackageOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
11207
11303
|
| <code><a href="#projen-modules.NpmPackageOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
@@ -11254,6 +11350,7 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11254
11350
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
11255
11351
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
11256
11352
|
| <code><a href="#projen-modules.NpmPackageOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
11353
|
+
| <code><a href="#projen-modules.NpmPackageOptions.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. |
|
|
11257
11354
|
| <code><a href="#projen-modules.NpmPackageOptions.property.outdir">outdir</a></code> | <code>string</code> | The root directory of the project. Relative to this directory, all files are synthesized. |
|
|
11258
11355
|
| <code><a href="#projen-modules.NpmPackageOptions.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`). |
|
|
11259
11356
|
| <code><a href="#projen-modules.NpmPackageOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
@@ -11286,6 +11383,7 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11286
11383
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
11287
11384
|
| <code><a href="#projen-modules.NpmPackageOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
11288
11385
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
11386
|
+
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
11289
11387
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
11290
11388
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
11291
11389
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
@@ -11294,6 +11392,7 @@ const npmPackageOptions: NpmPackageOptions = { ... }
|
|
|
11294
11392
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
11295
11393
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
11296
11394
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
11395
|
+
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
11297
11396
|
| <code><a href="#projen-modules.NpmPackageOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
11298
11397
|
| <code><a href="#projen-modules.NpmPackageOptions.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. |
|
|
11299
11398
|
| <code><a href="#projen-modules.NpmPackageOptions.property.renovatebot">renovatebot</a></code> | <code>boolean</code> | Use renovatebot to handle dependency upgrades. |
|
|
@@ -11722,7 +11821,7 @@ public readonly codeCov: boolean;
|
|
|
11722
11821
|
- *Type:* boolean
|
|
11723
11822
|
- *Default:* false
|
|
11724
11823
|
|
|
11725
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
11824
|
+
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`.
|
|
11726
11825
|
|
|
11727
11826
|
---
|
|
11728
11827
|
|
|
@@ -11733,9 +11832,9 @@ public readonly codeCovTokenSecret: string;
|
|
|
11733
11832
|
```
|
|
11734
11833
|
|
|
11735
11834
|
- *Type:* string
|
|
11736
|
-
- *Default:*
|
|
11835
|
+
- *Default:* OIDC auth is used
|
|
11737
11836
|
|
|
11738
|
-
Define the secret name for a specified https://codecov.io/ token
|
|
11837
|
+
Define the secret name for a specified https://codecov.io/ token.
|
|
11739
11838
|
|
|
11740
11839
|
---
|
|
11741
11840
|
|
|
@@ -12004,7 +12103,7 @@ public readonly eslint: boolean;
|
|
|
12004
12103
|
```
|
|
12005
12104
|
|
|
12006
12105
|
- *Type:* boolean
|
|
12007
|
-
- *Default:* true
|
|
12106
|
+
- *Default:* true, unless biome is enabled
|
|
12008
12107
|
|
|
12009
12108
|
Setup eslint.
|
|
12010
12109
|
|
|
@@ -12510,6 +12609,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
12510
12609
|
|
|
12511
12610
|
---
|
|
12512
12611
|
|
|
12612
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="projen-modules.NpmPackageOptions.property.npmTrustedPublishing"></a>
|
|
12613
|
+
|
|
12614
|
+
```typescript
|
|
12615
|
+
public readonly npmTrustedPublishing: boolean;
|
|
12616
|
+
```
|
|
12617
|
+
|
|
12618
|
+
- *Type:* boolean
|
|
12619
|
+
- *Default:* false
|
|
12620
|
+
|
|
12621
|
+
Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
12622
|
+
|
|
12623
|
+
---
|
|
12624
|
+
|
|
12513
12625
|
##### `outdir`<sup>Optional</sup> <a name="outdir" id="projen-modules.NpmPackageOptions.property.outdir"></a>
|
|
12514
12626
|
|
|
12515
12627
|
```typescript
|
|
@@ -12959,6 +13071,25 @@ be provided for the default branch.
|
|
|
12959
13071
|
|
|
12960
13072
|
---
|
|
12961
13073
|
|
|
13074
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="projen-modules.NpmPackageOptions.property.releaseEnvironment"></a>
|
|
13075
|
+
|
|
13076
|
+
```typescript
|
|
13077
|
+
public readonly releaseEnvironment: string;
|
|
13078
|
+
```
|
|
13079
|
+
|
|
13080
|
+
- *Type:* string
|
|
13081
|
+
- *Default:* no environment used, unless set at the artifact level
|
|
13082
|
+
|
|
13083
|
+
The GitHub Actions environment used for the release.
|
|
13084
|
+
|
|
13085
|
+
This can be used to add an explicit approval step to the release
|
|
13086
|
+
or limit who can initiate a release through environment protection rules.
|
|
13087
|
+
|
|
13088
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
13089
|
+
on a per artifact basis.
|
|
13090
|
+
|
|
13091
|
+
---
|
|
13092
|
+
|
|
12962
13093
|
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="projen-modules.NpmPackageOptions.property.releaseEveryCommit"></a>
|
|
12963
13094
|
|
|
12964
13095
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
@@ -13077,6 +13208,19 @@ DEPRECATED: renamed to `release`.
|
|
|
13077
13208
|
|
|
13078
13209
|
---
|
|
13079
13210
|
|
|
13211
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="projen-modules.NpmPackageOptions.property.releaseWorkflowEnv"></a>
|
|
13212
|
+
|
|
13213
|
+
```typescript
|
|
13214
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
13215
|
+
```
|
|
13216
|
+
|
|
13217
|
+
- *Type:* {[ key: string ]: string}
|
|
13218
|
+
- *Default:* {}
|
|
13219
|
+
|
|
13220
|
+
Build environment variables for release workflows.
|
|
13221
|
+
|
|
13222
|
+
---
|
|
13223
|
+
|
|
13080
13224
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="projen-modules.NpmPackageOptions.property.releaseWorkflowName"></a>
|
|
13081
13225
|
|
|
13082
13226
|
```typescript
|
|
@@ -13403,7 +13547,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
13403
13547
|
```
|
|
13404
13548
|
|
|
13405
13549
|
- *Type:* projen.github.GitIdentity
|
|
13406
|
-
- *Default:* GitHub Actions
|
|
13550
|
+
- *Default:* default GitHub Actions user
|
|
13407
13551
|
|
|
13408
13552
|
The git identity to use in workflows.
|
|
13409
13553
|
|
|
@@ -15,5 +15,5 @@ ${this.options.body}`;
|
|
|
15
15
|
}
|
|
16
16
|
exports.Section = Section;
|
|
17
17
|
_a = JSII_RTTI_SYMBOL_1;
|
|
18
|
-
Section[_a] = { fqn: "projen-modules.Section", version: "1.0
|
|
18
|
+
Section[_a] = { fqn: "projen-modules.Section", version: "1.1.0" };
|
|
19
19
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9jb21wb25lbnRzL3JlYWRtZS9lbGVtZW50cy9zZWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBS0EsTUFBYSxPQUFPO0lBRWxCLFlBQVksT0FBd0I7UUFDbEMsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUM7SUFDekIsQ0FBQztJQUNELEtBQUs7UUFDSCxPQUFPLE1BQU0sSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLOztFQUVqQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxDQUFDO0lBQ3BCLENBQUM7O0FBVEgsMEJBVUMiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgaW50ZXJmYWNlIElTZWN0aW9uT3B0aW9ucyB7XG4gIHRpdGxlOiBzdHJpbmc7XG4gIGJvZHk6IHN0cmluZztcbn1cblxuZXhwb3J0IGNsYXNzIFNlY3Rpb24ge1xuICByZWFkb25seSBvcHRpb25zOiBJU2VjdGlvbk9wdGlvbnM7XG4gIGNvbnN0cnVjdG9yKG9wdGlvbnM6IElTZWN0aW9uT3B0aW9ucykge1xuICAgIHRoaXMub3B0aW9ucyA9IG9wdGlvbnM7XG4gIH1cbiAgc3ludGgoKSB7XG4gICAgcmV0dXJuIGAjIyAke3RoaXMub3B0aW9ucy50aXRsZX1cblxuJHt0aGlzLm9wdGlvbnMuYm9keX1gO1xuICB9XG59XG4iXX0=
|
|
@@ -22,5 +22,5 @@ class Readme extends projen_1.FileBase {
|
|
|
22
22
|
}
|
|
23
23
|
exports.Readme = Readme;
|
|
24
24
|
_a = JSII_RTTI_SYMBOL_1;
|
|
25
|
-
Readme[_a] = { fqn: "projen-modules.Readme", version: "1.0
|
|
25
|
+
Readme[_a] = { fqn: "projen-modules.Readme", version: "1.1.0" };
|
|
26
26
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29tcG9uZW50cy9yZWFkbWUvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxtQ0FBc0Q7QUFDdEQsZ0RBQTZDO0FBUzdDLE1BQWEsTUFBTyxTQUFRLGlCQUFRO0lBR2xDLFlBQVksT0FBZ0IsRUFBRSxVQUF5QixFQUFFO1FBQ3ZELEtBQUssQ0FBQyxPQUFPLEVBQUUsV0FBVyxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBRmxDLGFBQVEsR0FBbUIsRUFBRSxDQUFDO1FBRzVCLElBQUksQ0FBQyxXQUFXLEdBQUcsT0FBTyxDQUFDLFdBQVcsQ0FBQztJQUN6QyxDQUFDO0lBRUQsVUFBVSxDQUFDLEtBQWEsRUFBRSxJQUFZO1FBQ3BDLElBQUksQ0FBQyxRQUFRLENBQUMsSUFBSSxDQUFDLElBQUksaUJBQU8sQ0FBQyxFQUFFLEtBQUssRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDLENBQUM7SUFDbkQsQ0FBQztJQUVTLGlCQUFpQixDQUFDLENBQVk7UUFDdEMsSUFBSSxPQUFPLEdBQUcsS0FBSyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksTUFBTSxDQUFDO1FBQzNDLE9BQU8sR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDLEdBQUcsSUFBSSxDQUFDLFdBQVcsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUM1RSxPQUFPLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDO0lBQzFFLENBQUM7O0FBaEJILHdCQWlCQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEZpbGVCYXNlLCBJUmVzb2x2ZXIsIFByb2plY3QgfSBmcm9tICdwcm9qZW4nO1xuaW1wb3J0IHsgU2VjdGlvbiB9IGZyb20gJy4vZWxlbWVudHMvc2VjdGlvbic7XG5cbmV4cG9ydCBpbnRlcmZhY2UgUmVhZG1lT3B0aW9ucyB7XG4gIC8qKlxuICAgKiBUaGUgZGVzY3JpcHRpb24gb2YgdGhlIHByb2plY3QuXG4gICAqL1xuICByZWFkb25seSBkZXNjcmlwdGlvbj86IHN0cmluZztcbn1cblxuZXhwb3J0IGNsYXNzIFJlYWRtZSBleHRlbmRzIEZpbGVCYXNlIHtcbiAgZGVzY3JpcHRpb246IHN0cmluZyB8IHVuZGVmaW5lZDtcbiAgc2VjdGlvbnM6IEFycmF5PFNlY3Rpb24+ID0gW107XG4gIGNvbnN0cnVjdG9yKHByb2plY3Q6IFByb2plY3QsIG9wdGlvbnM6IFJlYWRtZU9wdGlvbnMgPSB7fSkge1xuICAgIHN1cGVyKHByb2plY3QsICdSRUFETUUubWQnLCB7fSk7XG4gICAgdGhpcy5kZXNjcmlwdGlvbiA9IG9wdGlvbnMuZGVzY3JpcHRpb247XG4gIH1cblxuICBhZGRTZWN0aW9uKHRpdGxlOiBzdHJpbmcsIGJvZHk6IHN0cmluZykge1xuICAgIHRoaXMuc2VjdGlvbnMucHVzaChuZXcgU2VjdGlvbih7IHRpdGxlLCBib2R5IH0pKTtcbiAgfVxuXG4gIHByb3RlY3RlZCBzeW50aGVzaXplQ29udGVudChfOiBJUmVzb2x2ZXIpOiBzdHJpbmcgfCB1bmRlZmluZWQge1xuICAgIGxldCBjb250ZW50ID0gYCMgJHt0aGlzLnByb2plY3QubmFtZX1cXG5cXG5gO1xuICAgIGNvbnRlbnQgPSBjb250ZW50LmNvbmNhdCh0aGlzLmRlc2NyaXB0aW9uID8gYCR7dGhpcy5kZXNjcmlwdGlvbn1cXG5cXG5gIDogJycpO1xuICAgIHJldHVybiBjb250ZW50LmNvbmNhdCh0aGlzLnNlY3Rpb25zLm1hcCgocykgPT4gcy5zeW50aCgpKS5qb2luKCdcXG5cXG4nKSk7XG4gIH1cbn1cbiJdfQ==
|
|
@@ -142,11 +142,14 @@ export interface CdkTypeScriptAppOptions {
|
|
|
142
142
|
*/
|
|
143
143
|
readonly requireApproval?: awscdk.ApprovalLevel;
|
|
144
144
|
/**
|
|
145
|
-
*
|
|
146
|
-
*
|
|
145
|
+
* Feature flags that should be enabled in `cdk.json`.
|
|
146
|
+
* Make sure to double-check any changes to feature flags in `cdk.json` before deploying.
|
|
147
|
+
* Unexpected changes may cause breaking changes in your CDK app.
|
|
148
|
+
* You can overwrite any feature flag by passing it into the context field.
|
|
149
|
+
* @default - no feature flags are enabled by default
|
|
147
150
|
* @stability experimental
|
|
148
151
|
*/
|
|
149
|
-
readonly featureFlags?:
|
|
152
|
+
readonly featureFlags?: awscdk.ICdkFeatureFlags;
|
|
150
153
|
/**
|
|
151
154
|
* Additional context to include in `cdk.json`.
|
|
152
155
|
* @default - no additional context
|
|
@@ -247,7 +250,7 @@ export interface CdkTypeScriptAppOptions {
|
|
|
247
250
|
readonly eslintOptions?: javascript.EslintOptions;
|
|
248
251
|
/**
|
|
249
252
|
* Setup eslint.
|
|
250
|
-
* @default true
|
|
253
|
+
* @default - true, unless biome is enabled
|
|
251
254
|
* @stability experimental
|
|
252
255
|
*/
|
|
253
256
|
readonly eslint?: boolean;
|
|
@@ -296,7 +299,7 @@ export interface CdkTypeScriptAppOptions {
|
|
|
296
299
|
readonly workflowNodeVersion?: string;
|
|
297
300
|
/**
|
|
298
301
|
* The git identity to use in workflows.
|
|
299
|
-
* @default - GitHub Actions
|
|
302
|
+
* @default - default GitHub Actions user
|
|
300
303
|
* @stability experimental
|
|
301
304
|
*/
|
|
302
305
|
readonly workflowGitIdentity?: github.GitIdentity;
|
|
@@ -464,13 +467,13 @@ export interface CdkTypeScriptAppOptions {
|
|
|
464
467
|
*/
|
|
465
468
|
readonly copyrightOwner?: string;
|
|
466
469
|
/**
|
|
467
|
-
* Define the secret name for a specified https://codecov.io/ token
|
|
468
|
-
* @default -
|
|
470
|
+
* Define the secret name for a specified https://codecov.io/ token.
|
|
471
|
+
* @default - OIDC auth is used
|
|
469
472
|
* @stability experimental
|
|
470
473
|
*/
|
|
471
474
|
readonly codeCovTokenSecret?: string;
|
|
472
475
|
/**
|
|
473
|
-
* Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
476
|
+
* 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`.
|
|
474
477
|
* @default false
|
|
475
478
|
* @stability experimental
|
|
476
479
|
*/
|
|
@@ -575,6 +578,12 @@ export interface CdkTypeScriptAppOptions {
|
|
|
575
578
|
* @stability experimental
|
|
576
579
|
*/
|
|
577
580
|
readonly releaseWorkflowName?: string;
|
|
581
|
+
/**
|
|
582
|
+
* Build environment variables for release workflows.
|
|
583
|
+
* @default {}
|
|
584
|
+
* @stability experimental
|
|
585
|
+
*/
|
|
586
|
+
readonly releaseWorkflowEnv?: Record<string, string>;
|
|
578
587
|
/**
|
|
579
588
|
* The release trigger to use.
|
|
580
589
|
* @default - Continuous releases (`ReleaseTrigger.continuous()`)
|
|
@@ -618,6 +627,17 @@ export interface CdkTypeScriptAppOptions {
|
|
|
618
627
|
* @stability deprecated
|
|
619
628
|
*/
|
|
620
629
|
readonly releaseEveryCommit?: boolean;
|
|
630
|
+
/**
|
|
631
|
+
* The GitHub Actions environment used for the release.
|
|
632
|
+
* This can be used to add an explicit approval step to the release
|
|
633
|
+
* or limit who can initiate a release through environment protection rules.
|
|
634
|
+
*
|
|
635
|
+
* When multiple artifacts are released, the environment can be overwritten
|
|
636
|
+
* on a per artifact basis.
|
|
637
|
+
* @default - no environment used, unless set at the artifact level
|
|
638
|
+
* @stability experimental
|
|
639
|
+
*/
|
|
640
|
+
readonly releaseEnvironment?: string;
|
|
621
641
|
/**
|
|
622
642
|
* Defines additional release branches.
|
|
623
643
|
* A workflow will be created for each
|
|
@@ -807,6 +827,12 @@ export interface CdkTypeScriptAppOptions {
|
|
|
807
827
|
* @stability experimental
|
|
808
828
|
*/
|
|
809
829
|
readonly packageManager?: javascript.NodePackageManager;
|
|
830
|
+
/**
|
|
831
|
+
* Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
832
|
+
* @default - false
|
|
833
|
+
* @stability experimental
|
|
834
|
+
*/
|
|
835
|
+
readonly npmTrustedPublishing?: boolean;
|
|
810
836
|
/**
|
|
811
837
|
* GitHub secret which contains the NPM token to use when publishing packages.
|
|
812
838
|
* @default "NPM_TOKEN"
|