cdklabs-projen-project-types 0.6.20 → 0.6.22

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.
Binary file
package/API.md CHANGED
@@ -14471,6 +14471,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14471
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. |
14472
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. |
14473
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. |
14474
14475
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
14475
14476
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
14476
14477
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
@@ -16479,6 +16480,9 @@ public readonly publishToGo: JsiiGoTarget;
16479
16480
 
16480
16481
  Publish Go bindings to a git repository.
16481
16482
 
16483
+ A separate repository is recommended. If `moduleName` refers to the source
16484
+ repository, set `publishToSourceRepository` to `true`.
16485
+
16482
16486
  ---
16483
16487
 
16484
16488
  ##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.publishToMaven"></a>
@@ -17198,6 +17202,28 @@ Enable Node.js package cache in GitHub workflows.
17198
17202
 
17199
17203
  ---
17200
17204
 
17205
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowPermissions"></a>
17206
+
17207
+ ```typescript
17208
+ public readonly workflowPermissions: JobPermissions;
17209
+ ```
17210
+
17211
+ - *Type:* projen.github.workflows.JobPermissions
17212
+ - *Default:* Use the job defaults and automatically inferred permissions.
17213
+
17214
+ Permissions for the main build, release and dependency upgrade jobs.
17215
+
17216
+ Defined scopes override the job defaults and automatically inferred permissions,
17217
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
17218
+ Use `JobPermission.NONE` to explicitly remove a permission.
17219
+
17220
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
17221
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
17222
+ scopes. Applies to all release branches, but not to separate package, publishing,
17223
+ self-mutation or pull request creation jobs, or unrelated workflows.
17224
+
17225
+ ---
17226
+
17201
17227
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowRunsOn"></a>
17202
17228
 
17203
17229
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -17432,6 +17458,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17432
17458
  | <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. |
17433
17459
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
17434
17460
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
17461
+ | <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. |
17435
17462
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
17436
17463
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
17437
17464
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
@@ -19289,6 +19316,9 @@ public readonly publishToGo: JsiiGoTarget;
19289
19316
 
19290
19317
  Publish Go bindings to a git repository.
19291
19318
 
19319
+ A separate repository is recommended. If `moduleName` refers to the source
19320
+ repository, set `publishToSourceRepository` to `true`.
19321
+
19292
19322
  ---
19293
19323
 
19294
19324
  ##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.publishToMaven"></a>
@@ -19985,6 +20015,28 @@ Enable Node.js package cache in GitHub workflows.
19985
20015
 
19986
20016
  ---
19987
20017
 
20018
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowPermissions"></a>
20019
+
20020
+ ```typescript
20021
+ public readonly workflowPermissions: JobPermissions;
20022
+ ```
20023
+
20024
+ - *Type:* projen.github.workflows.JobPermissions
20025
+ - *Default:* Use the job defaults and automatically inferred permissions.
20026
+
20027
+ Permissions for the main build, release and dependency upgrade jobs.
20028
+
20029
+ Defined scopes override the job defaults and automatically inferred permissions,
20030
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
20031
+ Use `JobPermission.NONE` to explicitly remove a permission.
20032
+
20033
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
20034
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
20035
+ scopes. Applies to all release branches, but not to separate package, publishing,
20036
+ self-mutation or pull request creation jobs, or unrelated workflows.
20037
+
20038
+ ---
20039
+
19988
20040
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOn"></a>
19989
20041
 
19990
20042
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -20230,6 +20282,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
20230
20282
  | <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. |
20231
20283
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version to use in GitHub workflows. |
20232
20284
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
20285
+ | <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. |
20233
20286
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
20234
20287
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
20235
20288
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
@@ -22240,6 +22293,9 @@ public readonly publishToGo: JsiiGoTarget;
22240
22293
 
22241
22294
  Publish Go bindings to a git repository.
22242
22295
 
22296
+ A separate repository is recommended. If `moduleName` refers to the source
22297
+ repository, set `publishToSourceRepository` to `true`.
22298
+
22243
22299
  ---
22244
22300
 
