cdklabs-projen-project-types 0.6.20 → 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 CHANGED
@@ -3877,6 +3877,25 @@
3877
3877
  "primitive": "boolean"
3878
3878
  }
3879
3879
  },
3880
+ {
3881
+ "abstract": true,
3882
+ "docs": {
3883
+ "default": "- Use the job defaults and automatically inferred permissions.",
3884
+ "remarks": "Defined scopes override the job defaults and automatically inferred permissions,\nincluding CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.\nUse `JobPermission.NONE` to explicitly remove a permission.\n\n`buildWorkflowOptions.permissions` replaces this entire set, including automatic\npermissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual\nscopes. Applies to all release branches, but not to separate package, publishing,\nself-mutation or pull request creation jobs, or unrelated workflows.",
3885
+ "stability": "stable",
3886
+ "summary": "Permissions for the main build, release and dependency upgrade jobs."
3887
+ },
3888
+ "immutable": true,
3889
+ "locationInModule": {
3890
+ "filename": "src/cdk-construct-library-options.ts",
3891
+ "line": 1184
3892
+ },
3893
+ "name": "workflowPermissions",
3894
+ "optional": true,
3895
+ "type": {
3896
+ "fqn": "projen.github.workflows.JobPermissions"
3897
+ }
3898
+ },
3880
3899
  {
3881
3900
  "abstract": true,
3882
3901
  "docs": {
@@ -3888,7 +3907,7 @@
3888
3907
  "immutable": true,
3889
3908
  "locationInModule": {
3890
3909
  "filename": "src/cdk-construct-library-options.ts",
3891
- "line": 1177
3910
+ "line": 1190
3892
3911
  },
3893
3912
  "name": "workflowRunsOn",
3894
3913
  "optional": true,
@@ -3911,7 +3930,7 @@
3911
3930
  "immutable": true,
3912
3931
  "locationInModule": {
3913
3932
  "filename": "src/cdk-construct-library-options.ts",
3914
- "line": 1182
3933
+ "line": 1195
3915
3934
  },
3916
3935
  "name": "workflowRunsOnGroup",
3917
3936
  "optional": true,
@@ -3929,7 +3948,7 @@
3929
3948
  "immutable": true,
3930
3949
  "locationInModule": {
3931
3950
  "filename": "src/cdk-construct-library-options.ts",
3932
- "line": 1187
3951
+ "line": 1200
3933
3952
  },
3934
3953
  "name": "yarnBerryOptions",
3935
3954
  "optional": true,
@@ -7294,6 +7313,25 @@
7294
7313
  "primitive": "boolean"
7295
7314
  }
7296
7315
  },
7316
+ {
7317
+ "abstract": true,
7318
+ "docs": {
7319
+ "default": "- Use the job defaults and automatically inferred permissions.",
7320
+ "remarks": "Defined scopes override the job defaults and automatically inferred permissions,\nincluding CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.\nUse `JobPermission.NONE` to explicitly remove a permission.\n\n`buildWorkflowOptions.permissions` replaces this entire set, including automatic\npermissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual\nscopes. Applies to all release branches, but not to separate package, publishing,\nself-mutation or pull request creation jobs, or unrelated workflows.",
7321
+ "stability": "stable",
7322
+ "summary": "Permissions for the main build, release and dependency upgrade jobs."
7323
+ },
7324
+ "immutable": true,
7325
+ "locationInModule": {
7326
+ "filename": "src/cdk-jsii-options.ts",
7327
+ "line": 1112
7328
+ },
7329
+ "name": "workflowPermissions",
7330
+ "optional": true,
7331
+ "type": {
7332
+ "fqn": "projen.github.workflows.JobPermissions"
7333
+ }
7334
+ },
7297
7335
  {
7298
7336
  "abstract": true,
7299
7337
  "docs": {
@@ -7305,7 +7343,7 @@
7305
7343
  "immutable": true,
7306
7344
  "locationInModule": {
7307
7345
  "filename": "src/cdk-jsii-options.ts",
7308
- "line": 1105
7346
+ "line": 1118
7309
7347
  },
7310
7348
  "name": "workflowRunsOn",
7311
7349
  "optional": true,
@@ -7328,7 +7366,7 @@
7328
7366
  "immutable": true,
7329
7367
  "locationInModule": {
7330
7368
  "filename": "src/cdk-jsii-options.ts",
7331
- "line": 1110
7369
+ "line": 1123
7332
7370
  },
7333
7371
  "name": "workflowRunsOnGroup",
7334
7372
  "optional": true,
@@ -7346,7 +7384,7 @@
7346
7384
  "immutable": true,
7347
7385
  "locationInModule": {
7348
7386
  "filename": "src/cdk-jsii-options.ts",
7349
- "line": 1115
7387
+ "line": 1128
7350
7388
  },
7351
7389
  "name": "yarnBerryOptions",
7352
7390
  "optional": true,
@@ -11701,6 +11739,25 @@
11701
11739
  "primitive": "boolean"
11702
11740
  }
11703
11741
  },
