cdklabs-projen-project-types 0.3.1 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/API.md CHANGED
@@ -738,6 +738,7 @@ When given a project, this it the project itself.
738
738
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
739
739
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
740
740
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
741
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
741
742
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
742
743
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
743
744
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibrary.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
@@ -1276,6 +1277,16 @@ Component that sets up mergify for merging approved pull requests.
1276
1277
 
1277
1278
  ---
1278
1279
 
1280
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdkConstructLibrary.property.biome"></a>
1281
+
1282
+ ```typescript
1283
+ public readonly biome: Biome;
1284
+ ```
1285
+
1286
+ - *Type:* projen.javascript.Biome
1287
+
1288
+ ---
1289
+
1279
1290
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.CdkConstructLibrary.property.buildWorkflow"></a>
1280
1291
 
1281
1292
  ```typescript
@@ -2293,6 +2304,7 @@ When given a project, this it the project itself.
2293
2304
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
2294
2305
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
2295
2306
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
2307
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
2296
2308
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
2297
2309
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
2298
2310
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
@@ -2828,6 +2840,16 @@ Component that sets up mergify for merging approved pull requests.
2828
2840
 
2829
2841
  ---
2830
2842
 
2843
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdkJsiiProject.property.biome"></a>
2844
+
2845
+ ```typescript
2846
+ public readonly biome: Biome;
2847
+ ```
2848
+
2849
+ - *Type:* projen.javascript.Biome
2850
+
2851
+ ---
2852
+
2831
2853
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.CdkJsiiProject.property.buildWorkflow"></a>
2832
2854
 
2833
2855
  ```typescript
@@ -3847,6 +3869,7 @@ When given a project, this it the project itself.
3847
3869
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
3848
3870
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
3849
3871
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
3872
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
3850
3873
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
3851
3874
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
3852
3875
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibrary.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
@@ -4385,6 +4408,16 @@ Component that sets up mergify for merging approved pull requests.
4385
4408
 
4386
4409
  ---
4387
4410
 
4411
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdklabsConstructLibrary.property.biome"></a>
4412
+
4413
+ ```typescript
4414
+ public readonly biome: Biome;
4415
+ ```
4416
+
4417
+ - *Type:* projen.javascript.Biome
4418
+
4419
+ ---
4420
+
4388
4421
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.CdklabsConstructLibrary.property.buildWorkflow"></a>
4389
4422
 
4390
4423
  ```typescript
@@ -5402,6 +5435,7 @@ When given a project, this it the project itself.
5402
5435
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
5403
5436
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
5404
5437
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
5438
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
5405
5439
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
5406
5440
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
5407
5441
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
@@ -5937,6 +5971,16 @@ Component that sets up mergify for merging approved pull requests.
5937
5971
 
5938
5972
  ---
5939
5973
 
5974
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdklabsJsiiProject.property.biome"></a>
5975
+
5976
+ ```typescript
5977
+ public readonly biome: Biome;
5978
+ ```
5979
+
5980
+ - *Type:* projen.javascript.Biome
5981
+
5982
+ ---
5983
+
5940
5984
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.CdklabsJsiiProject.property.buildWorkflow"></a>
5941
5985
 
5942
5986
  ```typescript
@@ -6963,6 +7007,7 @@ yarn.CdkLabsMonorepo.isMonorepo(x: Project)
6963
7007
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
6964
7008
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
6965
7009
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
7010
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
6966
7011
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
6967
7012
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
6968
7013
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
@@ -7499,6 +7544,16 @@ Component that sets up mergify for merging approved pull requests.
7499
7544
 
7500
7545
  ---
7501
7546
 
7547
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.biome"></a>
7548
+
7549
+ ```typescript
7550
+ public readonly biome: Biome;
7551
+ ```
7552
+
7553
+ - *Type:* projen.javascript.Biome
7554
+
7555
+ ---
7556
+
7502
7557
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepo.property.buildWorkflow"></a>
7503
7558
 
7504
7559
  ```typescript
@@ -8496,6 +8551,7 @@ When given a project, this it the project itself.
8496
8551
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
8497
8552
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
8498
8553
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
8554
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
8499
8555
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
8500
8556
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
8501
8557
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
@@ -9031,6 +9087,16 @@ Component that sets up mergify for merging approved pull requests.
9031
9087
 
9032
9088
  ---
9033
9089
 
9090
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.property.biome"></a>
9091
+
9092
+ ```typescript
9093
+ public readonly biome: Biome;
9094
+ ```
9095
+
9096
+ - *Type:* projen.javascript.Biome
9097
+
9098
+ ---
9099
+
9034
9100
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.CdklabsTypeScriptProject.property.buildWorkflow"></a>
9035
9101
 
9036
9102
  ```typescript
@@ -10014,6 +10080,7 @@ When given a project, this it the project itself.
10014
10080
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
10015
10081
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
10016
10082
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
10083
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
10017
10084
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
10018
10085
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
10019
10086
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProject.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
@@ -10549,6 +10616,16 @@ Component that sets up mergify for merging approved pull requests.
10549
10616
 
10550
10617
  ---
10551
10618
 
10619
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdkTypeScriptProject.property.biome"></a>
10620
+
10621
+ ```typescript
10622
+ public readonly biome: Biome;
10623
+ ```
10624
+
10625
+ - *Type:* projen.javascript.Biome
10626
+
10627
+ ---
10628
+
10552
10629
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.CdkTypeScriptProject.property.buildWorkflow"></a>
10553
10630
 
10554
10631
  ```typescript
@@ -11575,6 +11652,7 @@ yarn.Monorepo.isMonorepo(x: Project)
11575
11652
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
11576
11653
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
11577
11654
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
11655
+ | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
11578
11656
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
11579
11657
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
11580
11658
  | <code><a href="#cdklabs-projen-project-types.yarn.Monorepo.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
@@ -12111,6 +12189,16 @@ Component that sets up mergify for merging approved pull requests.
12111
12189
 
12112
12190
  ---
12113
12191
 
12192
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.yarn.Monorepo.property.biome"></a>
12193
+
12194
+ ```typescript
12195
+ public readonly biome: Biome;
12196
+ ```
12197
+
12198
+ - *Type:* projen.javascript.Biome
12199
+
12200
+ ---
12201
+
12114
12202
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.yarn.Monorepo.property.buildWorkflow"></a>
12115
12203
 
12116
12204
  ```typescript