22245
22301
  ##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.publishToMaven"></a>
@@ -22959,6 +23015,28 @@ Enable Node.js package cache in GitHub workflows.
22959
23015
 
22960
23016
  ---
22961
23017
 
23018
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowPermissions"></a>
23019
+
23020
+ ```typescript
23021
+ public readonly workflowPermissions: JobPermissions;
23022
+ ```
23023
+
23024
+ - *Type:* projen.github.workflows.JobPermissions
23025
+ - *Default:* Use the job defaults and automatically inferred permissions.
23026
+
23027
+ Permissions for the main build, release and dependency upgrade jobs.
23028
+
23029
+ Defined scopes override the job defaults and automatically inferred permissions,
23030
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
23031
+ Use `JobPermission.NONE` to explicitly remove a permission.
23032
+
23033
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
23034
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
23035
+ scopes. Applies to all release branches, but not to separate package, publishing,
23036
+ self-mutation or pull request creation jobs, or unrelated workflows.
23037
+
23038
+ ---
23039
+
22962
23040
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOn"></a>
22963
23041
 
22964
23042
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -23230,6 +23308,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
23230
23308
  | <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. |
23231
23309
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
23232
23310
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
23311
+ | <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. |
23233
23312
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
23234
23313
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
23235
23314
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
@@ -25089,6 +25168,9 @@ public readonly publishToGo: JsiiGoTarget;
25089
25168
 
25090
25169
  Publish Go bindings to a git repository.
25091
25170
 
25171
+ A separate repository is recommended. If `moduleName` refers to the source
25172
+ repository, set `publishToSourceRepository` to `true`.
25173
+
25092
25174
  ---
25093
25175
 
25094
25176
  ##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.publishToMaven"></a>
@@ -25785,6 +25867,28 @@ Enable Node.js package cache in GitHub workflows.
25785
25867
 
25786
25868
  ---
25787
25869
 
25870
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowPermissions"></a>
25871
+
25872
+ ```typescript
25873
+ public readonly workflowPermissions: JobPermissions;
25874
+ ```
25875
+
25876
+ - *Type:* projen.github.workflows.JobPermissions
25877
+ - *Default:* Use the job defaults and automatically inferred permissions.
25878
+
25879
+ Permissions for the main build, release and dependency upgrade jobs.
25880
+
25881
+ Defined scopes override the job defaults and automatically inferred permissions,
25882
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
25883
+ Use `JobPermission.NONE` to explicitly remove a permission.
25884
+
25885
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
25886
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
25887
+ scopes. Applies to all release branches, but not to separate package, publishing,
25888
+ self-mutation or pull request creation jobs, or unrelated workflows.
25889
+
25890
+ ---
25891
+
25788
25892
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOn"></a>
25789
25893
 
25790
25894
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -26038,6 +26142,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
26038
26142
  | <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. |
26039
26143
  | <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. |
26040
26144
  | <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. |
26145
+ | <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. |
26041
26146
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
26042
26147
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
26043
26148
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.yarnBerry">yarnBerry</a></code> | <code>boolean</code> | Use Yarn Berry as the package manager. |
@@ -28311,6 +28416,28 @@ Enable Node.js package cache in GitHub workflows.
28311
28416
 
28312
28417
  ---
28313
28418
 
28419
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowPermissions"></a>
28420
+
28421
+ ```typescript
28422
+ public readonly workflowPermissions: JobPermissions;
28423
+ ```
28424
+
28425
+ - *Type:* projen.github.workflows.JobPermissions
28426
+ - *Default:* Use the job defaults and automatically inferred permissions.
28427
+
28428
+ Permissions for the main build, release and dependency upgrade jobs.
28429
+
28430
+ Defined scopes override the job defaults and automatically inferred permissions,
28431
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
28432
+ Use `JobPermission.NONE` to explicitly remove a permission.
28433
+
28434
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
28435
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
28436
+ scopes. Applies to all release branches, but not to separate package, publishing,
28437
+ self-mutation or pull request creation jobs, or unrelated workflows.
28438
+
28439
+ ---
28440
+
28314
28441
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOn"></a>
28315
28442
 