11742
+ {
11743
+ "abstract": true,
11744
+ "docs": {
11745
+ "default": "- Use the job defaults and automatically inferred permissions.",
11746
+ "remarks": "Defined scopes override the job defaults and automatically inferred permissions,\nincluding CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.\nUse `JobPermission.NONE` to explicitly remove a permission.\n\n`buildWorkflowOptions.permissions` replaces this entire set, including automatic\npermissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual\nscopes. Applies to all release branches, but not to separate package, publishing,\nself-mutation or pull request creation jobs, or unrelated workflows.",
11747
+ "stability": "stable",
11748
+ "summary": "Permissions for the main build, release and dependency upgrade jobs."
11749
+ },
11750
+ "immutable": true,
11751
+ "locationInModule": {
11752
+ "filename": "src/yarn/monorepo-options.ts",
11753
+ "line": 995
11754
+ },
11755
+ "name": "workflowPermissions",
11756
+ "optional": true,
11757
+ "type": {
11758
+ "fqn": "projen.github.workflows.JobPermissions"
11759
+ }
11760
+ },
11704
11761
  {
11705
11762
  "abstract": true,
11706
11763
  "docs": {
@@ -11712,7 +11769,7 @@
11712
11769
  "immutable": true,
11713
11770
  "locationInModule": {
11714
11771
  "filename": "src/yarn/monorepo-options.ts",
11715
- "line": 988
11772
+ "line": 1001
11716
11773
  },
11717
11774
  "name": "workflowRunsOn",
11718
11775
  "optional": true,
@@ -11735,7 +11792,7 @@
11735
11792
  "immutable": true,
11736
11793
  "locationInModule": {
11737
11794
  "filename": "src/yarn/monorepo-options.ts",
11738
- "line": 993
11795
+ "line": 1006
11739
11796
  },
11740
11797
  "name": "workflowRunsOnGroup",
11741
11798
  "optional": true,
@@ -11754,7 +11811,7 @@
11754
11811
  "immutable": true,
11755
11812
  "locationInModule": {
11756
11813
  "filename": "src/yarn/monorepo-options.ts",
11757
- "line": 1001
11814
+ "line": 1014
11758
11815
  },
11759
11816
  "name": "yarnBerry",
11760
11817
  "optional": true,
@@ -11772,7 +11829,7 @@
11772
11829
  "immutable": true,
11773
11830
  "locationInModule": {
11774
11831
  "filename": "src/yarn/monorepo-options.ts",
11775
- "line": 1006
11832
+ "line": 1019
11776
11833
  },
11777
11834
  "name": "yarnBerryOptions",
11778
11835
  "optional": true,
@@ -15553,6 +15610,25 @@
15553
15610
  "primitive": "boolean"
15554
15611
  }
15555
15612
  },