@@ -13523,6 +13611,7 @@ When given a project, this it the project itself.
13523
13611
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
13524
13612
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
13525
13613
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
13614
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
13526
13615
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.buildWorkflow">buildWorkflow</a></code> | <code>projen.build.BuildWorkflow</code> | The PR build GitHub workflow. |
13527
13616
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.buildWorkflowJobId">buildWorkflowJobId</a></code> | <code>string</code> | The job ID of the build workflow. |
13528
13617
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.jest">jest</a></code> | <code>projen.javascript.Jest</code> | The Jest configuration (if enabled). |
@@ -14061,6 +14150,16 @@ Component that sets up mergify for merging approved pull requests.
14061
14150
 
14062
14151
  ---
14063
14152
 
14153
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.biome"></a>
14154
+
14155
+ ```typescript
14156
+ public readonly biome: Biome;
14157
+ ```
14158
+
14159
+ - *Type:* projen.javascript.Biome
14160
+
14161
+ ---
14162
+
14064
14163
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspace.property.buildWorkflow"></a>
14065
14164
 
14066
14165
  ```typescript
@@ -14732,6 +14831,8 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14732
14831
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
14733
14832
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
14734
14833
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
14834
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
14835
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
14735
14836
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
14736
14837
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
14737
14838
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
@@ -14752,8 +14853,8 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14752
14853
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
14753
14854
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
14754
14855
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
14755
- | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
14756
- | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
14856
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
14857
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
14757
14858
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
14758
14859
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
14759
14860
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -14821,6 +14922,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14821
14922
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
14822
14923
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
14823
14924
  | <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. |
14925
+ | <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. |
14824
14926
  | <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. |
14825
14927
  | <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`). |
14826
14928
  | <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. |
@@ -14859,6 +14961,7 @@ const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... }
14859
14961
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
14860
14962
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
14861
14963
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
14964
+ | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
14862
14965
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
14863
14966
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
14864
14967
  | <code><a href="#cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -15137,6 +15240,32 @@ executable file under `bin` will automatically be added to this section.
15137
15240
 
15138
15241
  ---
15139
15242
 
15243
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.biome"></a>
15244
+
15245
+ ```typescript
15246
+ public readonly biome: boolean;
15247
+ ```
15248
+
15249
+ - *Type:* boolean
15250
+ - *Default:* false
15251
+
15252
+ Setup Biome.
15253
+
15254
+ ---
15255
+
15256
+ ##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.biomeOptions"></a>
15257
+
15258
+ ```typescript
15259
+ public readonly biomeOptions: BiomeOptions;
15260
+ ```
15261
+
15262
+ - *Type:* projen.javascript.BiomeOptions
15263
+ - *Default:* default options
15264
+
15265
+ Biome options.
15266
+
15267
+ ---
15268
+
15140
15269
  ##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.bugsEmail"></a>
15141
15270
 
15142
15271
  ```typescript
@@ -15454,7 +15583,7 @@ public readonly codeCov: boolean;
15454
15583
  - *Type:* boolean
15455
15584
  - *Default:* false
15456
15585
 
15457
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
15586
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
15458
15587
 
15459
15588
  ---
15460
15589
 
@@ -15465,9 +15594,9 @@ public readonly codeCovTokenSecret: string;
15465
15594
  ```
15466
15595
 
15467
15596
  - *Type:* string
15468
- - *Default:* if this option is not specified, only public repositories are supported
15597
+ - *Default:* OIDC auth is used
15469
15598
 
15470
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
15599
+ Define the secret name for a specified https://codecov.io/ token.
15471
15600
 
15472
15601
  ---
15473
15602
 
@@ -15831,7 +15960,7 @@ public readonly eslint: boolean;
15831
15960
  ```
15832
15961
 
15833
15962
  - *Type:* boolean
15834
- - *Default:* true
15963
+ - *Default:* true, unless biome is enabled
15835
15964
 
15836
15965
  Setup eslint.
15837
15966
 
@@ -16445,6 +16574,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
16445
16574
 
16446
16575
  ---
16447
16576
 
16577
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.npmTrustedPublishing"></a>
16578
+
16579
+ ```typescript
16580
+ public readonly npmTrustedPublishing: boolean;
16581
+ ```
16582
+
16583
+ - *Type:* boolean
16584
+ - *Default:* false
16585
+
16586
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
16587
+
16588
+ ---
16589
+
16448
16590
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.outdir"></a>
16449
16591
 
16450
16592
  ```typescript
@@ -16974,6 +17116,25 @@ be provided for the default branch.
16974
17116
 
16975
17117
  ---
16976
17118
 
17119
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseEnvironment"></a>
17120
+
17121
+ ```typescript
17122
+ public readonly releaseEnvironment: string;
17123
+ ```
17124
+
17125
+ - *Type:* string
17126
+ - *Default:* no environment used, unless set at the artifact level
17127
+
17128
+ The GitHub Actions environment used for the release.
17129
+
17130
+ This can be used to add an explicit approval step to the release
17131
+ or limit who can initiate a release through environment protection rules.
17132
+
17133
+ When multiple artifacts are released, the environment can be overwritten
17134
+ on a per artifact basis.
17135
+
17136
+ ---
17137
+
16977
17138
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdkConstructLibraryOptions.property.releaseEveryCommit"></a>
16978
17139
 
16979
17140
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -17605,6 +17766,8 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17605
17766
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
17606
17767
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
17607
17768
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
17769
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
17770
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
17608
17771
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
17609
17772
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
17610
17773
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
@@ -17617,8 +17780,8 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17617
17780
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
17618
17781
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
17619
17782
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
17620
- | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
17621
- | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
17783
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
17784
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
17622
17785
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
17623
17786
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
17624
17787
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -17679,6 +17842,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17679
17842
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
17680
17843
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
17681
17844
  | <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. |
