cdklabs-projen-project-types 0.6.19 → 0.6.21
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 +645 -348
- package/.yarn/install-state.gz +0 -0
- package/API.md +595 -9
- package/lib/cdk-construct-library-options.d.ts +27 -1
- package/lib/cdk-construct-library-options.js +1 -1
- package/lib/cdk-jsii-options.d.ts +27 -1
- package/lib/cdk-jsii-options.js +1 -1
- package/lib/cdk.js +2 -2
- package/lib/cdklabs.js +3 -3
- package/lib/check-gha-expressions.js +1 -1
- package/lib/jsii.js +1 -1
- package/lib/rosetta.js +1 -1
- package/lib/yarn/constraints.js +1 -1
- package/lib/yarn/jsii-build.js +1 -1
- package/lib/yarn/monorepo-options.d.ts +27 -1
- package/lib/yarn/monorepo-options.js +1 -1
- package/lib/yarn/monorepo-release.js +1 -1
- package/lib/yarn/monorepo.js +2 -2
- package/lib/yarn/typescript-workspace-options.d.ts +27 -1
- package/lib/yarn/typescript-workspace-options.js +1 -1
- package/lib/yarn/typescript-workspace-release.d.ts +2 -0
- package/lib/yarn/typescript-workspace-release.js +4 -2
- package/lib/yarn/typescript-workspace.js +4 -2
- package/package.json +3 -3
package/API.md
CHANGED
|
@@ -14389,6 +14389,8 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
14389
14389
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
14390
14390
|
| <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. |
|
|
14391
14391
|
| <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. |
|
|
14392
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
14393
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
14392
14394
|
| <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. |
|
|
14393
14395
|
| <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`). |
|
|
14394
14396
|
| <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. |
|
|
@@ -14469,6 +14471,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
|
|
|
14469
14471
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
14470
14472
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
|
|
14471
14473
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
14474
|
+
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
|
|
14472
14475
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
14473
14476
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
14474
14477
|
| <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
@@ -16028,7 +16031,8 @@ public readonly npmRegistryUrl: string;
|
|
|
16028
16031
|
|
|
16029
16032
|
The base URL of the npm package registry.
|
|
16030
16033
|
|
|
16031
|
-
Must be a URL (e.g. start with "https://" or "http://")
|
|
16034
|
+
Must be a URL (e.g. start with "https://" or "http://").
|
|
16035
|
+
A trailing slash is added if missing.
|
|
16032
16036
|
|
|
16033
16037
|
---
|
|
16034
16038
|
|
|
@@ -16058,6 +16062,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
16058
16062
|
|
|
16059
16063
|
---
|
|
16060
16064
|
|
|
16065
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmVerifyPublished"></a>
|
|
16066
|
+
|
|
16067
|
+
```typescript
|
|
16068
|
+
public readonly npmVerifyPublished: boolean;
|
|
16069
|
+
```
|
|
16070
|
+
|
|
16071
|
+
- *Type:* boolean
|
|
16072
|
+
- *Default:* false
|
|
16073
|
+
|
|
16074
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
16075
|
+
|
|
16076
|
+
Enable this when packages that depend on the published package are released right after.
|
|
16077
|
+
|
|
16078
|
+
---
|
|
16079
|
+
|
|
16080
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
16081
|
+
|
|
16082
|
+
```typescript
|
|
16083
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
16084
|
+
```
|
|
16085
|
+
|
|
16086
|
+
- *Type:* number
|
|
16087
|
+
- *Default:* 3600
|
|
16088
|
+
|
|
16089
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
16090
|
+
|
|
16091
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
16092
|
+
|
|
16093
|
+
---
|
|
16094
|
+
|
|
16061
16095
|
##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.outdir"></a>
|
|
16062
16096
|
|
|
16063
16097
|
```typescript
|
|
@@ -17165,6 +17199,28 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
17165
17199
|
|
|
17166
17200
|
---
|
|
17167
17201
|
|
|
17202
|
+
##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowPermissions"></a>
|
|
17203
|
+
|
|
17204
|
+
```typescript
|
|
17205
|
+
public readonly workflowPermissions: JobPermissions;
|
|
17206
|
+
```
|
|
17207
|
+
|
|
17208
|
+
- *Type:* projen.github.workflows.JobPermissions
|
|
17209
|
+
- *Default:* Use the job defaults and automatically inferred permissions.
|
|
17210
|
+
|
|
17211
|
+
Permissions for the main build, release and dependency upgrade jobs.
|
|
17212
|
+
|
|
17213
|
+
Defined scopes override the job defaults and automatically inferred permissions,
|
|
17214
|
+
including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
|
|
17215
|
+
Use `JobPermission.NONE` to explicitly remove a permission.
|
|
17216
|
+
|
|
17217
|
+
`buildWorkflowOptions.permissions` replaces this entire set, including automatic
|
|
17218
|
+
permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
|
|
17219
|
+
scopes. Applies to all release branches, but not to separate package, publishing,
|
|
17220
|
+
self-mutation or pull request creation jobs, or unrelated workflows.
|
|
17221
|
+
|
|
17222
|
+
---
|
|
17223
|
+
|
|
17168
17224
|
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowRunsOn"></a>
|
|
17169
17225
|
|
|
17170
17226
|
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
@@ -17319,6 +17375,8 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
17319
17375
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
17320
17376
|
| <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. |
|
|
17321
17377
|
| <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. |
|
|
17378
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
17379
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
17322
17380
|
| <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. |
|
|
17323
17381
|
| <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`). |
|
|
17324
17382
|
| <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. |
|
|
@@ -17397,6 +17455,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
|
|
|
17397
17455
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
17398
17456
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
17399
17457
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
17458
|
+
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
|
|
17400
17459
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
17401
17460
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
17402
17461
|
| <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
@@ -18805,7 +18864,8 @@ public readonly npmRegistryUrl: string;
|
|
|
18805
18864
|
|
|
18806
18865
|
The base URL of the npm package registry.
|
|
18807
18866
|
|
|
18808
|
-
Must be a URL (e.g. start with "https://" or "http://")
|
|
18867
|
+
Must be a URL (e.g. start with "https://" or "http://").
|
|
18868
|
+
A trailing slash is added if missing.
|
|
18809
18869
|
|
|
18810
18870
|
---
|
|
18811
18871
|
|
|
@@ -18835,6 +18895,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
18835
18895
|
|
|
18836
18896
|
---
|
|
18837
18897
|
|
|
18898
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmVerifyPublished"></a>
|
|
18899
|
+
|
|
18900
|
+
```typescript
|
|
18901
|
+
public readonly npmVerifyPublished: boolean;
|
|
18902
|
+
```
|
|
18903
|
+
|
|
18904
|
+
- *Type:* boolean
|
|
18905
|
+
- *Default:* false
|
|
18906
|
+
|
|
18907
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
18908
|
+
|
|
18909
|
+
Enable this when packages that depend on the published package are released right after.
|
|
18910
|
+
|
|
18911
|
+
---
|
|
18912
|
+
|
|
18913
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
18914
|
+
|
|
18915
|
+
```typescript
|
|
18916
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
18917
|
+
```
|
|
18918
|
+
|
|
18919
|
+
- *Type:* number
|
|
18920
|
+
- *Default:* 3600
|
|
18921
|
+
|
|
18922
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
18923
|
+
|
|
18924
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
18925
|
+
|
|
18926
|
+
---
|
|
18927
|
+
|
|
18838
18928
|
##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.outdir"></a>
|
|
18839
18929
|
|
|
18840
18930
|
```typescript
|
|
@@ -19919,6 +20009,28 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
19919
20009
|
|
|
19920
20010
|
---
|
|
19921
20011
|
|
|
20012
|
+
##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowPermissions"></a>
|
|
20013
|
+
|
|
20014
|
+
```typescript
|
|
20015
|
+
public readonly workflowPermissions: JobPermissions;
|
|
20016
|
+
```
|
|
20017
|
+
|
|
20018
|
+
- *Type:* projen.github.workflows.JobPermissions
|
|
20019
|
+
- *Default:* Use the job defaults and automatically inferred permissions.
|
|
20020
|
+
|
|
20021
|
+
Permissions for the main build, release and dependency upgrade jobs.
|
|
20022
|
+
|
|
20023
|
+
Defined scopes override the job defaults and automatically inferred permissions,
|
|
20024
|
+
including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
|
|
20025
|
+
Use `JobPermission.NONE` to explicitly remove a permission.
|
|
20026
|
+
|
|
20027
|
+
`buildWorkflowOptions.permissions` replaces this entire set, including automatic
|
|
20028
|
+
permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
|
|
20029
|
+
scopes. Applies to all release branches, but not to separate package, publishing,
|
|
20030
|
+
self-mutation or pull request creation jobs, or unrelated workflows.
|
|
20031
|
+
|
|
20032
|
+
---
|
|
20033
|
+
|
|
19922
20034
|
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOn"></a>
|
|
19923
20035
|
|
|
19924
20036
|
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
@@ -20082,6 +20194,8 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
20082
20194
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
20083
20195
|
| <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. |
|
|
20084
20196
|
| <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. |
|
|
20197
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
20198
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
20085
20199
|
| <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. |
|
|
20086
20200
|
| <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`). |
|
|
20087
20201
|
| <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. |
|
|
@@ -20162,6 +20276,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
|
|
|
20162
20276
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
20163
20277
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
|
|
20164
20278
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
20279
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
|
|
20165
20280
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
20166
20281
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
20167
20282
|
| <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
@@ -21723,7 +21838,8 @@ public readonly npmRegistryUrl: string;
|
|
|
21723
21838
|
|
|
21724
21839
|
The base URL of the npm package registry.
|
|
21725
21840
|
|
|
21726
|
-
Must be a URL (e.g. start with "https://" or "http://")
|
|
21841
|
+
Must be a URL (e.g. start with "https://" or "http://").
|
|
21842
|
+
A trailing slash is added if missing.
|
|
21727
21843
|
|
|
21728
21844
|
---
|
|
21729
21845
|
|
|
@@ -21753,6 +21869,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
21753
21869
|
|
|
21754
21870
|
---
|
|
21755
21871
|
|
|
21872
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmVerifyPublished"></a>
|
|
21873
|
+
|
|
21874
|
+
```typescript
|
|
21875
|
+
public readonly npmVerifyPublished: boolean;
|
|
21876
|
+
```
|
|
21877
|
+
|
|
21878
|
+
- *Type:* boolean
|
|
21879
|
+
- *Default:* false
|
|
21880
|
+
|
|
21881
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
21882
|
+
|
|
21883
|
+
Enable this when packages that depend on the published package are released right after.
|
|
21884
|
+
|
|
21885
|
+
---
|
|
21886
|
+
|
|
21887
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
21888
|
+
|
|
21889
|
+
```typescript
|
|
21890
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
21891
|
+
```
|
|
21892
|
+
|
|
21893
|
+
- *Type:* number
|
|
21894
|
+
- *Default:* 3600
|
|
21895
|
+
|
|
21896
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
21897
|
+
|
|
21898
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
21899
|
+
|
|
21900
|
+
---
|
|
21901
|
+
|
|
21756
21902
|
##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.outdir"></a>
|
|
21757
21903
|
|
|
21758
21904
|
```typescript
|
|
@@ -22860,6 +23006,28 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
22860
23006
|
|
|
22861
23007
|
---
|
|
22862
23008
|
|
|
23009
|
+
##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowPermissions"></a>
|
|
23010
|
+
|
|
23011
|
+
```typescript
|
|
23012
|
+
public readonly workflowPermissions: JobPermissions;
|
|
23013
|
+
```
|
|
23014
|
+
|
|
23015
|
+
- *Type:* projen.github.workflows.JobPermissions
|
|
23016
|
+
- *Default:* Use the job defaults and automatically inferred permissions.
|
|
23017
|
+
|
|
23018
|
+
Permissions for the main build, release and dependency upgrade jobs.
|
|
23019
|
+
|
|
23020
|
+
Defined scopes override the job defaults and automatically inferred permissions,
|
|
23021
|
+
including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
|
|
23022
|
+
Use `JobPermission.NONE` to explicitly remove a permission.
|
|
23023
|
+
|
|
23024
|
+
`buildWorkflowOptions.permissions` replaces this entire set, including automatic
|
|
23025
|
+
permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
|
|
23026
|
+
scopes. Applies to all release branches, but not to separate package, publishing,
|
|
23027
|
+
self-mutation or pull request creation jobs, or unrelated workflows.
|
|
23028
|
+
|
|
23029
|
+
---
|
|
23030
|
+
|
|
22863
23031
|
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOn"></a>
|
|
22864
23032
|
|
|
22865
23033
|
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
@@ -23051,6 +23219,8 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
23051
23219
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
23052
23220
|
| <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. |
|
|
23053
23221
|
| <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. |
|
|
23222
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
23223
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
23054
23224
|
| <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. |
|
|
23055
23225
|
| <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`). |
|
|
23056
23226
|
| <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. |
|
|
@@ -23129,6 +23299,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
|
|
|
23129
23299
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
23130
23300
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
23131
23301
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
23302
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
|
|
23132
23303
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
23133
23304
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
23134
23305
|
| <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
@@ -24539,7 +24710,8 @@ public readonly npmRegistryUrl: string;
|
|
|
24539
24710
|
|
|
24540
24711
|
The base URL of the npm package registry.
|
|
24541
24712
|
|
|
24542
|
-
Must be a URL (e.g. start with "https://" or "http://")
|
|
24713
|
+
Must be a URL (e.g. start with "https://" or "http://").
|
|
24714
|
+
A trailing slash is added if missing.
|
|
24543
24715
|
|
|
24544
24716
|
---
|
|
24545
24717
|
|
|
@@ -24569,6 +24741,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
24569
24741
|
|
|
24570
24742
|
---
|
|
24571
24743
|
|
|
24744
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmVerifyPublished"></a>
|
|
24745
|
+
|
|
24746
|
+
```typescript
|
|
24747
|
+
public readonly npmVerifyPublished: boolean;
|
|
24748
|
+
```
|
|
24749
|
+
|
|
24750
|
+
- *Type:* boolean
|
|
24751
|
+
- *Default:* false
|
|
24752
|
+
|
|
24753
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
24754
|
+
|
|
24755
|
+
Enable this when packages that depend on the published package are released right after.
|
|
24756
|
+
|
|
24757
|
+
---
|
|
24758
|
+
|
|
24759
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
24760
|
+
|
|
24761
|
+
```typescript
|
|
24762
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
24763
|
+
```
|
|
24764
|
+
|
|
24765
|
+
- *Type:* number
|
|
24766
|
+
- *Default:* 3600
|
|
24767
|
+
|
|
24768
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
24769
|
+
|
|
24770
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
24771
|
+
|
|
24772
|
+
---
|
|
24773
|
+
|
|
24572
24774
|
##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.outdir"></a>
|
|
24573
24775
|
|
|
24574
24776
|
```typescript
|
|
@@ -25653,6 +25855,28 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
25653
25855
|
|
|
25654
25856
|
---
|
|
25655
25857
|
|
|
25858
|
+
##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowPermissions"></a>
|
|
25859
|
+
|
|
25860
|
+
```typescript
|
|
25861
|
+
public readonly workflowPermissions: JobPermissions;
|
|
25862
|
+
```
|
|
25863
|
+
|
|
25864
|
+
- *Type:* projen.github.workflows.JobPermissions
|
|
25865
|
+
- *Default:* Use the job defaults and automatically inferred permissions.
|
|
25866
|
+
|
|
25867
|
+
Permissions for the main build, release and dependency upgrade jobs.
|
|
25868
|
+
|
|
25869
|
+
Defined scopes override the job defaults and automatically inferred permissions,
|
|
25870
|
+
including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
|
|
25871
|
+
Use `JobPermission.NONE` to explicitly remove a permission.
|
|
25872
|
+
|
|
25873
|
+
`buildWorkflowOptions.permissions` replaces this entire set, including automatic
|
|
25874
|
+
permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
|
|
25875
|
+
scopes. Applies to all release branches, but not to separate package, publishing,
|
|
25876
|
+
self-mutation or pull request creation jobs, or unrelated workflows.
|
|
25877
|
+
|
|
25878
|
+
---
|
|
25879
|
+
|
|
25656
25880
|
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOn"></a>
|
|
25657
25881
|
|
|
25658
25882
|
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
@@ -25836,6 +26060,8 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
25836
26060
|
| <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. |
|
|
25837
26061
|
| <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. |
|
|
25838
26062
|
| <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. |
|
|
26063
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
26064
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
25839
26065
|
| <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. |
|
|
25840
26066
|
| <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. |
|
|
25841
26067
|
| <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`). |
|
|
@@ -25904,6 +26130,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
|
|
|
25904
26130
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
25905
26131
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
|
|
25906
26132
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
26133
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
|
|
25907
26134
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
25908
26135
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
25909
26136
|
| <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.yarnBerry">yarnBerry</a></code> | <code>boolean</code> | Use Yarn Berry as the package manager. |
|
|
@@ -27165,7 +27392,8 @@ public readonly npmRegistryUrl: string;
|
|
|
27165
27392
|
|
|
27166
27393
|
The base URL of the npm package registry.
|
|
27167
27394
|
|
|
27168
|
-
Must be a URL (e.g. start with "https://" or "http://")
|
|
27395
|
+
Must be a URL (e.g. start with "https://" or "http://").
|
|
27396
|
+
A trailing slash is added if missing.
|
|
27169
27397
|
|
|
27170
27398
|
---
|
|
27171
27399
|
|
|
@@ -27195,6 +27423,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
27195
27423
|
|
|
27196
27424
|
---
|
|
27197
27425
|
|
|
27426
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmVerifyPublished"></a>
|
|
27427
|
+
|
|
27428
|
+
```typescript
|
|
27429
|
+
public readonly npmVerifyPublished: boolean;
|
|
27430
|
+
```
|
|
27431
|
+
|
|
27432
|
+
- *Type:* boolean
|
|
27433
|
+
- *Default:* false
|
|
27434
|
+
|
|
27435
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
27436
|
+
|
|
27437
|
+
Enable this when packages that depend on the published package are released right after.
|
|
27438
|
+
|
|
27439
|
+
---
|
|
27440
|
+
|
|
27441
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
27442
|
+
|
|
27443
|
+
```typescript
|
|
27444
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
27445
|
+
```
|
|
27446
|
+
|
|
27447
|
+
- *Type:* number
|
|
27448
|
+
- *Default:* 3600
|
|
27449
|
+
|
|
27450
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
27451
|
+
|
|
27452
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
27453
|
+
|
|
27454
|
+
---
|
|
27455
|
+
|
|
27198
27456
|
##### `nx`<sup>Optional</sup> <a name="nx" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.nx"></a>
|
|
27199
27457
|
|
|
27200
27458
|
```typescript
|
|
@@ -28146,6 +28404,28 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
28146
28404
|
|
|
28147
28405
|
---
|
|
28148
28406
|
|
|
28407
|
+
##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowPermissions"></a>
|
|
28408
|
+
|
|
28409
|
+
```typescript
|
|
28410
|
+
public readonly workflowPermissions: JobPermissions;
|
|
28411
|
+
```
|
|
28412
|
+
|
|
28413
|
+
- *Type:* projen.github.workflows.JobPermissions
|
|
28414
|
+
- *Default:* Use the job defaults and automatically inferred permissions.
|
|
28415
|
+
|
|
28416
|
+
Permissions for the main build, release and dependency upgrade jobs.
|
|
28417
|
+
|
|
28418
|
+
Defined scopes override the job defaults and automatically inferred permissions,
|
|
28419
|
+
including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
|
|
28420
|
+
Use `JobPermission.NONE` to explicitly remove a permission.
|
|
28421
|
+
|
|
28422
|
+
`buildWorkflowOptions.permissions` replaces this entire set, including automatic
|
|
28423
|
+
permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
|
|
28424
|
+
scopes. Applies to all release branches, but not to separate package, publishing,
|
|
28425
|
+
self-mutation or pull request creation jobs, or unrelated workflows.
|
|
28426
|
+
|
|
28427
|
+
---
|
|
28428
|
+
|
|
28149
28429
|
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOn"></a>
|
|
28150
28430
|
|
|
28151
28431
|
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
@@ -28336,6 +28616,8 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
28336
28616
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
28337
28617
|
| <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. |
|
|
28338
28618
|
| <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. |
|
|
28619
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
28620
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
28339
28621
|
| <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. |
|
|
28340
28622
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
28341
28623
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
@@ -28411,6 +28693,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
|
|
|
28411
28693
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
28412
28694
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
28413
28695
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
28696
|
+
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
|
|
28414
28697
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
28415
28698
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
|
|
28416
28699
|
| <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
@@ -29338,7 +29621,8 @@ public readonly npmRegistryUrl: string;
|
|
|
29338
29621
|
|
|
29339
29622
|
The base URL of the npm package registry.
|
|
29340
29623
|
|
|
29341
|
-
Must be a URL (e.g. start with "https://" or "http://")
|
|
29624
|
+
Must be a URL (e.g. start with "https://" or "http://").
|
|
29625
|
+
A trailing slash is added if missing.
|
|
29342
29626
|
|
|
29343
29627
|
---
|
|
29344
29628
|
|
|
@@ -29368,6 +29652,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
29368
29652
|
|
|
29369
29653
|
---
|
|
29370
29654
|
|
|
29655
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmVerifyPublished"></a>
|
|
29656
|
+
|
|
29657
|
+
```typescript
|
|
29658
|
+
public readonly npmVerifyPublished: boolean;
|
|
29659
|
+
```
|
|
29660
|
+
|
|
29661
|
+
- *Type:* boolean
|
|
29662
|
+
- *Default:* false
|
|
29663
|
+
|
|
29664
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
29665
|
+
|
|
29666
|
+
Enable this when packages that depend on the published package are released right after.
|
|
29667
|
+
|
|
29668
|
+
---
|
|
29669
|
+
|
|
29670
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
29671
|
+
|
|
29672
|
+
```typescript
|
|
29673
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
29674
|
+
```
|
|
29675
|
+
|
|
29676
|
+
- *Type:* number
|
|
29677
|
+
- *Default:* 3600
|
|
29678
|
+
|
|
29679
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
29680
|
+
|
|
29681
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
29682
|
+
|
|
29683
|
+
---
|
|
29684
|
+
|
|
29371
29685
|
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.packageManager"></a>
|
|
29372
29686
|
|
|
29373
29687
|
```typescript
|
|
@@ -30438,6 +30752,28 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
30438
30752
|
|
|
30439
30753
|
---
|
|
30440
30754
|
|
|
30755
|
+
##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowPermissions"></a>
|
|
30756
|
+
|
|
30757
|
+
```typescript
|
|
30758
|
+
public readonly workflowPermissions: JobPermissions;
|
|
30759
|
+
```
|
|
30760
|
+
|
|
30761
|
+
- *Type:* projen.github.workflows.JobPermissions
|
|
30762
|
+
- *Default:* Use the job defaults and automatically inferred permissions.
|
|
30763
|
+
|
|
30764
|
+
Permissions for the main build, release and dependency upgrade jobs.
|
|
30765
|
+
|
|
30766
|
+
Defined scopes override the job defaults and automatically inferred permissions,
|
|
30767
|
+
including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
|
|
30768
|
+
Use `JobPermission.NONE` to explicitly remove a permission.
|
|
30769
|
+
|
|
30770
|
+
`buildWorkflowOptions.permissions` replaces this entire set, including automatic
|
|
30771
|
+
permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
|
|
30772
|
+
scopes. Applies to all release branches, but not to separate package, publishing,
|
|
30773
|
+
self-mutation or pull request creation jobs, or unrelated workflows.
|
|
30774
|
+
|
|
30775
|
+
---
|
|
30776
|
+
|
|
30441
30777
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.disableTsconfig"></a>
|
|
30442
30778
|
|
|
30443
30779
|
```typescript
|
|
@@ -30901,6 +31237,8 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
30901
31237
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
30902
31238
|
| <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. |
|
|
30903
31239
|
| <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. |
|
|
31240
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
31241
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
30904
31242
|
| <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. |
|
|
30905
31243
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
30906
31244
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
@@ -30976,6 +31314,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
|
|
|
30976
31314
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
30977
31315
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
30978
31316
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
31317
|
+
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
|
|
30979
31318
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
30980
31319
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
|
|
30981
31320
|
| <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
@@ -31903,7 +32242,8 @@ public readonly npmRegistryUrl: string;
|
|
|
31903
32242
|
|
|
31904
32243
|
The base URL of the npm package registry.
|
|
31905
32244
|
|
|
31906
|
-
Must be a URL (e.g. start with "https://" or "http://")
|
|
32245
|
+
Must be a URL (e.g. start with "https://" or "http://").
|
|
32246
|
+
A trailing slash is added if missing.
|
|
31907
32247
|
|
|
31908
32248
|
---
|
|
31909
32249
|
|
|
@@ -31933,6 +32273,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
31933
32273
|
|
|
31934
32274
|
---
|
|
31935
32275
|
|
|
32276
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmVerifyPublished"></a>
|
|
32277
|
+
|
|
32278
|
+
```typescript
|
|
32279
|
+
public readonly npmVerifyPublished: boolean;
|
|
32280
|
+
```
|
|
32281
|
+
|
|
32282
|
+
- *Type:* boolean
|
|
32283
|
+
- *Default:* false
|
|
32284
|
+
|
|
32285
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
32286
|
+
|
|
32287
|
+
Enable this when packages that depend on the published package are released right after.
|
|
32288
|
+
|
|
32289
|
+
---
|
|
32290
|
+
|
|
32291
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
32292
|
+
|
|
32293
|
+
```typescript
|
|
32294
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
32295
|
+
```
|
|
32296
|
+
|
|
32297
|
+
- *Type:* number
|
|
32298
|
+
- *Default:* 3600
|
|
32299
|
+
|
|
32300
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
32301
|
+
|
|
32302
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
32303
|
+
|
|
32304
|
+
---
|
|
32305
|
+
|
|
31936
32306
|
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.packageManager"></a>
|
|
31937
32307
|
|
|
31938
32308
|
```typescript
|
|
@@ -33003,6 +33373,28 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
33003
33373
|
|
|
33004
33374
|
---
|
|
33005
33375
|
|
|
33376
|
+
##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowPermissions"></a>
|
|
33377
|
+
|
|
33378
|
+
```typescript
|
|
33379
|
+
public readonly workflowPermissions: JobPermissions;
|
|
33380
|
+
```
|
|
33381
|
+
|
|
33382
|
+
- *Type:* projen.github.workflows.JobPermissions
|
|
33383
|
+
- *Default:* Use the job defaults and automatically inferred permissions.
|
|
33384
|
+
|
|
33385
|
+
Permissions for the main build, release and dependency upgrade jobs.
|
|
33386
|
+
|
|
33387
|
+
Defined scopes override the job defaults and automatically inferred permissions,
|
|
33388
|
+
including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
|
|
33389
|
+
Use `JobPermission.NONE` to explicitly remove a permission.
|
|
33390
|
+
|
|
33391
|
+
`buildWorkflowOptions.permissions` replaces this entire set, including automatic
|
|
33392
|
+
permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
|
|
33393
|
+
scopes. Applies to all release branches, but not to separate package, publishing,
|
|
33394
|
+
self-mutation or pull request creation jobs, or unrelated workflows.
|
|
33395
|
+
|
|
33396
|
+
---
|
|
33397
|
+
|
|
33006
33398
|
##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.disableTsconfig"></a>
|
|
33007
33399
|
|
|
33008
33400
|
```typescript
|
|
@@ -33451,6 +33843,8 @@ const jsiiBuildOptions: yarn.JsiiBuildOptions = { ... }
|
|
|
33451
33843
|
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
|
|
33452
33844
|
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.jsiiVersion">jsiiVersion</a></code> | <code>string</code> | Version of the jsii compiler to use. |
|
|
33453
33845
|
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Whether to use trusted publishing for npm. |
|
|
33846
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
33847
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
33454
33848
|
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
|
|
33455
33849
|
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
|
|
33456
33850
|
| <code><a href="#cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
|
|
@@ -33597,6 +33991,34 @@ Whether to use trusted publishing for npm.
|
|
|
33597
33991
|
|
|
33598
33992
|
---
|
|
33599
33993
|
|
|
33994
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.npmVerifyPublished"></a>
|
|
33995
|
+
|
|
33996
|
+
```typescript
|
|
33997
|
+
public readonly npmVerifyPublished: boolean;
|
|
33998
|
+
```
|
|
33999
|
+
|
|
34000
|
+
- *Type:* boolean
|
|
34001
|
+
- *Default:* false
|
|
34002
|
+
|
|
34003
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
34004
|
+
|
|
34005
|
+
---
|
|
34006
|
+
|
|
34007
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
34008
|
+
|
|
34009
|
+
```typescript
|
|
34010
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
34011
|
+
```
|
|
34012
|
+
|
|
34013
|
+
- *Type:* number
|
|
34014
|
+
- *Default:* 3600
|
|
34015
|
+
|
|
34016
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
34017
|
+
|
|
34018
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
34019
|
+
|
|
34020
|
+
---
|
|
34021
|
+
|
|
33600
34022
|
##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToGo"></a>
|
|
33601
34023
|
|
|
33602
34024
|
```typescript
|
|
@@ -33855,6 +34277,8 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
33855
34277
|
| <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. |
|
|
33856
34278
|
| <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. |
|
|
33857
34279
|
| <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. |
|
|
34280
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
34281
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
33858
34282
|
| <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. |
|
|
33859
34283
|
| <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. |
|
|
33860
34284
|
| <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`). |
|
|
@@ -33923,6 +34347,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
|
|
|
33923
34347
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
33924
34348
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
|
|
33925
34349
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
34350
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
|
|
33926
34351
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
33927
34352
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
33928
34353
|
| <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.yarnBerry">yarnBerry</a></code> | <code>boolean</code> | Use Yarn Berry as the package manager. |
|
|
@@ -35184,7 +35609,8 @@ public readonly npmRegistryUrl: string;
|
|
|
35184
35609
|
|
|
35185
35610
|
The base URL of the npm package registry.
|
|
35186
35611
|
|
|
35187
|
-
Must be a URL (e.g. start with "https://" or "http://")
|
|
35612
|
+
Must be a URL (e.g. start with "https://" or "http://").
|
|
35613
|
+
A trailing slash is added if missing.
|
|
35188
35614
|
|
|
35189
35615
|
---
|
|
35190
35616
|
|
|
@@ -35214,6 +35640,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
35214
35640
|
|
|
35215
35641
|
---
|
|
35216
35642
|
|
|
35643
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmVerifyPublished"></a>
|
|
35644
|
+
|
|
35645
|
+
```typescript
|
|
35646
|
+
public readonly npmVerifyPublished: boolean;
|
|
35647
|
+
```
|
|
35648
|
+
|
|
35649
|
+
- *Type:* boolean
|
|
35650
|
+
- *Default:* false
|
|
35651
|
+
|
|
35652
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
35653
|
+
|
|
35654
|
+
Enable this when packages that depend on the published package are released right after.
|
|
35655
|
+
|
|
35656
|
+
---
|
|
35657
|
+
|
|
35658
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
35659
|
+
|
|
35660
|
+
```typescript
|
|
35661
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
35662
|
+
```
|
|
35663
|
+
|
|
35664
|
+
- *Type:* number
|
|
35665
|
+
- *Default:* 3600
|
|
35666
|
+
|
|
35667
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
35668
|
+
|
|
35669
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
35670
|
+
|
|
35671
|
+
---
|
|
35672
|
+
|
|
35217
35673
|
##### `nx`<sup>Optional</sup> <a name="nx" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.nx"></a>
|
|
35218
35674
|
|
|
35219
35675
|
```typescript
|
|
@@ -36165,6 +36621,28 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
36165
36621
|
|
|
36166
36622
|
---
|
|
36167
36623
|
|
|
36624
|
+
##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowPermissions"></a>
|
|
36625
|
+
|
|
36626
|
+
```typescript
|
|
36627
|
+
public readonly workflowPermissions: JobPermissions;
|
|
36628
|
+
```
|
|
36629
|
+
|
|
36630
|
+
- *Type:* projen.github.workflows.JobPermissions
|
|
36631
|
+
- *Default:* Use the job defaults and automatically inferred permissions.
|
|
36632
|
+
|
|
36633
|
+
Permissions for the main build, release and dependency upgrade jobs.
|
|
36634
|
+
|
|
36635
|
+
Defined scopes override the job defaults and automatically inferred permissions,
|
|
36636
|
+
including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
|
|
36637
|
+
Use `JobPermission.NONE` to explicitly remove a permission.
|
|
36638
|
+
|
|
36639
|
+
`buildWorkflowOptions.permissions` replaces this entire set, including automatic
|
|
36640
|
+
permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
|
|
36641
|
+
scopes. Applies to all release branches, but not to separate package, publishing,
|
|
36642
|
+
self-mutation or pull request creation jobs, or unrelated workflows.
|
|
36643
|
+
|
|
36644
|
+
---
|
|
36645
|
+
|
|
36168
36646
|
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOn"></a>
|
|
36169
36647
|
|
|
36170
36648
|
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
@@ -36811,6 +37289,8 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
36811
37289
|
| <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. |
|
|
36812
37290
|
| <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. |
|
|
36813
37291
|
| <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. |
|
|
37292
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
37293
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
36814
37294
|
| <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`). |
|
|
36815
37295
|
| <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. |
|
|
36816
37296
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
@@ -36874,6 +37354,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
|
|
|
36874
37354
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
36875
37355
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
|
|
36876
37356
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
37357
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowPermissions">workflowPermissions</a></code> | <code>projen.github.workflows.JobPermissions</code> | Permissions for the main build, release and dependency upgrade jobs. |
|
|
36877
37358
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
36878
37359
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
36879
37360
|
| <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workspaceScope">workspaceScope</a></code> | <code>string</code> | The workspace scope the package is located in. |
|
|
@@ -38129,7 +38610,8 @@ public readonly npmRegistryUrl: string;
|
|
|
38129
38610
|
|
|
38130
38611
|
The base URL of the npm package registry.
|
|
38131
38612
|
|
|
38132
|
-
Must be a URL (e.g. start with "https://" or "http://")
|
|
38613
|
+
Must be a URL (e.g. start with "https://" or "http://").
|
|
38614
|
+
A trailing slash is added if missing.
|
|
38133
38615
|
|
|
38134
38616
|
---
|
|
38135
38617
|
|
|
@@ -38159,6 +38641,36 @@ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on
|
|
|
38159
38641
|
|
|
38160
38642
|
---
|
|
38161
38643
|
|
|
38644
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmVerifyPublished"></a>
|
|
38645
|
+
|
|
38646
|
+
```typescript
|
|
38647
|
+
public readonly npmVerifyPublished: boolean;
|
|
38648
|
+
```
|
|
38649
|
+
|
|
38650
|
+
- *Type:* boolean
|
|
38651
|
+
- *Default:* false
|
|
38652
|
+
|
|
38653
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
38654
|
+
|
|
38655
|
+
Enable this when packages that depend on the published package are released right after.
|
|
38656
|
+
|
|
38657
|
+
---
|
|
38658
|
+
|
|
38659
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
38660
|
+
|
|
38661
|
+
```typescript
|
|
38662
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
38663
|
+
```
|
|
38664
|
+
|
|
38665
|
+
- *Type:* number
|
|
38666
|
+
- *Default:* 3600
|
|
38667
|
+
|
|
38668
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
38669
|
+
|
|
38670
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
38671
|
+
|
|
38672
|
+
---
|
|
38673
|
+
|
|
38162
38674
|
##### `package`<sup>Optional</sup> <a name="package" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.package"></a>
|
|
38163
38675
|
|
|
38164
38676
|
```typescript
|
|
@@ -39044,6 +39556,28 @@ Enable Node.js package cache in GitHub workflows.
|
|
|
39044
39556
|
|
|
39045
39557
|
---
|
|
39046
39558
|
|
|
39559
|
+
##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowPermissions"></a>
|
|
39560
|
+
|
|
39561
|
+
```typescript
|
|
39562
|
+
public readonly workflowPermissions: JobPermissions;
|
|
39563
|
+
```
|
|
39564
|
+
|
|
39565
|
+
- *Type:* projen.github.workflows.JobPermissions
|
|
39566
|
+
- *Default:* Use the job defaults and automatically inferred permissions.
|
|
39567
|
+
|
|
39568
|
+
Permissions for the main build, release and dependency upgrade jobs.
|
|
39569
|
+
|
|
39570
|
+
Defined scopes override the job defaults and automatically inferred permissions,
|
|
39571
|
+
including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
|
|
39572
|
+
Use `JobPermission.NONE` to explicitly remove a permission.
|
|
39573
|
+
|
|
39574
|
+
`buildWorkflowOptions.permissions` replaces this entire set, including automatic
|
|
39575
|
+
permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
|
|
39576
|
+
scopes. Applies to all release branches, but not to separate package, publishing,
|
|
39577
|
+
self-mutation or pull request creation jobs, or unrelated workflows.
|
|
39578
|
+
|
|
39579
|
+
---
|
|
39580
|
+
|
|
39047
39581
|
##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOn"></a>
|
|
39048
39582
|
|
|
39049
39583
|
- *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
|
|
@@ -39171,6 +39705,8 @@ const workspaceJsiiBuildOptions: yarn.WorkspaceJsiiBuildOptions = { ... }
|
|
|
39171
39705
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
|
|
39172
39706
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.jsiiVersion">jsiiVersion</a></code> | <code>string</code> | Version of the jsii compiler to use. |
|
|
39173
39707
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | Whether to use trusted publishing for npm. |
|
|
39708
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | Wait until the published package version is available from the npm registry before the publish job completes. |
|
|
39709
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | How long to wait, in seconds, for the published package version to be available. |
|
|
39174
39710
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
|
|
39175
39711
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
|
|
39176
39712
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
|
|
@@ -39321,6 +39857,34 @@ Whether to use trusted publishing for npm.
|
|
|
39321
39857
|
|
|
39322
39858
|
---
|
|
39323
39859
|
|
|
39860
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.npmVerifyPublished"></a>
|
|
39861
|
+
|
|
39862
|
+
```typescript
|
|
39863
|
+
public readonly npmVerifyPublished: boolean;
|
|
39864
|
+
```
|
|
39865
|
+
|
|
39866
|
+
- *Type:* boolean
|
|
39867
|
+
- *Default:* false
|
|
39868
|
+
|
|
39869
|
+
Wait until the published package version is available from the npm registry before the publish job completes.
|
|
39870
|
+
|
|
39871
|
+
---
|
|
39872
|
+
|
|
39873
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
39874
|
+
|
|
39875
|
+
```typescript
|
|
39876
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
39877
|
+
```
|
|
39878
|
+
|
|
39879
|
+
- *Type:* number
|
|
39880
|
+
- *Default:* 3600
|
|
39881
|
+
|
|
39882
|
+
How long to wait, in seconds, for the published package version to be available.
|
|
39883
|
+
|
|
39884
|
+
Requires `npmVerifyPublished` to be enabled.
|
|
39885
|
+
|
|
39886
|
+
---
|
|
39887
|
+
|
|
39324
39888
|
##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToGo"></a>
|
|
39325
39889
|
|
|
39326
39890
|
```typescript
|
|
@@ -39551,6 +40115,8 @@ const workspaceReleaseOptions: yarn.WorkspaceReleaseOptions = { ... }
|
|
|
39551
40115
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.nextVersionCommand">nextVersionCommand</a></code> | <code>string</code> | *No description.* |
|
|
39552
40116
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.npmDistTag">npmDistTag</a></code> | <code>string</code> | *No description.* |
|
|
39553
40117
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.npmTrustedPublishing">npmTrustedPublishing</a></code> | <code>boolean</code> | *No description.* |
|
|
40118
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.npmVerifyPublished">npmVerifyPublished</a></code> | <code>boolean</code> | *No description.* |
|
|
40119
|
+
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.npmVerifyPublishedTimeoutSeconds">npmVerifyPublishedTimeoutSeconds</a></code> | <code>number</code> | *No description.* |
|
|
39554
40120
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.publishToNpm">publishToNpm</a></code> | <code>boolean</code> | *No description.* |
|
|
39555
40121
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | *No description.* |
|
|
39556
40122
|
| <code><a href="#cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.repoRuntimeDependencies">repoRuntimeDependencies</a></code> | <code>{[ key: string ]: string}</code> | For runtime and peer dependencies, the type of dependency we take on each package. |
|
|
@@ -39618,6 +40184,26 @@ public readonly npmTrustedPublishing: boolean;
|
|
|
39618
40184
|
|
|
39619
40185
|
---
|
|
39620
40186
|
|
|
40187
|
+
##### `npmVerifyPublished`<sup>Optional</sup> <a name="npmVerifyPublished" id="cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.npmVerifyPublished"></a>
|
|
40188
|
+
|
|
40189
|
+
```typescript
|
|
40190
|
+
public readonly npmVerifyPublished: boolean;
|
|
40191
|
+
```
|
|
40192
|
+
|
|
40193
|
+
- *Type:* boolean
|
|
40194
|
+
|
|
40195
|
+
---
|
|
40196
|
+
|
|
40197
|
+
##### `npmVerifyPublishedTimeoutSeconds`<sup>Optional</sup> <a name="npmVerifyPublishedTimeoutSeconds" id="cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.npmVerifyPublishedTimeoutSeconds"></a>
|
|
40198
|
+
|
|
40199
|
+
```typescript
|
|
40200
|
+
public readonly npmVerifyPublishedTimeoutSeconds: number;
|
|
40201
|
+
```
|
|
40202
|
+
|
|
40203
|
+
- *Type:* number
|
|
40204
|
+
|
|
40205
|
+
---
|
|
40206
|
+
|
|
39621
40207
|
##### `publishToNpm`<sup>Optional</sup> <a name="publishToNpm" id="cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions.property.publishToNpm"></a>
|
|
39622
40208
|
|
|
39623
40209
|
```typescript
|