15613
+ {
15614
+ "abstract": true,
15615
+ "docs": {
15616
+ "default": "- Use the job defaults and automatically inferred permissions.",
15617
+ "remarks": "Defined scopes override the job defaults and automatically inferred permissions,\nincluding CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.\nUse `JobPermission.NONE` to explicitly remove a permission.\n\n`buildWorkflowOptions.permissions` replaces this entire set, including automatic\npermissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual\nscopes. Applies to all release branches, but not to separate package, publishing,\nself-mutation or pull request creation jobs, or unrelated workflows.",
15618
+ "stability": "stable",
15619
+ "summary": "Permissions for the main build, release and dependency upgrade jobs."
15620
+ },
15621
+ "immutable": true,
15622
+ "locationInModule": {
15623
+ "filename": "src/yarn/typescript-workspace-options.ts",
15624
+ "line": 966
15625
+ },
15626
+ "name": "workflowPermissions",
15627
+ "optional": true,
15628
+ "type": {
15629
+ "fqn": "projen.github.workflows.JobPermissions"
15630
+ }
15631
+ },
15556
15632
  {
15557
15633
  "abstract": true,
15558
15634
  "docs": {
@@ -15564,7 +15640,7 @@
15564
15640
  "immutable": true,
15565
15641
  "locationInModule": {
15566
15642
  "filename": "src/yarn/typescript-workspace-options.ts",
15567
- "line": 959
15643
+ "line": 972
15568
15644
  },
15569
15645
  "name": "workflowRunsOn",
15570
15646
  "optional": true,
@@ -15587,7 +15663,7 @@
15587
15663
  "immutable": true,
15588
15664
  "locationInModule": {
15589
15665
  "filename": "src/yarn/typescript-workspace-options.ts",
15590
- "line": 964
15666
+ "line": 977
15591
15667
  },
15592
15668
  "name": "workflowRunsOnGroup",
15593
15669
  "optional": true,
@@ -15605,7 +15681,7 @@
15605
15681
  "immutable": true,
15606
15682
  "locationInModule": {
15607
15683
  "filename": "src/yarn/typescript-workspace-options.ts",
15608
- "line": 969
15684
+ "line": 982
15609
15685
  },
15610
15686
  "name": "workspaceScope",
15611
15687
  "optional": true,
@@ -15623,7 +15699,7 @@
15623
15699
  "immutable": true,
15624
15700
  "locationInModule": {
15625
15701
  "filename": "src/yarn/typescript-workspace-options.ts",
15626
- "line": 974
15702
+ "line": 987
15627
15703
  },
15628
15704
  "name": "yarnBerryOptions",
15629
15705
  "optional": true,
@@ -16196,6 +16272,6 @@
16196
16272
  "usedFeatures": [
16197
16273
  "class-covariant-overrides"
16198
16274
  ],
16199
- "version": "0.6.20",
16200
- "fingerprint": "N6+H765X7EiGgl95NuqnFyp9GNCLJ1LeXE0yLPfEh04="
16275
+ "version": "0.6.21",
16276
+ "fingerprint": "kehp+hBsvaWlDHPz1CyI36LdICsnj4iN7M7D07u3+9A="
16201
16277
  }
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. |
@@ -17198,6 +17199,28 @@ Enable Node.js package cache in GitHub workflows.
17198
17199
 
17199
17200
  ---
17200
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
+
17201
17224
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.workflowRunsOn"></a>
17202
17225
 
17203
17226
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -17432,6 +17455,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17432
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. |
17433
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. |
17434
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. |
17435
17459
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
17436
17460
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
17437
17461
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
@@ -19985,6 +20009,28 @@ Enable Node.js package cache in GitHub workflows.
19985
20009
 
19986
20010
  ---
19987
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
+
19988
20034
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.workflowRunsOn"></a>
19989
20035
 
19990
20036
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -20230,6 +20276,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
20230
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. |
20231
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. |
20232
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. |
20233
20280
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
20234
20281
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
20235
20282
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
@@ -22959,6 +23006,28 @@ Enable Node.js package cache in GitHub workflows.
22959
23006
 
22960
23007
  ---
22961
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
+
22962
23031
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.workflowRunsOn"></a>
22963
23032
 
22964
23033
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -23230,6 +23299,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
23230
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. |
23231
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. |
23232
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. |
23233
23303
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
23234
23304
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
23235
23305
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
@@ -25785,6 +25855,28 @@ Enable Node.js package cache in GitHub workflows.
25785
25855
 
25786
25856
  ---
25787
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
+
25788
25880
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.workflowRunsOn"></a>
25789
25881
 
25790
25882
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -26038,6 +26130,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
26038
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. |
26039
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. |
26040
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. |
26041
26134
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
26042
26135
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
26043
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. |
@@ -28311,6 +28404,28 @@ Enable Node.js package cache in GitHub workflows.
28311
28404
 
28312
28405
  ---
28313
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
+
28314
28429
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.workflowRunsOn"></a>
28315
28430
 
28316
28431
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -28578,6 +28693,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
28578
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. |
28579
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. |
28580
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. |
28581
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). |
28582
28698
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
28583
28699
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -30636,6 +30752,28 @@ Enable Node.js package cache in GitHub workflows.
30636
30752
 