17845
+ | <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. |
17682
17846
  | <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. |
17683
17847
  | <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`). |
17684
17848
  | <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. |
@@ -17717,6 +17881,7 @@ const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... }
17717
17881
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
17718
17882
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
17719
17883
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
17884
+ | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
17720
17885
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
17721
17886
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
17722
17887
  | <code><a href="#cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -17981,6 +18146,32 @@ executable file under `bin` will automatically be added to this section.
17981
18146
 
17982
18147
  ---
17983
18148
 
18149
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.biome"></a>
18150
+
18151
+ ```typescript
18152
+ public readonly biome: boolean;
18153
+ ```
18154
+
18155
+ - *Type:* boolean
18156
+ - *Default:* false
18157
+
18158
+ Setup Biome.
18159
+
18160
+ ---
18161
+
18162
+ ##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.biomeOptions"></a>
18163
+
18164
+ ```typescript
18165
+ public readonly biomeOptions: BiomeOptions;
18166
+ ```
18167
+
18168
+ - *Type:* projen.javascript.BiomeOptions
18169
+ - *Default:* default options
18170
+
18171
+ Biome options.
18172
+
18173
+ ---
18174
+
17984
18175
  ##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.bugsEmail"></a>
17985
18176
 
17986
18177
  ```typescript
@@ -18160,7 +18351,7 @@ public readonly codeCov: boolean;
18160
18351
  - *Type:* boolean
18161
18352
  - *Default:* false
18162
18353
 
18163
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
18354
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
18164
18355
 
18165
18356
  ---
18166
18357
 
@@ -18171,9 +18362,9 @@ public readonly codeCovTokenSecret: string;
18171
18362
  ```
18172
18363
 
18173
18364
  - *Type:* string
18174
- - *Default:* if this option is not specified, only public repositories are supported
18365
+ - *Default:* OIDC auth is used
18175
18366
 
18176
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
18367
+ Define the secret name for a specified https://codecov.io/ token.
18177
18368
 
18178
18369
  ---
18179
18370
 
@@ -18511,7 +18702,7 @@ public readonly eslint: boolean;
18511
18702
  ```
18512
18703
 
18513
18704
  - *Type:* boolean
18514
- - *Default:* true
18705
+ - *Default:* true, unless biome is enabled
18515
18706
 
18516
18707
  Setup eslint.
18517
18708
 
@@ -19068,6 +19259,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
19068
19259
 
19069
19260
  ---
19070
19261
 
19262
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.npmTrustedPublishing"></a>
19263
+
19264
+ ```typescript
19265
+ public readonly npmTrustedPublishing: boolean;
19266
+ ```
19267
+
19268
+ - *Type:* boolean
19269
+ - *Default:* false
19270
+
19271
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
19272
+
19273
+ ---
19274
+
19071
19275
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.outdir"></a>
19072
19276
 
19073
19277
  ```typescript
@@ -19597,6 +19801,25 @@ be provided for the default branch.
19597
19801
 
19598
19802
  ---
19599
19803
 
19804
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseEnvironment"></a>
19805
+
19806
+ ```typescript
19807
+ public readonly releaseEnvironment: string;
19808
+ ```
19809
+
19810
+ - *Type:* string
19811
+ - *Default:* no environment used, unless set at the artifact level
19812
+
19813
+ The GitHub Actions environment used for the release.
19814
+
19815
+ This can be used to add an explicit approval step to the release
19816
+ or limit who can initiate a release through environment protection rules.
19817
+
19818
+ When multiple artifacts are released, the environment can be overwritten
19819
+ on a per artifact basis.
19820
+
19821
+ ---
19822
+
19600
19823
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdkJsiiProjectOptions.property.releaseEveryCommit"></a>
19601
19824
 
19602
19825
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -20217,6 +20440,8 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
20217
20440
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
20218
20441
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
20219
20442
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
20443
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
20444
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
20220
20445
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
20221
20446
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
20222
20447
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
@@ -20237,8 +20462,8 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
20237
20462
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
20238
20463
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
20239
20464
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
20240
- | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
20241
- | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
20465
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
20466
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
20242
20467
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
20243
20468
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
20244
20469
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -20306,6 +20531,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
20306
20531
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
20307
20532
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
20308
20533
  | <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. |
20534
+ | <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. |
20309
20535
  | <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. |
20310
20536
  | <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`). |
20311
20537
  | <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. |
@@ -20344,6 +20570,7 @@ const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... }
20344
20570
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
20345
20571
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
20346
20572
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
20573
+ | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
20347
20574
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
20348
20575
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
20349
20576
  | <code><a href="#cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -20624,6 +20851,32 @@ executable file under `bin` will automatically be added to this section.
20624
20851
 
20625
20852
  ---
20626
20853
 
20854
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.biome"></a>
20855
+
20856
+ ```typescript
20857
+ public readonly biome: boolean;
20858
+ ```
20859
+
20860
+ - *Type:* boolean
20861
+ - *Default:* false
20862
+
20863
+ Setup Biome.
20864
+
20865
+ ---
20866
+
20867
+ ##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.biomeOptions"></a>
20868
+
20869
+ ```typescript
20870
+ public readonly biomeOptions: BiomeOptions;
20871
+ ```
20872
+
20873
+ - *Type:* projen.javascript.BiomeOptions
20874
+ - *Default:* default options
20875
+
20876
+ Biome options.
20877
+
20878
+ ---
20879
+
20627
20880
  ##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.bugsEmail"></a>
20628
20881
 
20629
20882
  ```typescript
@@ -20941,7 +21194,7 @@ public readonly codeCov: boolean;
20941
21194
  - *Type:* boolean
20942
21195
  - *Default:* false
20943
21196
 
20944
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
21197
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
20945
21198
 
20946
21199
  ---
20947
21200
 
@@ -20952,9 +21205,9 @@ public readonly codeCovTokenSecret: string;
20952
21205
  ```
20953
21206
 
20954
21207
  - *Type:* string
20955
- - *Default:* if this option is not specified, only public repositories are supported
21208
+ - *Default:* OIDC auth is used
20956
21209
 
