@taimos/projen 0.1.38 → 0.1.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +6 -5
- package/API.md +544 -52
- package/lib/projects/cdk-app.js +1 -1
- package/lib/projects/cdk-construct.js +3 -2
- package/lib/projects/private-cdk-app.js +1 -1
- package/lib/projects/private-ts-lib.js +1 -1
- package/lib/projects/prod-cdk-app.js +1 -1
- package/lib/projects/ts-lib.js +3 -2
- package/package.json +9 -9
package/API.md
CHANGED
|
@@ -9508,6 +9508,7 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
|
|
|
9508
9508
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
9509
9509
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
9510
9510
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
9511
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.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. |
|
|
9511
9512
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
9512
9513
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
9513
9514
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
@@ -9531,12 +9532,14 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
|
|
|
9531
9532
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
9532
9533
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
9533
9534
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
9535
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
9534
9536
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
9535
9537
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
9536
9538
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
9537
9539
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
9538
9540
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
|
|
9539
9541
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
9542
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
9540
9543
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
9541
9544
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.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. |
|
|
9542
9545
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -9545,6 +9548,8 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
|
|
|
9545
9548
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
9546
9549
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
9547
9550
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
9551
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
9552
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
9548
9553
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
|
|
9549
9554
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
9550
9555
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
@@ -9553,8 +9558,8 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
|
|
|
9553
9558
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
9554
9559
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
9555
9560
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
9556
|
-
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.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@
|
|
9557
|
-
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token
|
|
9561
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.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`. |
|
|
9562
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
9558
9563
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
9559
9564
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
9560
9565
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
@@ -9605,7 +9610,7 @@ const privateTaimosCdkAppOptions: PrivateTaimosCdkAppOptions = { ... }
|
|
|
9605
9610
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.buildCommand">buildCommand</a></code> | <code>string</code> | A command to execute before synthesis. |
|
|
9606
9611
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.cdkout">cdkout</a></code> | <code>string</code> | cdk.out directory. |
|
|
9607
9612
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.context">context</a></code> | <code>{[ key: string ]: any}</code> | Additional context to include in `cdk.json`. |
|
|
9608
|
-
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.featureFlags">featureFlags</a></code> | <code>
|
|
9613
|
+
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.featureFlags">featureFlags</a></code> | <code>projen.awscdk.ICdkFeatureFlags</code> | Feature flags that should be enabled in `cdk.json`. |
|
|
9609
9614
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.requireApproval">requireApproval</a></code> | <code>projen.awscdk.ApprovalLevel</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. |
|
|
9610
9615
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.watchExcludes">watchExcludes</a></code> | <code>string[]</code> | Glob patterns to exclude from `cdk watch`. |
|
|
9611
9616
|
| <code><a href="#@taimos/projen.PrivateTaimosCdkAppOptions.property.watchIncludes">watchIncludes</a></code> | <code>string[]</code> | Glob patterns to include in `cdk watch`. |
|
|
@@ -10474,6 +10479,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
10474
10479
|
|
|
10475
10480
|
---
|
|
10476
10481
|
|
|
10482
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.npmTrustedPublishing"></a>
|
|
10483
|
+
|
|
10484
|
+
```typescript
|
|
10485
|
+
public readonly npmTrustedPublishing: boolean;
|
|
10486
|
+
```
|
|
10487
|
+
|
|
10488
|
+
- *Type:* boolean
|
|
10489
|
+
- *Default:* false
|
|
10490
|
+
|
|
10491
|
+
Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
10492
|
+
|
|
10493
|
+
---
|
|
10494
|
+
|
|
10477
10495
|
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.packageManager"></a>
|
|
10478
10496
|
|
|
10479
10497
|
```typescript
|
|
@@ -10833,6 +10851,25 @@ be provided for the default branch.
|
|
|
10833
10851
|
|
|
10834
10852
|
---
|
|
10835
10853
|
|
|
10854
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseEnvironment"></a>
|
|
10855
|
+
|
|
10856
|
+
```typescript
|
|
10857
|
+
public readonly releaseEnvironment: string;
|
|
10858
|
+
```
|
|
10859
|
+
|
|
10860
|
+
- *Type:* string
|
|
10861
|
+
- *Default:* no environment used, unless set at the artifact level
|
|
10862
|
+
|
|
10863
|
+
The GitHub Actions environment used for the release.
|
|
10864
|
+
|
|
10865
|
+
This can be used to add an explicit approval step to the release
|
|
10866
|
+
or limit who can initiate a release through environment protection rules.
|
|
10867
|
+
|
|
10868
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
10869
|
+
on a per artifact basis.
|
|
10870
|
+
|
|
10871
|
+
---
|
|
10872
|
+
|
|
10836
10873
|
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseEveryCommit"></a>
|
|
10837
10874
|
|
|
10838
10875
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
@@ -10922,6 +10959,19 @@ The release trigger to use.
|
|
|
10922
10959
|
|
|
10923
10960
|
---
|
|
10924
10961
|
|
|
10962
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseWorkflowEnv"></a>
|
|
10963
|
+
|
|
10964
|
+
```typescript
|
|
10965
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
10966
|
+
```
|
|
10967
|
+
|
|
10968
|
+
- *Type:* {[ key: string ]: string}
|
|
10969
|
+
- *Default:* {}
|
|
10970
|
+
|
|
10971
|
+
Build environment variables for release workflows.
|
|
10972
|
+
|
|
10973
|
+
---
|
|
10974
|
+
|
|
10925
10975
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.releaseWorkflowName"></a>
|
|
10926
10976
|
|
|
10927
10977
|
```typescript
|
|
@@ -11026,6 +11076,36 @@ A directory which will contain build artifacts.
|
|
|
11026
11076
|
|
|
11027
11077
|
---
|
|
11028
11078
|
|
|
11079
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.auditDeps"></a>
|
|
11080
|
+
|
|
11081
|
+
```typescript
|
|
11082
|
+
public readonly auditDeps: boolean;
|
|
11083
|
+
```
|
|
11084
|
+
|
|
11085
|
+
- *Type:* boolean
|
|
11086
|
+
- *Default:* false
|
|
11087
|
+
|
|
11088
|
+
Run security audit on dependencies.
|
|
11089
|
+
|
|
11090
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
11091
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
11092
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
11093
|
+
|
|
11094
|
+
---
|
|
11095
|
+
|
|
11096
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.auditDepsOptions"></a>
|
|
11097
|
+
|
|
11098
|
+
```typescript
|
|
11099
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
11100
|
+
```
|
|
11101
|
+
|
|
11102
|
+
- *Type:* projen.javascript.AuditOptions
|
|
11103
|
+
- *Default:* default options
|
|
11104
|
+
|
|
11105
|
+
Security audit options.
|
|
11106
|
+
|
|
11107
|
+
---
|
|
11108
|
+
|
|
11029
11109
|
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.autoApproveUpgrades"></a>
|
|
11030
11110
|
|
|
11031
11111
|
```typescript
|
|
@@ -11143,7 +11223,7 @@ public readonly codeCov: boolean;
|
|
|
11143
11223
|
- *Type:* boolean
|
|
11144
11224
|
- *Default:* false
|
|
11145
11225
|
|
|
11146
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
11226
|
+
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`.
|
|
11147
11227
|
|
|
11148
11228
|
---
|
|
11149
11229
|
|
|
@@ -11154,9 +11234,9 @@ public readonly codeCovTokenSecret: string;
|
|
|
11154
11234
|
```
|
|
11155
11235
|
|
|
11156
11236
|
- *Type:* string
|
|
11157
|
-
- *Default:*
|
|
11237
|
+
- *Default:* OIDC auth is used
|
|
11158
11238
|
|
|
11159
|
-
Define the secret name for a specified https://codecov.io/ token
|
|
11239
|
+
Define the secret name for a specified https://codecov.io/ token.
|
|
11160
11240
|
|
|
11161
11241
|
---
|
|
11162
11242
|
|
|
@@ -11518,7 +11598,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
11518
11598
|
```
|
|
11519
11599
|
|
|
11520
11600
|
- *Type:* projen.github.GitIdentity
|
|
11521
|
-
- *Default:* GitHub Actions
|
|
11601
|
+
- *Default:* default GitHub Actions user
|
|
11522
11602
|
|
|
11523
11603
|
The git identity to use in workflows.
|
|
11524
11604
|
|
|
@@ -11838,13 +11918,17 @@ Additional context to include in `cdk.json`.
|
|
|
11838
11918
|
##### `featureFlags`<sup>Optional</sup> <a name="featureFlags" id="@taimos/projen.PrivateTaimosCdkAppOptions.property.featureFlags"></a>
|
|
11839
11919
|
|
|
11840
11920
|
```typescript
|
|
11841
|
-
public readonly featureFlags:
|
|
11921
|
+
public readonly featureFlags: ICdkFeatureFlags;
|
|
11842
11922
|
```
|
|
11843
11923
|
|
|
11844
|
-
- *Type:*
|
|
11845
|
-
- *Default:*
|
|
11924
|
+
- *Type:* projen.awscdk.ICdkFeatureFlags
|
|
11925
|
+
- *Default:* no feature flags are enabled by default
|
|
11846
11926
|
|
|
11847
|
-
|
|
11927
|
+
Feature flags that should be enabled in `cdk.json`.
|
|
11928
|
+
|
|
11929
|
+
Make sure to double-check any changes to feature flags in `cdk.json` before deploying.
|
|
11930
|
+
Unexpected changes may cause breaking changes in your CDK app.
|
|
11931
|
+
You can overwrite any feature flag by passing it into the context field.
|
|
11848
11932
|
|
|
11849
11933
|
---
|
|
11850
11934
|
|
|
@@ -12228,6 +12312,7 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
|
|
|
12228
12312
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
12229
12313
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
12230
12314
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
12315
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.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. |
|
|
12231
12316
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
12232
12317
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
12233
12318
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
@@ -12251,12 +12336,14 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
|
|
|
12251
12336
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
12252
12337
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
12253
12338
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
12339
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
12254
12340
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
12255
12341
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
12256
12342
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
12257
12343
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
12258
12344
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
|
|
12259
12345
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
12346
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
12260
12347
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
12261
12348
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.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. |
|
|
12262
12349
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -12265,6 +12352,8 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
|
|
|
12265
12352
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
12266
12353
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
12267
12354
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
12355
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
12356
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
12268
12357
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
|
|
12269
12358
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
12270
12359
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
@@ -12273,8 +12362,8 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
|
|
|
12273
12362
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
12274
12363
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
12275
12364
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
12276
|
-
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.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@
|
|
12277
|
-
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token
|
|
12365
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.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`. |
|
|
12366
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
12278
12367
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
12279
12368
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
12280
12369
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
@@ -12325,7 +12414,7 @@ const productionTaimosCdkAppOptions: ProductionTaimosCdkAppOptions = { ... }
|
|
|
12325
12414
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.buildCommand">buildCommand</a></code> | <code>string</code> | A command to execute before synthesis. |
|
|
12326
12415
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.cdkout">cdkout</a></code> | <code>string</code> | cdk.out directory. |
|
|
12327
12416
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.context">context</a></code> | <code>{[ key: string ]: any}</code> | Additional context to include in `cdk.json`. |
|
|
12328
|
-
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.featureFlags">featureFlags</a></code> | <code>
|
|
12417
|
+
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.featureFlags">featureFlags</a></code> | <code>projen.awscdk.ICdkFeatureFlags</code> | Feature flags that should be enabled in `cdk.json`. |
|
|
12329
12418
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.requireApproval">requireApproval</a></code> | <code>projen.awscdk.ApprovalLevel</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. |
|
|
12330
12419
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.watchExcludes">watchExcludes</a></code> | <code>string[]</code> | Glob patterns to exclude from `cdk watch`. |
|
|
12331
12420
|
| <code><a href="#@taimos/projen.ProductionTaimosCdkAppOptions.property.watchIncludes">watchIncludes</a></code> | <code>string[]</code> | Glob patterns to include in `cdk watch`. |
|
|
@@ -13198,6 +13287,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
13198
13287
|
|
|
13199
13288
|
---
|
|
13200
13289
|
|
|
13290
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.npmTrustedPublishing"></a>
|
|
13291
|
+
|
|
13292
|
+
```typescript
|
|
13293
|
+
public readonly npmTrustedPublishing: boolean;
|
|
13294
|
+
```
|
|
13295
|
+
|
|
13296
|
+
- *Type:* boolean
|
|
13297
|
+
- *Default:* false
|
|
13298
|
+
|
|
13299
|
+
Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
13300
|
+
|
|
13301
|
+
---
|
|
13302
|
+
|
|
13201
13303
|
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.packageManager"></a>
|
|
13202
13304
|
|
|
13203
13305
|
```typescript
|
|
@@ -13557,6 +13659,25 @@ be provided for the default branch.
|
|
|
13557
13659
|
|
|
13558
13660
|
---
|
|
13559
13661
|
|
|
13662
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseEnvironment"></a>
|
|
13663
|
+
|
|
13664
|
+
```typescript
|
|
13665
|
+
public readonly releaseEnvironment: string;
|
|
13666
|
+
```
|
|
13667
|
+
|
|
13668
|
+
- *Type:* string
|
|
13669
|
+
- *Default:* no environment used, unless set at the artifact level
|
|
13670
|
+
|
|
13671
|
+
The GitHub Actions environment used for the release.
|
|
13672
|
+
|
|
13673
|
+
This can be used to add an explicit approval step to the release
|
|
13674
|
+
or limit who can initiate a release through environment protection rules.
|
|
13675
|
+
|
|
13676
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
13677
|
+
on a per artifact basis.
|
|
13678
|
+
|
|
13679
|
+
---
|
|
13680
|
+
|
|
13560
13681
|
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseEveryCommit"></a>
|
|
13561
13682
|
|
|
13562
13683
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
@@ -13646,6 +13767,19 @@ The release trigger to use.
|
|
|
13646
13767
|
|
|
13647
13768
|
---
|
|
13648
13769
|
|
|
13770
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseWorkflowEnv"></a>
|
|
13771
|
+
|
|
13772
|
+
```typescript
|
|
13773
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
13774
|
+
```
|
|
13775
|
+
|
|
13776
|
+
- *Type:* {[ key: string ]: string}
|
|
13777
|
+
- *Default:* {}
|
|
13778
|
+
|
|
13779
|
+
Build environment variables for release workflows.
|
|
13780
|
+
|
|
13781
|
+
---
|
|
13782
|
+
|
|
13649
13783
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.releaseWorkflowName"></a>
|
|
13650
13784
|
|
|
13651
13785
|
```typescript
|
|
@@ -13750,6 +13884,36 @@ A directory which will contain build artifacts.
|
|
|
13750
13884
|
|
|
13751
13885
|
---
|
|
13752
13886
|
|
|
13887
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.auditDeps"></a>
|
|
13888
|
+
|
|
13889
|
+
```typescript
|
|
13890
|
+
public readonly auditDeps: boolean;
|
|
13891
|
+
```
|
|
13892
|
+
|
|
13893
|
+
- *Type:* boolean
|
|
13894
|
+
- *Default:* false
|
|
13895
|
+
|
|
13896
|
+
Run security audit on dependencies.
|
|
13897
|
+
|
|
13898
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
13899
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
13900
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
13901
|
+
|
|
13902
|
+
---
|
|
13903
|
+
|
|
13904
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.auditDepsOptions"></a>
|
|
13905
|
+
|
|
13906
|
+
```typescript
|
|
13907
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
13908
|
+
```
|
|
13909
|
+
|
|
13910
|
+
- *Type:* projen.javascript.AuditOptions
|
|
13911
|
+
- *Default:* default options
|
|
13912
|
+
|
|
13913
|
+
Security audit options.
|
|
13914
|
+
|
|
13915
|
+
---
|
|
13916
|
+
|
|
13753
13917
|
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.autoApproveUpgrades"></a>
|
|
13754
13918
|
|
|
13755
13919
|
```typescript
|
|
@@ -13867,7 +14031,7 @@ public readonly codeCov: boolean;
|
|
|
13867
14031
|
- *Type:* boolean
|
|
13868
14032
|
- *Default:* false
|
|
13869
14033
|
|
|
13870
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
14034
|
+
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`.
|
|
13871
14035
|
|
|
13872
14036
|
---
|
|
13873
14037
|
|
|
@@ -13878,9 +14042,9 @@ public readonly codeCovTokenSecret: string;
|
|
|
13878
14042
|
```
|
|
13879
14043
|
|
|
13880
14044
|
- *Type:* string
|
|
13881
|
-
- *Default:*
|
|
14045
|
+
- *Default:* OIDC auth is used
|
|
13882
14046
|
|
|
13883
|
-
Define the secret name for a specified https://codecov.io/ token
|
|
14047
|
+
Define the secret name for a specified https://codecov.io/ token.
|
|
13884
14048
|
|
|
13885
14049
|
---
|
|
13886
14050
|
|
|
@@ -14242,7 +14406,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
14242
14406
|
```
|
|
14243
14407
|
|
|
14244
14408
|
- *Type:* projen.github.GitIdentity
|
|
14245
|
-
- *Default:* GitHub Actions
|
|
14409
|
+
- *Default:* default GitHub Actions user
|
|
14246
14410
|
|
|
14247
14411
|
The git identity to use in workflows.
|
|
14248
14412
|
|
|
@@ -14562,13 +14726,17 @@ Additional context to include in `cdk.json`.
|
|
|
14562
14726
|
##### `featureFlags`<sup>Optional</sup> <a name="featureFlags" id="@taimos/projen.ProductionTaimosCdkAppOptions.property.featureFlags"></a>
|
|
14563
14727
|
|
|
14564
14728
|
```typescript
|
|
14565
|
-
public readonly featureFlags:
|
|
14729
|
+
public readonly featureFlags: ICdkFeatureFlags;
|
|
14566
14730
|
```
|
|
14567
14731
|
|
|
14568
|
-
- *Type:*
|
|
14569
|
-
- *Default:*
|
|
14732
|
+
- *Type:* projen.awscdk.ICdkFeatureFlags
|
|
14733
|
+
- *Default:* no feature flags are enabled by default
|
|
14570
14734
|
|
|
14571
|
-
|
|
14735
|
+
Feature flags that should be enabled in `cdk.json`.
|
|
14736
|
+
|
|
14737
|
+
Make sure to double-check any changes to feature flags in `cdk.json` before deploying.
|
|
14738
|
+
Unexpected changes may cause breaking changes in your CDK app.
|
|
14739
|
+
You can overwrite any feature flag by passing it into the context field.
|
|
14572
14740
|
|
|
14573
14741
|
---
|
|
14574
14742
|
|
|
@@ -15046,6 +15214,7 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
|
|
|
15046
15214
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
15047
15215
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
15048
15216
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
15217
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.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. |
|
|
15049
15218
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
15050
15219
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
15051
15220
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
@@ -15069,12 +15238,14 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
|
|
|
15069
15238
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
15070
15239
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
15071
15240
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
15241
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
15072
15242
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
15073
15243
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
15074
15244
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
15075
15245
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
15076
15246
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
|
|
15077
15247
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
15248
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
15078
15249
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
15079
15250
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.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. |
|
|
15080
15251
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -15083,6 +15254,8 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
|
|
|
15083
15254
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
15084
15255
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
15085
15256
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
15257
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
15258
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
15086
15259
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
|
|
15087
15260
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
15088
15261
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
@@ -15091,8 +15264,8 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
|
|
|
15091
15264
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
15092
15265
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
15093
15266
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
15094
|
-
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.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@
|
|
15095
|
-
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token
|
|
15267
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.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`. |
|
|
15268
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
15096
15269
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
15097
15270
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
15098
15271
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
@@ -15143,7 +15316,7 @@ const taimosCdkAppOptions: TaimosCdkAppOptions = { ... }
|
|
|
15143
15316
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.buildCommand">buildCommand</a></code> | <code>string</code> | A command to execute before synthesis. |
|
|
15144
15317
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.cdkout">cdkout</a></code> | <code>string</code> | cdk.out directory. |
|
|
15145
15318
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.context">context</a></code> | <code>{[ key: string ]: any}</code> | Additional context to include in `cdk.json`. |
|
|
15146
|
-
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.featureFlags">featureFlags</a></code> | <code>
|
|
15319
|
+
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.featureFlags">featureFlags</a></code> | <code>projen.awscdk.ICdkFeatureFlags</code> | Feature flags that should be enabled in `cdk.json`. |
|
|
15147
15320
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.requireApproval">requireApproval</a></code> | <code>projen.awscdk.ApprovalLevel</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. |
|
|
15148
15321
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.watchExcludes">watchExcludes</a></code> | <code>string[]</code> | Glob patterns to exclude from `cdk watch`. |
|
|
15149
15322
|
| <code><a href="#@taimos/projen.TaimosCdkAppOptions.property.watchIncludes">watchIncludes</a></code> | <code>string[]</code> | Glob patterns to include in `cdk watch`. |
|
|
@@ -16012,6 +16185,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
16012
16185
|
|
|
16013
16186
|
---
|
|
16014
16187
|
|
|
16188
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="@taimos/projen.TaimosCdkAppOptions.property.npmTrustedPublishing"></a>
|
|
16189
|
+
|
|
16190
|
+
```typescript
|
|
16191
|
+
public readonly npmTrustedPublishing: boolean;
|
|
16192
|
+
```
|
|
16193
|
+
|
|
16194
|
+
- *Type:* boolean
|
|
16195
|
+
- *Default:* false
|
|
16196
|
+
|
|
16197
|
+
Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
16198
|
+
|
|
16199
|
+
---
|
|
16200
|
+
|
|
16015
16201
|
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.TaimosCdkAppOptions.property.packageManager"></a>
|
|
16016
16202
|
|
|
16017
16203
|
```typescript
|
|
@@ -16371,6 +16557,25 @@ be provided for the default branch.
|
|
|
16371
16557
|
|
|
16372
16558
|
---
|
|
16373
16559
|
|
|
16560
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="@taimos/projen.TaimosCdkAppOptions.property.releaseEnvironment"></a>
|
|
16561
|
+
|
|
16562
|
+
```typescript
|
|
16563
|
+
public readonly releaseEnvironment: string;
|
|
16564
|
+
```
|
|
16565
|
+
|
|
16566
|
+
- *Type:* string
|
|
16567
|
+
- *Default:* no environment used, unless set at the artifact level
|
|
16568
|
+
|
|
16569
|
+
The GitHub Actions environment used for the release.
|
|
16570
|
+
|
|
16571
|
+
This can be used to add an explicit approval step to the release
|
|
16572
|
+
or limit who can initiate a release through environment protection rules.
|
|
16573
|
+
|
|
16574
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
16575
|
+
on a per artifact basis.
|
|
16576
|
+
|
|
16577
|
+
---
|
|
16578
|
+
|
|
16374
16579
|
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@taimos/projen.TaimosCdkAppOptions.property.releaseEveryCommit"></a>
|
|
16375
16580
|
|
|
16376
16581
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
@@ -16460,6 +16665,19 @@ The release trigger to use.
|
|
|
16460
16665
|
|
|
16461
16666
|
---
|
|
16462
16667
|
|
|
16668
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="@taimos/projen.TaimosCdkAppOptions.property.releaseWorkflowEnv"></a>
|
|
16669
|
+
|
|
16670
|
+
```typescript
|
|
16671
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
16672
|
+
```
|
|
16673
|
+
|
|
16674
|
+
- *Type:* {[ key: string ]: string}
|
|
16675
|
+
- *Default:* {}
|
|
16676
|
+
|
|
16677
|
+
Build environment variables for release workflows.
|
|
16678
|
+
|
|
16679
|
+
---
|
|
16680
|
+
|
|
16463
16681
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@taimos/projen.TaimosCdkAppOptions.property.releaseWorkflowName"></a>
|
|
16464
16682
|
|
|
16465
16683
|
```typescript
|
|
@@ -16564,6 +16782,36 @@ A directory which will contain build artifacts.
|
|
|
16564
16782
|
|
|
16565
16783
|
---
|
|
16566
16784
|
|
|
16785
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="@taimos/projen.TaimosCdkAppOptions.property.auditDeps"></a>
|
|
16786
|
+
|
|
16787
|
+
```typescript
|
|
16788
|
+
public readonly auditDeps: boolean;
|
|
16789
|
+
```
|
|
16790
|
+
|
|
16791
|
+
- *Type:* boolean
|
|
16792
|
+
- *Default:* false
|
|
16793
|
+
|
|
16794
|
+
Run security audit on dependencies.
|
|
16795
|
+
|
|
16796
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
16797
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
16798
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
16799
|
+
|
|
16800
|
+
---
|
|
16801
|
+
|
|
16802
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="@taimos/projen.TaimosCdkAppOptions.property.auditDepsOptions"></a>
|
|
16803
|
+
|
|
16804
|
+
```typescript
|
|
16805
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
16806
|
+
```
|
|
16807
|
+
|
|
16808
|
+
- *Type:* projen.javascript.AuditOptions
|
|
16809
|
+
- *Default:* default options
|
|
16810
|
+
|
|
16811
|
+
Security audit options.
|
|
16812
|
+
|
|
16813
|
+
---
|
|
16814
|
+
|
|
16567
16815
|
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@taimos/projen.TaimosCdkAppOptions.property.autoApproveUpgrades"></a>
|
|
16568
16816
|
|
|
16569
16817
|
```typescript
|
|
@@ -16681,7 +16929,7 @@ public readonly codeCov: boolean;
|
|
|
16681
16929
|
- *Type:* boolean
|
|
16682
16930
|
- *Default:* false
|
|
16683
16931
|
|
|
16684
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
16932
|
+
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`.
|
|
16685
16933
|
|
|
16686
16934
|
---
|
|
16687
16935
|
|
|
@@ -16692,9 +16940,9 @@ public readonly codeCovTokenSecret: string;
|
|
|
16692
16940
|
```
|
|
16693
16941
|
|
|
16694
16942
|
- *Type:* string
|
|
16695
|
-
- *Default:*
|
|
16943
|
+
- *Default:* OIDC auth is used
|
|
16696
16944
|
|
|
16697
|
-
Define the secret name for a specified https://codecov.io/ token
|
|
16945
|
+
Define the secret name for a specified https://codecov.io/ token.
|
|
16698
16946
|
|
|
16699
16947
|
---
|
|
16700
16948
|
|
|
@@ -17056,7 +17304,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
17056
17304
|
```
|
|
17057
17305
|
|
|
17058
17306
|
- *Type:* projen.github.GitIdentity
|
|
17059
|
-
- *Default:* GitHub Actions
|
|
17307
|
+
- *Default:* default GitHub Actions user
|
|
17060
17308
|
|
|
17061
17309
|
The git identity to use in workflows.
|
|
17062
17310
|
|
|
@@ -17376,13 +17624,17 @@ Additional context to include in `cdk.json`.
|
|
|
17376
17624
|
##### `featureFlags`<sup>Optional</sup> <a name="featureFlags" id="@taimos/projen.TaimosCdkAppOptions.property.featureFlags"></a>
|
|
17377
17625
|
|
|
17378
17626
|
```typescript
|
|
17379
|
-
public readonly featureFlags:
|
|
17627
|
+
public readonly featureFlags: ICdkFeatureFlags;
|
|
17380
17628
|
```
|
|
17381
17629
|
|
|
17382
|
-
- *Type:*
|
|
17383
|
-
- *Default:*
|
|
17630
|
+
- *Type:* projen.awscdk.ICdkFeatureFlags
|
|
17631
|
+
- *Default:* no feature flags are enabled by default
|
|
17384
17632
|
|
|
17385
|
-
|
|
17633
|
+
Feature flags that should be enabled in `cdk.json`.
|
|
17634
|
+
|
|
17635
|
+
Make sure to double-check any changes to feature flags in `cdk.json` before deploying.
|
|
17636
|
+
Unexpected changes may cause breaking changes in your CDK app.
|
|
17637
|
+
You can overwrite any feature flag by passing it into the context field.
|
|
17386
17638
|
|
|
17387
17639
|
---
|
|
17388
17640
|
|
|
@@ -17766,6 +18018,7 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
|
|
|
17766
18018
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
17767
18019
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
17768
18020
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
18021
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.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. |
|
|
17769
18022
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
17770
18023
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
17771
18024
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
@@ -17789,12 +18042,14 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
|
|
|
17789
18042
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
17790
18043
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
17791
18044
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
18045
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
17792
18046
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
17793
18047
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
17794
18048
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
17795
18049
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
17796
18050
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
|
|
17797
18051
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
18052
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
17798
18053
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
17799
18054
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.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. |
|
|
17800
18055
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -17803,6 +18058,8 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
|
|
|
17803
18058
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
17804
18059
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
17805
18060
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
18061
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
18062
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
17806
18063
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
|
|
17807
18064
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
17808
18065
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
@@ -17811,8 +18068,8 @@ const taimosCdkConstructLibraryOptions: TaimosCdkConstructLibraryOptions = { ...
|
|
|
17811
18068
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
17812
18069
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
17813
18070
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
17814
|
-
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.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@
|
|
17815
|
-
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token
|
|
18071
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.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`. |
|
|
18072
|
+
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
17816
18073
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
17817
18074
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
17818
18075
|
| <code><a href="#@taimos/projen.TaimosCdkConstructLibraryOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
@@ -18740,6 +18997,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
18740
18997
|
|
|
18741
18998
|
---
|
|
18742
18999
|
|
|
19000
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.npmTrustedPublishing"></a>
|
|
19001
|
+
|
|
19002
|
+
```typescript
|
|
19003
|
+
public readonly npmTrustedPublishing: boolean;
|
|
19004
|
+
```
|
|
19005
|
+
|
|
19006
|
+
- *Type:* boolean
|
|
19007
|
+
- *Default:* false
|
|
19008
|
+
|
|
19009
|
+
Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
19010
|
+
|
|
19011
|
+
---
|
|
19012
|
+
|
|
18743
19013
|
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.packageManager"></a>
|
|
18744
19014
|
|
|
18745
19015
|
```typescript
|
|
@@ -19099,6 +19369,25 @@ be provided for the default branch.
|
|
|
19099
19369
|
|
|
19100
19370
|
---
|
|
19101
19371
|
|
|
19372
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseEnvironment"></a>
|
|
19373
|
+
|
|
19374
|
+
```typescript
|
|
19375
|
+
public readonly releaseEnvironment: string;
|
|
19376
|
+
```
|
|
19377
|
+
|
|
19378
|
+
- *Type:* string
|
|
19379
|
+
- *Default:* no environment used, unless set at the artifact level
|
|
19380
|
+
|
|
19381
|
+
The GitHub Actions environment used for the release.
|
|
19382
|
+
|
|
19383
|
+
This can be used to add an explicit approval step to the release
|
|
19384
|
+
or limit who can initiate a release through environment protection rules.
|
|
19385
|
+
|
|
19386
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
19387
|
+
on a per artifact basis.
|
|
19388
|
+
|
|
19389
|
+
---
|
|
19390
|
+
|
|
19102
19391
|
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseEveryCommit"></a>
|
|
19103
19392
|
|
|
19104
19393
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
@@ -19188,6 +19477,19 @@ The release trigger to use.
|
|
|
19188
19477
|
|
|
19189
19478
|
---
|
|
19190
19479
|
|
|
19480
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseWorkflowEnv"></a>
|
|
19481
|
+
|
|
19482
|
+
```typescript
|
|
19483
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
19484
|
+
```
|
|
19485
|
+
|
|
19486
|
+
- *Type:* {[ key: string ]: string}
|
|
19487
|
+
- *Default:* {}
|
|
19488
|
+
|
|
19489
|
+
Build environment variables for release workflows.
|
|
19490
|
+
|
|
19491
|
+
---
|
|
19492
|
+
|
|
19191
19493
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.releaseWorkflowName"></a>
|
|
19192
19494
|
|
|
19193
19495
|
```typescript
|
|
@@ -19292,6 +19594,36 @@ A directory which will contain build artifacts.
|
|
|
19292
19594
|
|
|
19293
19595
|
---
|
|
19294
19596
|
|
|
19597
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.auditDeps"></a>
|
|
19598
|
+
|
|
19599
|
+
```typescript
|
|
19600
|
+
public readonly auditDeps: boolean;
|
|
19601
|
+
```
|
|
19602
|
+
|
|
19603
|
+
- *Type:* boolean
|
|
19604
|
+
- *Default:* false
|
|
19605
|
+
|
|
19606
|
+
Run security audit on dependencies.
|
|
19607
|
+
|
|
19608
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
19609
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
19610
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
19611
|
+
|
|
19612
|
+
---
|
|
19613
|
+
|
|
19614
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.auditDepsOptions"></a>
|
|
19615
|
+
|
|
19616
|
+
```typescript
|
|
19617
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
19618
|
+
```
|
|
19619
|
+
|
|
19620
|
+
- *Type:* projen.javascript.AuditOptions
|
|
19621
|
+
- *Default:* default options
|
|
19622
|
+
|
|
19623
|
+
Security audit options.
|
|
19624
|
+
|
|
19625
|
+
---
|
|
19626
|
+
|
|
19295
19627
|
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@taimos/projen.TaimosCdkConstructLibraryOptions.property.autoApproveUpgrades"></a>
|
|
19296
19628
|
|
|
19297
19629
|
```typescript
|
|
@@ -19409,7 +19741,7 @@ public readonly codeCov: boolean;
|
|
|
19409
19741
|
- *Type:* boolean
|
|
19410
19742
|
- *Default:* false
|
|
19411
19743
|
|
|
19412
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
19744
|
+
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`.
|
|
19413
19745
|
|
|
19414
19746
|
---
|
|
19415
19747
|
|
|
@@ -19420,9 +19752,9 @@ public readonly codeCovTokenSecret: string;
|
|
|
19420
19752
|
```
|
|
19421
19753
|
|
|
19422
19754
|
- *Type:* string
|
|
19423
|
-
- *Default:*
|
|
19755
|
+
- *Default:* OIDC auth is used
|
|
19424
19756
|
|
|
19425
|
-
Define the secret name for a specified https://codecov.io/ token
|
|
19757
|
+
Define the secret name for a specified https://codecov.io/ token.
|
|
19426
19758
|
|
|
19427
19759
|
---
|
|
19428
19760
|
|
|
@@ -19784,7 +20116,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
19784
20116
|
```
|
|
19785
20117
|
|
|
19786
20118
|
- *Type:* projen.github.GitIdentity
|
|
19787
|
-
- *Default:* GitHub Actions
|
|
20119
|
+
- *Default:* default GitHub Actions user
|
|
19788
20120
|
|
|
19789
20121
|
The git identity to use in workflows.
|
|
19790
20122
|
|
|
@@ -20189,7 +20521,7 @@ public readonly jsiiVersion: string;
|
|
|
20189
20521
|
```
|
|
20190
20522
|
|
|
20191
20523
|
- *Type:* string
|
|
20192
|
-
- *Default:* "~5.
|
|
20524
|
+
- *Default:* "~5.8.0"
|
|
20193
20525
|
|
|
20194
20526
|
Version of the jsii compiler to use.
|
|
20195
20527
|
|
|
@@ -20617,6 +20949,7 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
|
|
|
20617
20949
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
20618
20950
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
20619
20951
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
20952
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.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. |
|
|
20620
20953
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
20621
20954
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
20622
20955
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
@@ -20640,12 +20973,14 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
|
|
|
20640
20973
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
20641
20974
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
20642
20975
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
20976
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
20643
20977
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
20644
20978
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
20645
20979
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
20646
20980
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
20647
20981
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
|
|
20648
20982
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
20983
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
20649
20984
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
20650
20985
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.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. |
|
|
20651
20986
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -20654,6 +20989,8 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
|
|
|
20654
20989
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
20655
20990
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
20656
20991
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
20992
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
20993
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
20657
20994
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
|
|
20658
20995
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
20659
20996
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
@@ -20662,8 +20999,8 @@ const taimosPrivateTypescriptLibraryOptions: TaimosPrivateTypescriptLibraryOptio
|
|
|
20662
20999
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
20663
21000
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
20664
21001
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
20665
|
-
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.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@
|
|
20666
|
-
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token
|
|
21002
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.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`. |
|
|
21003
|
+
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
20667
21004
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
20668
21005
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
20669
21006
|
| <code><a href="#@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
@@ -21559,6 +21896,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
21559
21896
|
|
|
21560
21897
|
---
|
|
21561
21898
|
|
|
21899
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.npmTrustedPublishing"></a>
|
|
21900
|
+
|
|
21901
|
+
```typescript
|
|
21902
|
+
public readonly npmTrustedPublishing: boolean;
|
|
21903
|
+
```
|
|
21904
|
+
|
|
21905
|
+
- *Type:* boolean
|
|
21906
|
+
- *Default:* false
|
|
21907
|
+
|
|
21908
|
+
Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
21909
|
+
|
|
21910
|
+
---
|
|
21911
|
+
|
|
21562
21912
|
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.packageManager"></a>
|
|
21563
21913
|
|
|
21564
21914
|
```typescript
|
|
@@ -21918,6 +22268,25 @@ be provided for the default branch.
|
|
|
21918
22268
|
|
|
21919
22269
|
---
|
|
21920
22270
|
|
|
22271
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseEnvironment"></a>
|
|
22272
|
+
|
|
22273
|
+
```typescript
|
|
22274
|
+
public readonly releaseEnvironment: string;
|
|
22275
|
+
```
|
|
22276
|
+
|
|
22277
|
+
- *Type:* string
|
|
22278
|
+
- *Default:* no environment used, unless set at the artifact level
|
|
22279
|
+
|
|
22280
|
+
The GitHub Actions environment used for the release.
|
|
22281
|
+
|
|
22282
|
+
This can be used to add an explicit approval step to the release
|
|
22283
|
+
or limit who can initiate a release through environment protection rules.
|
|
22284
|
+
|
|
22285
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
22286
|
+
on a per artifact basis.
|
|
22287
|
+
|
|
22288
|
+
---
|
|
22289
|
+
|
|
21921
22290
|
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseEveryCommit"></a>
|
|
21922
22291
|
|
|
21923
22292
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
@@ -22007,6 +22376,19 @@ The release trigger to use.
|
|
|
22007
22376
|
|
|
22008
22377
|
---
|
|
22009
22378
|
|
|
22379
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseWorkflowEnv"></a>
|
|
22380
|
+
|
|
22381
|
+
```typescript
|
|
22382
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
22383
|
+
```
|
|
22384
|
+
|
|
22385
|
+
- *Type:* {[ key: string ]: string}
|
|
22386
|
+
- *Default:* {}
|
|
22387
|
+
|
|
22388
|
+
Build environment variables for release workflows.
|
|
22389
|
+
|
|
22390
|
+
---
|
|
22391
|
+
|
|
22010
22392
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.releaseWorkflowName"></a>
|
|
22011
22393
|
|
|
22012
22394
|
```typescript
|
|
@@ -22111,6 +22493,36 @@ A directory which will contain build artifacts.
|
|
|
22111
22493
|
|
|
22112
22494
|
---
|
|
22113
22495
|
|
|
22496
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.auditDeps"></a>
|
|
22497
|
+
|
|
22498
|
+
```typescript
|
|
22499
|
+
public readonly auditDeps: boolean;
|
|
22500
|
+
```
|
|
22501
|
+
|
|
22502
|
+
- *Type:* boolean
|
|
22503
|
+
- *Default:* false
|
|
22504
|
+
|
|
22505
|
+
Run security audit on dependencies.
|
|
22506
|
+
|
|
22507
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
22508
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
22509
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
22510
|
+
|
|
22511
|
+
---
|
|
22512
|
+
|
|
22513
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.auditDepsOptions"></a>
|
|
22514
|
+
|
|
22515
|
+
```typescript
|
|
22516
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
22517
|
+
```
|
|
22518
|
+
|
|
22519
|
+
- *Type:* projen.javascript.AuditOptions
|
|
22520
|
+
- *Default:* default options
|
|
22521
|
+
|
|
22522
|
+
Security audit options.
|
|
22523
|
+
|
|
22524
|
+
---
|
|
22525
|
+
|
|
22114
22526
|
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@taimos/projen.TaimosPrivateTypescriptLibraryOptions.property.autoApproveUpgrades"></a>
|
|
22115
22527
|
|
|
22116
22528
|
```typescript
|
|
@@ -22228,7 +22640,7 @@ public readonly codeCov: boolean;
|
|
|
22228
22640
|
- *Type:* boolean
|
|
22229
22641
|
- *Default:* false
|
|
22230
22642
|
|
|
22231
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
22643
|
+
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`.
|
|
22232
22644
|
|
|
22233
22645
|
---
|
|
22234
22646
|
|
|
@@ -22239,9 +22651,9 @@ public readonly codeCovTokenSecret: string;
|
|
|
22239
22651
|
```
|
|
22240
22652
|
|
|
22241
22653
|
- *Type:* string
|
|
22242
|
-
- *Default:*
|
|
22654
|
+
- *Default:* OIDC auth is used
|
|
22243
22655
|
|
|
22244
|
-
Define the secret name for a specified https://codecov.io/ token
|
|
22656
|
+
Define the secret name for a specified https://codecov.io/ token.
|
|
22245
22657
|
|
|
22246
22658
|
---
|
|
22247
22659
|
|
|
@@ -22603,7 +23015,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
22603
23015
|
```
|
|
22604
23016
|
|
|
22605
23017
|
- *Type:* projen.github.GitIdentity
|
|
22606
|
-
- *Default:* GitHub Actions
|
|
23018
|
+
- *Default:* default GitHub Actions user
|
|
22607
23019
|
|
|
22608
23020
|
The git identity to use in workflows.
|
|
22609
23021
|
|
|
@@ -22973,6 +23385,7 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
|
|
|
22973
23385
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
22974
23386
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
22975
23387
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
23388
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.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. |
|
|
22976
23389
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The Node Package Manager used to execute scripts. |
|
|
22977
23390
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.packageName">packageName</a></code> | <code>string</code> | The "name" in package.json. |
|
|
22978
23391
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.peerDependencyOptions">peerDependencyOptions</a></code> | <code>projen.javascript.PeerDependencyOptions</code> | Options for `peerDeps`. |
|
|
@@ -22996,12 +23409,14 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
|
|
|
22996
23409
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.publishTasks">publishTasks</a></code> | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows. |
|
|
22997
23410
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
22998
23411
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
23412
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
22999
23413
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
23000
23414
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
23001
23415
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
23002
23416
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
23003
23417
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseTagPrefix">releaseTagPrefix</a></code> | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. |
|
|
23004
23418
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
23419
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
23005
23420
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseWorkflowName">releaseWorkflowName</a></code> | <code>string</code> | The name of the default release workflow. |
|
|
23006
23421
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.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. |
|
|
23007
23422
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.versionrcOptions">versionrcOptions</a></code> | <code>{[ key: string ]: any}</code> | Custom configuration used when creating changelog with commit-and-tag-version package. |
|
|
@@ -23010,6 +23425,8 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
|
|
|
23010
23425
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
23011
23426
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
23012
23427
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
23428
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
23429
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
23013
23430
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.autoApproveUpgrades">autoApproveUpgrades</a></code> | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). |
|
|
23014
23431
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.biome">biome</a></code> | <code>boolean</code> | Setup Biome. |
|
|
23015
23432
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
@@ -23018,8 +23435,8 @@ const taimosTypescriptLibraryOptions: TaimosTypescriptLibraryOptions = { ... }
|
|
|
23018
23435
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
23019
23436
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
23020
23437
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
23021
|
-
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.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@
|
|
23022
|
-
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token
|
|
23438
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.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`. |
|
|
23439
|
+
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
23023
23440
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
23024
23441
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
23025
23442
|
| <code><a href="#@taimos/projen.TaimosTypescriptLibraryOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
@@ -23915,6 +24332,19 @@ GitHub secret which contains the NPM token to use when publishing packages.
|
|
|
23915
24332
|
|
|
23916
24333
|
---
|
|
23917
24334
|
|
|
24335
|
+
##### `npmTrustedPublishing`<sup>Optional</sup> <a name="npmTrustedPublishing" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.npmTrustedPublishing"></a>
|
|
24336
|
+
|
|
24337
|
+
```typescript
|
|
24338
|
+
public readonly npmTrustedPublishing: boolean;
|
|
24339
|
+
```
|
|
24340
|
+
|
|
24341
|
+
- *Type:* boolean
|
|
24342
|
+
- *Default:* false
|
|
24343
|
+
|
|
24344
|
+
Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
|
|
24345
|
+
|
|
24346
|
+
---
|
|
24347
|
+
|
|
23918
24348
|
##### `packageManager`<sup>Optional</sup> <a name="packageManager" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.packageManager"></a>
|
|
23919
24349
|
|
|
23920
24350
|
```typescript
|
|
@@ -24274,6 +24704,25 @@ be provided for the default branch.
|
|
|
24274
24704
|
|
|
24275
24705
|
---
|
|
24276
24706
|
|
|
24707
|
+
##### `releaseEnvironment`<sup>Optional</sup> <a name="releaseEnvironment" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseEnvironment"></a>
|
|
24708
|
+
|
|
24709
|
+
```typescript
|
|
24710
|
+
public readonly releaseEnvironment: string;
|
|
24711
|
+
```
|
|
24712
|
+
|
|
24713
|
+
- *Type:* string
|
|
24714
|
+
- *Default:* no environment used, unless set at the artifact level
|
|
24715
|
+
|
|
24716
|
+
The GitHub Actions environment used for the release.
|
|
24717
|
+
|
|
24718
|
+
This can be used to add an explicit approval step to the release
|
|
24719
|
+
or limit who can initiate a release through environment protection rules.
|
|
24720
|
+
|
|
24721
|
+
When multiple artifacts are released, the environment can be overwritten
|
|
24722
|
+
on a per artifact basis.
|
|
24723
|
+
|
|
24724
|
+
---
|
|
24725
|
+
|
|
24277
24726
|
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseEveryCommit"></a>
|
|
24278
24727
|
|
|
24279
24728
|
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
@@ -24363,6 +24812,19 @@ The release trigger to use.
|
|
|
24363
24812
|
|
|
24364
24813
|
---
|
|
24365
24814
|
|
|
24815
|
+
##### `releaseWorkflowEnv`<sup>Optional</sup> <a name="releaseWorkflowEnv" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseWorkflowEnv"></a>
|
|
24816
|
+
|
|
24817
|
+
```typescript
|
|
24818
|
+
public readonly releaseWorkflowEnv: {[ key: string ]: string};
|
|
24819
|
+
```
|
|
24820
|
+
|
|
24821
|
+
- *Type:* {[ key: string ]: string}
|
|
24822
|
+
- *Default:* {}
|
|
24823
|
+
|
|
24824
|
+
Build environment variables for release workflows.
|
|
24825
|
+
|
|
24826
|
+
---
|
|
24827
|
+
|
|
24366
24828
|
##### `releaseWorkflowName`<sup>Optional</sup> <a name="releaseWorkflowName" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.releaseWorkflowName"></a>
|
|
24367
24829
|
|
|
24368
24830
|
```typescript
|
|
@@ -24467,6 +24929,36 @@ A directory which will contain build artifacts.
|
|
|
24467
24929
|
|
|
24468
24930
|
---
|
|
24469
24931
|
|
|
24932
|
+
##### `auditDeps`<sup>Optional</sup> <a name="auditDeps" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.auditDeps"></a>
|
|
24933
|
+
|
|
24934
|
+
```typescript
|
|
24935
|
+
public readonly auditDeps: boolean;
|
|
24936
|
+
```
|
|
24937
|
+
|
|
24938
|
+
- *Type:* boolean
|
|
24939
|
+
- *Default:* false
|
|
24940
|
+
|
|
24941
|
+
Run security audit on dependencies.
|
|
24942
|
+
|
|
24943
|
+
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
24944
|
+
in dependencies. By default, runs during every build and checks for "high" severity
|
|
24945
|
+
vulnerabilities or above in all dependencies (including dev dependencies).
|
|
24946
|
+
|
|
24947
|
+
---
|
|
24948
|
+
|
|
24949
|
+
##### `auditDepsOptions`<sup>Optional</sup> <a name="auditDepsOptions" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.auditDepsOptions"></a>
|
|
24950
|
+
|
|
24951
|
+
```typescript
|
|
24952
|
+
public readonly auditDepsOptions: AuditOptions;
|
|
24953
|
+
```
|
|
24954
|
+
|
|
24955
|
+
- *Type:* projen.javascript.AuditOptions
|
|
24956
|
+
- *Default:* default options
|
|
24957
|
+
|
|
24958
|
+
Security audit options.
|
|
24959
|
+
|
|
24960
|
+
---
|
|
24961
|
+
|
|
24470
24962
|
##### `autoApproveUpgrades`<sup>Optional</sup> <a name="autoApproveUpgrades" id="@taimos/projen.TaimosTypescriptLibraryOptions.property.autoApproveUpgrades"></a>
|
|
24471
24963
|
|
|
24472
24964
|
```typescript
|
|
@@ -24584,7 +25076,7 @@ public readonly codeCov: boolean;
|
|
|
24584
25076
|
- *Type:* boolean
|
|
24585
25077
|
- *Default:* false
|
|
24586
25078
|
|
|
24587
|
-
Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@
|
|
25079
|
+
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`.
|
|
24588
25080
|
|
|
24589
25081
|
---
|
|
24590
25082
|
|
|
@@ -24595,9 +25087,9 @@ public readonly codeCovTokenSecret: string;
|
|
|
24595
25087
|
```
|
|
24596
25088
|
|
|
24597
25089
|
- *Type:* string
|
|
24598
|
-
- *Default:*
|
|
25090
|
+
- *Default:* OIDC auth is used
|
|
24599
25091
|
|
|
24600
|
-
Define the secret name for a specified https://codecov.io/ token
|
|
25092
|
+
Define the secret name for a specified https://codecov.io/ token.
|
|
24601
25093
|
|
|
24602
25094
|
---
|
|
24603
25095
|
|
|
@@ -24959,7 +25451,7 @@ public readonly workflowGitIdentity: GitIdentity;
|
|
|
24959
25451
|
```
|
|
24960
25452
|
|
|
24961
25453
|
- *Type:* projen.github.GitIdentity
|
|
24962
|
-
- *Default:* GitHub Actions
|
|
25454
|
+
- *Default:* default GitHub Actions user
|
|
24963
25455
|
|
|
24964
25456
|
The git identity to use in workflows.
|
|
24965
25457
|
|