30637
30753
  ---
30638
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
+
30639
30777
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.disableTsconfig"></a>
30640
30778
 
30641
30779
  ```typescript
@@ -31176,6 +31314,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
31176
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. |
31177
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. |
31178
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. |
31179
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). |
31180
31319
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
31181
31320
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
@@ -33234,6 +33373,28 @@ Enable Node.js package cache in GitHub workflows.
33234
33373
 
33235
33374
  ---
33236
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
+
33237
33398
  ##### `disableTsconfig`<sup>Optional</sup> <a name="disableTsconfig" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.disableTsconfig"></a>
33238
33399
 
33239
33400
  ```typescript
@@ -34186,6 +34347,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
34186
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. |
34187
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. |
34188
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. |
34189
34351
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
34190
34352
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
34191
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. |
@@ -36459,6 +36621,28 @@ Enable Node.js package cache in GitHub workflows.
36459
36621
 
36460
36622
  ---
36461
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
+
36462
36646
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.workflowRunsOn"></a>
36463
36647
 
36464
36648
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -37170,6 +37354,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
37170
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. |
37171
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. |
37172
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. |
37173
37358
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
37174
37359
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
37175
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. |
@@ -39371,6 +39556,28 @@ Enable Node.js package cache in GitHub workflows.
39371
39556
 
39372
39557
  ---
39373
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
+
39374
39581
  ##### ~~`workflowRunsOn`~~<sup>Optional</sup> <a name="workflowRunsOn" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.workflowRunsOn"></a>
39375
39582
 
39376
39583
  - *Deprecated:* use `githubOptions.workflowRunsOn` on the project, or `runsOn` on `ReleaseOptions`
@@ -1167,6 +1167,19 @@ export interface CdkConstructLibraryOptions {
1167
1167
  * @default false
1168
1168
  */
1169
1169
  readonly workflowPackageCache?: boolean;
1170
+ /**
1171
+ * Permissions for the main build, release and dependency upgrade jobs.
1172
+ * Defined scopes override the job defaults and automatically inferred permissions,
1173
+ * including CodeArtifact and Codecov OIDC. Undefined scopes keep their defaults.
1174
+ * Use `JobPermission.NONE` to explicitly remove a permission.
1175
+ *
1176
+ * `buildWorkflowOptions.permissions` replaces this entire set, including automatic
1177
+ * permissions. `depsUpgradeOptions.workflowOptions.permissions` overrides individual
1178
+ * scopes. Applies to all release branches, but not to separate package, publishing,
1179
+ * self-mutation or pull request creation jobs, or unrelated workflows.
1180
+ * @default - Use the job defaults and automatically inferred permissions.
1181
+ */
1182
+ readonly workflowPermissions?: github.workflows.JobPermissions;
1170
1183
  /**
1171
1184
  * Github Runner selection labels.
1172
1185
  * @default ["ubuntu-latest"]