20957
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
21210
+ Define the secret name for a specified https://codecov.io/ token.
20958
21211
 
20959
21212
  ---
20960
21213
 
@@ -21318,7 +21571,7 @@ public readonly eslint: boolean;
21318
21571
  ```
21319
21572
 
21320
21573
  - *Type:* boolean
21321
- - *Default:* true
21574
+ - *Default:* true, unless biome is enabled
21322
21575
 
21323
21576
  Setup eslint.
21324
21577
 
@@ -21932,6 +22185,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
21932
22185
 
21933
22186
  ---
21934
22187
 
22188
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.npmTrustedPublishing"></a>
22189
+
22190
+ ```typescript
22191
+ public readonly npmTrustedPublishing: boolean;
22192
+ ```
22193
+
22194
+ - *Type:* boolean
22195
+ - *Default:* false
22196
+
22197
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
22198
+
22199
+ ---
22200
+
21935
22201
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.outdir"></a>
21936
22202
 
21937
22203
  ```typescript
@@ -22461,6 +22727,25 @@ be provided for the default branch.
22461
22727
 
22462
22728
  ---
22463
22729
 
22730
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseEnvironment"></a>
22731
+
22732
+ ```typescript
22733
+ public readonly releaseEnvironment: string;
22734
+ ```
22735
+
22736
+ - *Type:* string
22737
+ - *Default:* no environment used, unless set at the artifact level
22738
+
22739
+ The GitHub Actions environment used for the release.
22740
+
22741
+ This can be used to add an explicit approval step to the release
22742
+ or limit who can initiate a release through environment protection rules.
22743
+
22744
+ When multiple artifacts are released, the environment can be overwritten
22745
+ on a per artifact basis.
22746
+
22747
+ ---
22748
+
22464
22749
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdklabsConstructLibraryOptions.property.releaseEveryCommit"></a>
22465
22750
 
22466
22751
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -23129,6 +23414,8 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
23129
23414
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
23130
23415
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
23131
23416
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
23417
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
23418
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
23132
23419
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
23133
23420
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
23134
23421
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
@@ -23141,8 +23428,8 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
23141
23428
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
23142
23429
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
23143
23430
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
23144
- | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
23145
- | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
23431
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
23432
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
23146
23433
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
23147
23434
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
23148
23435
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
@@ -23203,6 +23490,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
23203
23490
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
23204
23491
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
23205
23492
  | <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. |
23493
+ | <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. |
23206
23494
  | <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. |
23207
23495
  | <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`). |
23208
23496
  | <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. |
@@ -23241,6 +23529,7 @@ const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... }
23241
23529
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
23242
23530
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
23243
23531
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
23532
+ | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
23244
23533
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
23245
23534
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
23246
23535
  | <code><a href="#cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -23507,6 +23796,32 @@ executable file under `bin` will automatically be added to this section.
23507
23796
 
23508
23797
  ---
23509
23798
 
23799
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.biome"></a>
23800
+
23801
+ ```typescript
23802
+ public readonly biome: boolean;
23803
+ ```
23804
+
23805
+ - *Type:* boolean
23806
+ - *Default:* false
23807
+
23808
+ Setup Biome.
23809
+
23810
+ ---
23811
+
23812
+ ##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.biomeOptions"></a>
23813
+
23814
+ ```typescript
23815
+ public readonly biomeOptions: BiomeOptions;
23816
+ ```
23817
+
23818
+ - *Type:* projen.javascript.BiomeOptions
23819
+ - *Default:* default options
23820
+
23821
+ Biome options.
23822
+
23823
+ ---
23824
+
23510
23825
  ##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.bugsEmail"></a>
23511
23826
 
23512
23827
  ```typescript
@@ -23686,7 +24001,7 @@ public readonly codeCov: boolean;
23686
24001
  - *Type:* boolean
23687
24002
  - *Default:* false
23688
24003
 
23689
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
24004
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
23690
24005
 
23691
24006
  ---
23692
24007
 
@@ -23697,9 +24012,9 @@ public readonly codeCovTokenSecret: string;
23697
24012
  ```
23698
24013
 
23699
24014
  - *Type:* string
23700
- - *Default:* if this option is not specified, only public repositories are supported
24015
+ - *Default:* OIDC auth is used
23701
24016
 
23702
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
24017
+ Define the secret name for a specified https://codecov.io/ token.
23703
24018
 
23704
24019
  ---
23705
24020
 
@@ -24037,7 +24352,7 @@ public readonly eslint: boolean;
24037
24352
  ```
24038
24353
 
24039
24354
  - *Type:* boolean
24040
- - *Default:* true
24355
+ - *Default:* true, unless biome is enabled
24041
24356
 
24042
24357
  Setup eslint.
24043
24358
 
@@ -24594,6 +24909,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
24594
24909
 
24595
24910
  ---
24596
24911
 
24912
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.npmTrustedPublishing"></a>
24913
+
24914
+ ```typescript
24915
+ public readonly npmTrustedPublishing: boolean;
24916
+ ```
24917
+
24918
+ - *Type:* boolean
24919
+ - *Default:* false
24920
+
24921
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
24922
+
24923
+ ---
24924
+
24597
24925
  ##### `outdir`<sup>Optional</sup> <a name="outdir" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.outdir"></a>
24598
24926
 