28316
28443
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -28578,6 +28705,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
28578
28705
  | <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. |
28579
28706
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
28580
28707
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
28708
+ | <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. |
28581
28709
  | <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). |
28582
28710
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
28583
28711
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -30636,6 +30764,28 @@ Enable Node.js package cache in GitHub workflows.
30636
30764
 
30637
30765
  ---
30638
30766
 
30767
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.workflowPermissions"></a>
30768
+
30769
+ ```typescript
30770
+ public readonly workflowPermissions: JobPermissions;
30771
+ ```
30772
+
30773
+ - *Type:* projen.github.workflows.JobPermissions
30774
+ - *Default:* Use the job defaults and automatically inferred permissions.
30775
+
30776
+ Permissions for the main build, release and dependency upgrade jobs.
30777
+
30778
+ Defined scopes override the job defaults and automatically inferred permissions,
30779
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
30780
+ Use `JobPermission.NONE` to explicitly remove a permission.
30781
+
30782
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
30783
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
30784
+ scopes. Applies to all release branches, but not to separate package, publishing,
30785
+ self-mutation or pull request creation jobs, or unrelated workflows.
30786
+
30787
+ ---
30788
+
30639
30789
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.disableTsconfig"></a>
30640
30790
 
30641
30791
  ```typescript
@@ -31176,6 +31326,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
31176
31326
  | <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. |
31177
31327
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
31178
31328
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
31329
+ | <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. |
31179
31330
  | <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). |
31180
31331
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
31181
31332
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -33234,6 +33385,28 @@ Enable Node.js package cache in GitHub workflows.
33234
33385
 
33235
33386
  ---
33236
33387
 
33388
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.workflowPermissions"></a>
33389
+
33390
+ ```typescript
33391
+ public readonly workflowPermissions: JobPermissions;
33392
+ ```
33393
+
33394
+ - *Type:* projen.github.workflows.JobPermissions
33395
+ - *Default:* Use the job defaults and automatically inferred permissions.
33396
+
33397
+ Permissions for the main build, release and dependency upgrade jobs.
33398
+
33399
+ Defined scopes override the job defaults and automatically inferred permissions,
33400
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
33401
+ Use `JobPermission.NONE` to explicitly remove a permission.
33402
+
33403
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
33404
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
33405
+ scopes. Applies to all release branches, but not to separate package, publishing,
33406
+ self-mutation or pull request creation jobs, or unrelated workflows.
33407
+
33408
+ ---
33409
+
33237
33410
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.disableTsconfig"></a>
33238
33411
 
33239
33412
  ```typescript
@@ -33869,6 +34042,9 @@ public readonly publishToGo: JsiiGoTarget;
33869
34042
 
33870
34043
  Publish Go bindings to a git repository.
33871
34044
 
34045
+ A separate repository is recommended. If `moduleName` refers to the source
34046
+ repository, set `publishToSourceRepository` to `true`.
34047
+
33872
34048
  ---
33873
34049
 
33874
34050
  ##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="cdklabs-projen-project-types.yarn.JsiiBuildOptions.property.publishToMaven"></a>
@@ -34186,6 +34362,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
34186
34362
  | <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. |
34187
34363
  | <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. |
34188
34364
  | <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. |
34365
+ | <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. |
34189
34366
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
34190
34367
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
34191
34368
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.yarnBerry">yarnBerry</a></code> | <code>boolean</code> | Use Yarn Berry as the package manager. |
@@ -36459,6 +36636,28 @@ Enable Node.js package cache in GitHub workflows.
36459
36636
 
36460
36637
  ---
36461
36638
 