24599
24927
  ```typescript
@@ -25123,6 +25451,25 @@ be provided for the default branch.
25123
25451
 
25124
25452
  ---
25125
25453
 
25454
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseEnvironment"></a>
25455
+
25456
+ ```typescript
25457
+ public readonly releaseEnvironment: string;
25458
+ ```
25459
+
25460
+ - *Type:* string
25461
+ - *Default:* no environment used, unless set at the artifact level
25462
+
25463
+ The GitHub Actions environment used for the release.
25464
+
25465
+ This can be used to add an explicit approval step to the release
25466
+ or limit who can initiate a release through environment protection rules.
25467
+
25468
+ When multiple artifacts are released, the environment can be overwritten
25469
+ on a per artifact basis.
25470
+
25471
+ ---
25472
+
25126
25473
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdklabsJsiiProjectOptions.property.releaseEveryCommit"></a>
25127
25474
 
25128
25475
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -25781,6 +26128,8 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
25781
26128
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
25782
26129
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
25783
26130
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
26131
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
26132
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
25784
26133
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
25785
26134
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
25786
26135
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.buildWithNx">buildWithNx</a></code> | <code>boolean</code> | When Nx is enabled, always build the monorepo using Nx Will build projects in parallel and can improve build performance. |
@@ -25794,8 +26143,8 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
25794
26143
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
25795
26144
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
25796
26145
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
25797
- | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
25798
- | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
26146
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
26147
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
25799
26148
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
25800
26149
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
25801
26150
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -25844,6 +26193,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
25844
26193
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
25845
26194
  | <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. |
25846
26195
  | <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. |
26196
+ | <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. |
25847
26197
  | <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. |
25848
26198
  | <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. |
25849
26199
  | <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`). |
@@ -25876,6 +26226,7 @@ const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... }
25876
26226
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
25877
26227
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.release">release</a></code> | <code>boolean</code> | Whether or not to add release workflows for this repository. |
25878
26228
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
26229
+ | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
25879
26230
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
25880
26231
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
25881
26232
  | <code><a href="#cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -26110,6 +26461,32 @@ executable file under `bin` will automatically be added to this section.
26110
26461
 
26111
26462
  ---
26112
26463
 
26464
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.biome"></a>
26465
+
26466
+ ```typescript
26467
+ public readonly biome: boolean;
26468
+ ```
26469
+
26470
+ - *Type:* boolean
26471
+ - *Default:* false
26472
+
26473
+ Setup Biome.
26474
+
26475
+ ---
26476
+
26477
+ ##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.biomeOptions"></a>
26478
+
26479
+ ```typescript
26480
+ public readonly biomeOptions: BiomeOptions;
26481
+ ```
26482
+
26483
+ - *Type:* projen.javascript.BiomeOptions
26484
+ - *Default:* default options
26485
+
26486
+ Biome options.
26487
+
26488
+ ---
26489
+
26113
26490
  ##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.bugsEmail"></a>
26114
26491
 
26115
26492
  ```typescript
@@ -26302,7 +26679,7 @@ public readonly codeCov: boolean;
26302
26679
  - *Type:* boolean
26303
26680
  - *Default:* false
26304
26681
 
26305
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
26682
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
26306
26683
 
26307
26684
  ---
26308
26685
 
@@ -26313,9 +26690,9 @@ public readonly codeCovTokenSecret: string;
26313
26690
  ```
26314
26691
 
26315
26692
  - *Type:* string
26316
- - *Default:* if this option is not specified, only public repositories are supported
26693
+ - *Default:* OIDC auth is used
26317
26694
 
26318
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
26695
+ Define the secret name for a specified https://codecov.io/ token.
26319
26696
 
26320
26697
  ---
26321
26698
 
@@ -27030,6 +27407,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
27030
27407
 
27031
27408
  ---
27032
27409
 
27410
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.npmTrustedPublishing"></a>
27411
+
27412
+ ```typescript
27413
+ public readonly npmTrustedPublishing: boolean;
27414
+ ```
27415
+
27416
+ - *Type:* boolean
27417
+ - *Default:* false
27418
+
27419
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
27420
+
27421
+ ---
27422
+
27033
27423
  ##### `nx`<sup>Optional</sup> <a name="nx" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.nx"></a>
27034
27424
 
27035
27425
  ```typescript
@@ -27480,6 +27870,25 @@ be provided for the default branch.
27480
27870
 
27481
27871
  ---
27482
27872
 
27873
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseEnvironment"></a>
27874
+
27875
+ ```typescript
27876
+ public readonly releaseEnvironment: string;
27877
+ ```
27878
+
27879
+ - *Type:* string
27880
+ - *Default:* no environment used, unless set at the artifact level
27881
+
27882
+ The GitHub Actions environment used for the release.
27883
+
27884
+ This can be used to add an explicit approval step to the release
27885
+ or limit who can initiate a release through environment protection rules.
27886
+
27887
+ When multiple artifacts are released, the environment can be overwritten
27888
+ on a per artifact basis.
27889
+
27890
+ ---
27891
+
27483
27892
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions.property.releaseEveryCommit"></a>
27484
27893
 
27485
27894
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -28147,6 +28556,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
28147
28556
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
28148
28557
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
28149
28558
  | <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. |
28559
+ | <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. |
28150
28560
  | <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. |
28151
28561
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
28152
28562
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
@@ -28170,6 +28580,7 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
28170
28580
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
28171
28581
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
28172
28582
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
28583
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
28173
28584
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
28174
28585
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
28175
28586
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -28185,13 +28596,15 @@ const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... }
28185
28596
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
28186
28597
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
28187
28598
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
28599
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
28600
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
28188
28601
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
28189
28602
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
28190
28603
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
28191
28604
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
28192
28605
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
28193
- | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
28194
- | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
28606
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
28607
+ | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
28195
28608
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
28196
28609
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
28197
28610
  | <code><a href="#cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -29092,6 +29505,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
29092
29505
 
29093
29506
  ---
29094
29507
 
29508
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.npmTrustedPublishing"></a>
29509
+
29510
+ ```typescript
29511
+ public readonly npmTrustedPublishing: boolean;
29512
+ ```
29513
+
29514
+ - *Type:* boolean
29515
+ - *Default:* false
29516
+
29517
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
29518
+
29519
+ ---
29520
+
29095
29521
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.packageManager"></a>
29096
29522
 
29097
29523
  ```typescript
@@ -29451,6 +29877,25 @@ be provided for the default branch.
29451
29877
 
29452
29878
  ---
29453
29879
 
29880
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseEnvironment"></a>
29881
+
29882
+ ```typescript
29883
+ public readonly releaseEnvironment: string;
29884
+ ```
29885
+
29886
+ - *Type:* string
29887
+ - *Default:* no environment used, unless set at the artifact level
29888
+
29889
+ The GitHub Actions environment used for the release.
29890
+
29891
+ This can be used to add an explicit approval step to the release
29892
+ or limit who can initiate a release through environment protection rules.
29893
+
29894
+ When multiple artifacts are released, the environment can be overwritten
29895
+ on a per artifact basis.
29896
+
29897
+ ---
29898
+
29454
29899
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.releaseEveryCommit"></a>
29455
29900
 
29456
29901
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -29659,6 +30104,32 @@ Throw if set to true but `autoApproveOptions` are not defined.
29659
30104
 
29660
30105
  ---
29661
30106
 
30107
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.biome"></a>
30108
+
30109
+ ```typescript
30110
+ public readonly biome: boolean;
30111
+ ```
30112
+
30113
+ - *Type:* boolean
30114
+ - *Default:* false
30115
+
30116
+ Setup Biome.
30117
+
30118
+ ---
30119
+
30120
+ ##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.biomeOptions"></a>
30121
+
30122
+ ```typescript
30123
+ public readonly biomeOptions: BiomeOptions;
30124
+ ```
30125
+
30126
+ - *Type:* projen.javascript.BiomeOptions
30127
+ - *Default:* default options
30128
+
30129
+ Biome options.
30130
+
30131
+ ---
30132
+
29662
30133
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions.property.buildWorkflow"></a>
29663
30134
 
29664
30135
  ```typescript
@@ -29735,7 +30206,7 @@ public readonly codeCov: boolean;
29735
30206
  - *Type:* boolean
29736
30207
  - *Default:* false
29737
30208
 
29738
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
30209
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
29739
30210
 
29740
30211
  ---
29741
30212
 
@@ -29746,9 +30217,9 @@ public readonly codeCovTokenSecret: string;
29746
30217
  ```
29747
30218
 
29748
30219
  - *Type:* string
29749
- - *Default:* if this option is not specified, only public repositories are supported
30220
+ - *Default:* OIDC auth is used
29750
30221
 
29751
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
30222
+ Define the secret name for a specified https://codecov.io/ token.
29752
30223
 
29753
30224
  ---
29754
30225
 
@@ -30216,7 +30687,7 @@ public readonly eslint: boolean;
30216
30687
  ```
30217
30688
 
30218
30689
  - *Type:* boolean
30219
- - *Default:* true
30690
+ - *Default:* true, unless biome is enabled
30220
30691
 
30221
30692
  Setup eslint.
30222
30693
 
@@ -30551,6 +31022,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
30551
31022
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
30552
31023
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
30553
31024
  | <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. |
31025
+ | <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. |
30554
31026
  | <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. |
30555
31027
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
30556
31028
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
@@ -30574,6 +31046,7 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
30574
31046
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
30575
31047
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
30576
31048
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
31049
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
30577
31050
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
30578
31051
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
30579
31052
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -30589,13 +31062,15 @@ const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... }
30589
31062
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
30590
31063
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
30591
31064
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
31065
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
31066
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
30592
31067
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
30593
31068
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
30594
31069
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
30595
31070
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
30596
31071
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
30597
- | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
30598
- | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
31072
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
31073
+ | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
30599
31074
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
30600
31075
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
30601
31076
  | <code><a href="#cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
@@ -31496,6 +31971,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
31496
31971
 
31497
31972
  ---
31498
31973
 
31974
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.npmTrustedPublishing"></a>
31975
+
31976
+ ```typescript
31977
+ public readonly npmTrustedPublishing: boolean;
31978
+ ```
31979
+
31980
+ - *Type:* boolean
31981
+ - *Default:* false
31982
+
31983
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
31984
+
31985
+ ---
31986
+
31499
31987
  ##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.packageManager"></a>
31500
31988
 
31501
31989
  ```typescript
@@ -31855,6 +32343,25 @@ be provided for the default branch.
31855
32343
 
31856
32344
  ---
31857
32345
 
32346
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseEnvironment"></a>
32347
+
32348
+ ```typescript
32349
+ public readonly releaseEnvironment: string;
32350
+ ```
32351
+
32352
+ - *Type:* string
32353
+ - *Default:* no environment used, unless set at the artifact level
32354
+
32355
+ The GitHub Actions environment used for the release.
32356
+
32357
+ This can be used to add an explicit approval step to the release
32358
+ or limit who can initiate a release through environment protection rules.
32359
+
32360
+ When multiple artifacts are released, the environment can be overwritten
32361
+ on a per artifact basis.
32362
+
32363
+ ---
32364
+
31858
32365
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.releaseEveryCommit"></a>
31859
32366
 
31860
32367
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -32063,6 +32570,32 @@ Throw if set to true but `autoApproveOptions` are not defined.
32063
32570
 
32064
32571
  ---
32065
32572
 
32573
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.biome"></a>
32574
+
32575
+ ```typescript
32576
+ public readonly biome: boolean;
32577
+ ```
32578
+
32579
+ - *Type:* boolean
32580
+ - *Default:* false
32581
+
32582
+ Setup Biome.
32583
+
32584
+ ---
32585
+
32586
+ ##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.biomeOptions"></a>
32587
+
32588
+ ```typescript
32589
+ public readonly biomeOptions: BiomeOptions;
32590
+ ```
32591
+
32592
+ - *Type:* projen.javascript.BiomeOptions
32593
+ - *Default:* default options
32594
+
32595
+ Biome options.
32596
+
32597
+ ---
32598
+
32066
32599
  ##### `buildWorkflow`<sup>Optional</sup> <a name="buildWorkflow" id="cdklabs-projen-project-types.CdkTypeScriptProjectOptions.property.buildWorkflow"></a>
32067
32600
 
32068
32601
  ```typescript
@@ -32139,7 +32672,7 @@ public readonly codeCov: boolean;
32139
32672
  - *Type:* boolean
32140
32673
  - *Default:* false
32141
32674
 
32142
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
32675
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
32143
32676
 
32144
32677
  ---
32145
32678
 
@@ -32150,9 +32683,9 @@ public readonly codeCovTokenSecret: string;
32150
32683
  ```
32151
32684
 