36639
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowPermissions"></a>
36640
+
36641
+ ```typescript
36642
+ public readonly workflowPermissions: JobPermissions;
36643
+ ```
36644
+
36645
+ - *Type:* projen.github.workflows.JobPermissions
36646
+ - *Default:* Use the job defaults and automatically inferred permissions.
36647
+
36648
+ Permissions for the main build, release and dependency upgrade jobs.
36649
+
36650
+ Defined scopes override the job defaults and automatically inferred permissions,
36651
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
36652
+ Use `JobPermission.NONE` to explicitly remove a permission.
36653
+
36654
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
36655
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
36656
+ scopes. Applies to all release branches, but not to separate package, publishing,
36657
+ self-mutation or pull request creation jobs, or unrelated workflows.
36658
+
36659
+ ---
36660
+
36462
36661
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOn"></a>
36463
36662
 
36464
36663
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -37170,6 +37369,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
37170
37369
  | <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. |
37171
37370
  | <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. |
37172
37371
  | <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. |
37372
+ | <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. |
37173
37373
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
37174
37374
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
37175
37375
  | <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. |
@@ -39371,6 +39571,28 @@ Enable Node.js package cache in GitHub workflows.
39371
39571
 
39372
39572
  ---
39373
39573
 
39574
+ ##### `workflowPermissions`<sup>Optional</sup> <a name="workflowPermissions" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowPermissions"></a>
39575
+
39576
+ ```typescript
39577
+ public readonly workflowPermissions: JobPermissions;
39578
+ ```
39579
+
39580
+ - *Type:* projen.github.workflows.JobPermissions
39581
+ - *Default:* Use the job defaults and automatically inferred permissions.
39582
+
39583
+ Permissions for the main build, release and dependency upgrade jobs.
39584
+
39585
+ Defined scopes override the job defaults and automatically inferred permissions,
39586
+ including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
39587
+ Use `JobPermission.NONE` to explicitly remove a permission.
39588
+
39589
+ `buildWorkflowOptions.permissions` replaces this entire set, including automatic
39590
+ permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
39591
+ scopes. Applies to all release branches, but not to separate package, publishing,
39592
+ self-mutation or pull request creation jobs, or unrelated workflows.
39593
+
39594
+ ---
39595
+
39374
39596
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOn"></a>
39375
39597
 
39376
39598
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -39689,6 +39911,9 @@ public readonly publishToGo: JsiiGoTarget;
39689
39911
 
39690
39912
  Publish Go bindings to a git repository.
39691
39913
 
39914
+ A separate repository is recommended. If `moduleName` refers to the source
39915
+ repository, set `publishToSourceRepository` to `true`.
39916
+
39692
39917
  ---
39693
39918
 
39694
39919
  ##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="cdklabs-projen-project-types.yarn.WorkspaceJsiiBuildOptions.property.publishToMaven"></a>
@@ -875,6 +875,8 @@ export interface CdkConstructLibraryOptions {
875
875
  readonly publishTasks?: boolean;
876
876
  /**
877
877
  * Publish Go bindings to a git repository.
878
+ * A separate repository is recommended. If `moduleName` refers to the source
879
+ * repository, set `publishToSourceRepository` to `true`.
878
880
  * @default - no publishing
879
881
  */
880
882
  readonly publishToGo?: cdk.JsiiGoTarget;
@@ -1167,6 +1169,19 @@ export interface CdkConstructLibraryOptions {
1167
1169
  * @default false
1168
1170
  */
1169
1171
  readonly workflowPackageCache?: boolean;
1172
+ /**
1173
+ * Permissions for the main build, release and dependency upgrade jobs.
1174
+ * Defined scopes override the job defaults and automatically inferred permissions,
1175
+ * including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
1176
+ * Use `JobPermission.NONE` to explicitly remove a permission.
1177
+ *
1178
+ * `buildWorkflowOptions.permissions` replaces this entire set, including automatic
1179
+ * permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
1180
+ * scopes. Applies to all release branches, but not to separate package, publishing,
1181
+ * self-mutation or pull request creation jobs, or unrelated workflows.
1182
+ * @default - Use the job defaults and automatically inferred permissions.
1183
+ */
1184
+ readonly workflowPermissions?: github.workflows.JobPermissions;
1170
1185
  /**
1171
1186
  * Github Runner selection labels.
1172
1187
  * @default ["ubuntu-latest"]