32152
32685
  - *Type:* string
32153
- - *Default:* if this option is not specified, only public repositories are supported
32686
+ - *Default:* OIDC auth is used
32154
32687
 
32155
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
32688
+ Define the secret name for a specified https://codecov.io/ token.
32156
32689
 
32157
32690
  ---
32158
32691
 
@@ -32620,7 +33153,7 @@ public readonly eslint: boolean;
32620
33153
  ```
32621
33154
 
32622
33155
  - *Type:* boolean
32623
- - *Default:* true
33156
+ - *Default:* true, unless biome is enabled
32624
33157
 
32625
33158
  Setup eslint.
32626
33159
 
@@ -32915,6 +33448,8 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
32915
33448
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
32916
33449
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
32917
33450
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
33451
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
33452
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
32918
33453
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
32919
33454
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
32920
33455
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.buildWithNx">buildWithNx</a></code> | <code>boolean</code> | When Nx is enabled, always build the monorepo using Nx Will build projects in parallel and can improve build performance. |
@@ -32928,8 +33463,8 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
32928
33463
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
32929
33464
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
32930
33465
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
32931
- | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
32932
- | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
33466
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
33467
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
32933
33468
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
32934
33469
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
32935
33470
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -32978,6 +33513,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
32978
33513
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
32979
33514
  | <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. |
32980
33515
  | <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. |
33516
+ | <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. |
32981
33517
  | <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. |
32982
33518
  | <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. |
32983
33519
  | <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`). |
@@ -33010,6 +33546,7 @@ const monorepoOptions: yarn.MonorepoOptions = { ... }
33010
33546
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
33011
33547
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.release">release</a></code> | <code>boolean</code> | Whether or not to add release workflows for this repository. |
33012
33548
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
33549
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
33013
33550
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
33014
33551
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
33015
33552
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -33244,6 +33781,32 @@ executable file under `bin` will automatically be added to this section.
33244
33781
 
33245
33782
  ---
33246
33783
 
33784
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.biome"></a>
33785
+
33786
+ ```typescript
33787
+ public readonly biome: boolean;
33788
+ ```
33789
+
33790
+ - *Type:* boolean
33791
+ - *Default:* false
33792
+
33793
+ Setup Biome.
33794
+
33795
+ ---
33796
+
33797
+ ##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.biomeOptions"></a>
33798
+
33799
+ ```typescript
33800
+ public readonly biomeOptions: BiomeOptions;
33801
+ ```
33802
+
33803
+ - *Type:* projen.javascript.BiomeOptions
33804
+ - *Default:* default options
33805
+
33806
+ Biome options.
33807
+
33808
+ ---
33809
+
33247
33810
  ##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.bugsEmail"></a>
33248
33811
 
33249
33812
  ```typescript
@@ -33436,7 +33999,7 @@ public readonly codeCov: boolean;
33436
33999
  - *Type:* boolean
33437
34000
  - *Default:* false
33438
34001
 
33439
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
34002
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
33440
34003
 
33441
34004
  ---
33442
34005
 
@@ -33447,9 +34010,9 @@ public readonly codeCovTokenSecret: string;
33447
34010
  ```
33448
34011
 
33449
34012
  - *Type:* string
33450
- - *Default:* if this option is not specified, only public repositories are supported
34013
+ - *Default:* OIDC auth is used
33451
34014
 
33452
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
34015
+ Define the secret name for a specified https://codecov.io/ token.
33453
34016
 
33454
34017
  ---
33455
34018
 
@@ -34164,6 +34727,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
34164
34727
 
34165
34728
  ---
34166
34729
 
34730
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.npmTrustedPublishing"></a>
34731
+
34732
+ ```typescript
34733
+ public readonly npmTrustedPublishing: boolean;
34734
+ ```
34735
+
34736
+ - *Type:* boolean
34737
+ - *Default:* false
34738
+
34739
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
34740
+
34741
+ ---
34742
+
34167
34743
  ##### `nx`<sup>Optional</sup> <a name="nx" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.nx"></a>
34168
34744
 
34169
34745
  ```typescript
@@ -34614,6 +35190,25 @@ be provided for the default branch.
34614
35190
 
34615
35191
  ---
34616
35192
 
35193
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseEnvironment"></a>
35194
+
35195
+ ```typescript
35196
+ public readonly releaseEnvironment: string;
35197
+ ```
35198
+
35199
+ - *Type:* string
35200
+ - *Default:* no environment used, unless set at the artifact level
35201
+
35202
+ The GitHub Actions environment used for the release.
35203
+
35204
+ This can be used to add an explicit approval step to the release
35205
+ or limit who can initiate a release through environment protection rules.
35206
+
35207
+ When multiple artifacts are released, the environment can be overwritten
35208
+ on a per artifact basis.
35209
+
35210
+ ---
35211
+
34617
35212
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.yarn.MonorepoOptions.property.releaseEveryCommit"></a>
34618
35213
 
34619
35214
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
@@ -35183,6 +35778,7 @@ const monorepoReleaseOptions: yarn.MonorepoReleaseOptions = { ... }
35183
35778
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.publishDryRun">publishDryRun</a></code> | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command. |
35184
35779
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.publishToNpm">publishToNpm</a></code> | <code>boolean</code> | Publish packages to npm. |
35185
35780
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
35781
+ | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
35186
35782
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
35187
35783
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
35188
35784
  | <code><a href="#cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseWorkflowSetupSteps">releaseWorkflowSetupSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | A set of workflow steps to execute in order to setup the workflow container. |
@@ -35408,6 +36004,25 @@ Find commits that should be considered releasable Used to decide if a release is
35408
36004
 
35409
36005
  ---
35410
36006
 
36007
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseEnvironment"></a>
36008
+
36009
+ ```typescript
36010
+ public readonly releaseEnvironment: string;
36011
+ ```
36012
+
36013
+ - *Type:* string
36014
+ - *Default:* no environment used, unless set at the artifact level
36015
+
36016
+ The GitHub Actions environment used for the release.
36017
+
36018
+ This can be used to add an explicit approval step to the release
36019
+ or limit who can initiate a release through environment protection rules.
36020
+
36021
+ When multiple artifacts are released, the environment can be overwritten
36022
+ on a per artifact basis.
36023
+
36024
+ ---
36025
+
35411
36026
  ##### `releaseTrigger`<sup>Optional</sup> <a name="releaseTrigger" id="cdklabs-projen-project-types.yarn.MonorepoReleaseOptions.property.releaseTrigger"></a>
35412
36027
 
35413
36028
  ```typescript
@@ -35597,6 +36212,8 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
35597
36212
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.autoMerge">autoMerge</a></code> | <code>boolean</code> | Enable automatic merging on GitHub. |
35598
36213
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.autoMergeOptions">autoMergeOptions</a></code> | <code>projen.github.AutoMergeOptions</code> | Configure options for automatic merging on GitHub. |
35599
36214
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.bin">bin</a></code> | <code>{[ key: string ]: string}</code> | Binary programs vended with your module. |
36215
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
36216
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
35600
36217
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.bugsEmail">bugsEmail</a></code> | <code>string</code> | The email address to which issues should be reported. |
35601
36218
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.bugsUrl">bugsUrl</a></code> | <code>string</code> | The url to your project's issue tracker. |
35602
36219
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
@@ -35609,8 +36226,8 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
35609
36226
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
35610
36227
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.clobber">clobber</a></code> | <code>boolean</code> | Add a `clobber` task which resets the repo to origin. |
35611
36228
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeArtifactOptions">codeArtifactOptions</a></code> | <code>projen.javascript.CodeArtifactOptions</code> | Options for npm packages using AWS CodeArtifact. |
35612
- | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`. |
35613
- | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. |
36229
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCov">codeCov</a></code> | <code>boolean</code> | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`. |
36230
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
35614
36231
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.commitGenerated">commitGenerated</a></code> | <code>boolean</code> | Whether to commit the managed files by default. |
35615
36232
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
35616
36233
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
@@ -35662,6 +36279,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
35662
36279
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
35663
36280
  | <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. |
35664
36281
  | <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. |
36282
+ | <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. |
35665
36283
  | <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`). |
35666
36284
  | <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. |
35667
36285
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
@@ -35692,6 +36310,7 @@ const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... }
35692
36310
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
35693
36311
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
35694
36312
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
36313
+ | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
35695
36314
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
35696
36315
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
35697
36316
  | <code><a href="#cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
@@ -35926,6 +36545,32 @@ executable file under `bin` will automatically be added to this section.
35926
36545
 
35927
36546
  ---
35928
36547
 
36548
+ ##### `biome`<sup>Optional</sup> <a name="biome" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.biome"></a>
36549
+
36550
+ ```typescript
36551
+ public readonly biome: boolean;
36552
+ ```
36553
+
36554
+ - *Type:* boolean
36555
+ - *Default:* false
36556
+
36557
+ Setup Biome.
36558
+
36559
+ ---
36560
+
36561
+ ##### `biomeOptions`<sup>Optional</sup> <a name="biomeOptions" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.biomeOptions"></a>
36562
+
36563
+ ```typescript
36564
+ public readonly biomeOptions: BiomeOptions;
36565
+ ```
36566
+
36567
+ - *Type:* projen.javascript.BiomeOptions
36568
+ - *Default:* default options
36569
+
36570
+ Biome options.
36571
+
36572
+ ---
36573
+
35929
36574
  ##### `bugsEmail`<sup>Optional</sup> <a name="bugsEmail" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.bugsEmail"></a>
35930
36575
 
35931
36576
  ```typescript
@@ -36105,7 +36750,7 @@ public readonly codeCov: boolean;
36105
36750
  - *Type:* boolean
36106
36751
  - *Default:* false
36107
36752
 
36108
- Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
36753
+ Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
36109
36754
 
36110
36755
  ---
36111
36756
 
@@ -36116,9 +36761,9 @@ public readonly codeCovTokenSecret: string;
36116
36761
  ```
36117
36762
 
36118
36763
  - *Type:* string
36119
- - *Default:* if this option is not specified, only public repositories are supported
36764
+ - *Default:* OIDC auth is used
36120
36765
 
36121
- Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
36766
+ Define the secret name for a specified https://codecov.io/ token.
36122
36767
 
36123
36768
  ---
36124
36769
 
@@ -36361,7 +37006,7 @@ public readonly eslint: boolean;
36361
37006
  ```
36362
37007
 
36363
37008
  - *Type:* boolean
36364
- - *Default:* true
37009
+ - *Default:* true, unless biome is enabled
36365
37010
 
36366
37011
  Setup eslint.
36367
37012
 
@@ -36872,6 +37517,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
36872
37517
 
36873
37518
  ---
36874
37519
 
37520
+ ##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.npmTrustedPublishing"></a>
37521
+
37522
+ ```typescript
37523
+ public readonly npmTrustedPublishing: boolean;
37524
+ ```
37525
+
37526
+ - *Type:* boolean
37527
+ - *Default:* false
37528
+
37529
+ Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
37530
+
37531
+ ---
37532
+
36875
37533
  ##### `package`<sup>Optional</sup> <a name="package" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.package"></a>
36876
37534
 
36877
37535
  ```typescript
@@ -37293,6 +37951,25 @@ be provided for the default branch.
37293
37951
 
37294
37952
  ---
37295
37953
 
37954
+ ##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseEnvironment"></a>
37955
+
37956
+ ```typescript
37957
+ public readonly releaseEnvironment: string;
37958
+ ```
37959
+
37960
+ - *Type:* string
37961
+ - *Default:* no environment used, unless set at the artifact level
37962
+
37963
+ The GitHub Actions environment used for the release.
37964
+
37965
+ This can be used to add an explicit approval step to the release
37966
+ or limit who can initiate a release through environment protection rules.
37967
+
37968
+ When multiple artifacts are released, the environment can be overwritten
37969
+ on a per artifact basis.
37970
+
37971
+ ---
37972
+
37296
37973
  ##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions.property.releaseEveryCommit"></a>
37297
37974
 
37298
37975
  - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead