@cdk8s/projen-common 0.0.720 → 0.1.1
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 +15 -15
- package/API.md +66 -1165
- package/lib/components/code-of-conduct/code-of-conduct.js +36 -3
- package/lib/components/dco/devco.js +36 -3
- package/lib/components/git-hooks/git-hooks.js +36 -3
- package/lib/components/issue-templates/issue-templates.js +36 -3
- package/lib/components/security/security.js +36 -3
- package/lib/components/triage/triage.js +2 -4
- package/lib/projects/jsii.js +41 -10
- package/lib/projects/node.d.ts +1 -1
- package/lib/projects/node.js +37 -10
- package/lib/projects/typescript.js +38 -7
- package/package.json +20 -20
package/API.md
CHANGED
|
@@ -34,7 +34,6 @@ new Cdk8sTeamJsiiProject(options: Cdk8sTeamJsiiProjectOptions)
|
|
|
34
34
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
35
35
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
36
36
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
37
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
38
37
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
39
38
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
40
39
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
@@ -42,20 +41,16 @@ new Cdk8sTeamJsiiProject(options: Cdk8sTeamJsiiProjectOptions)
|
|
|
42
41
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
43
42
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
44
43
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
45
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
46
44
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
47
45
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
48
46
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addBins">addBins</a></code> | *No description.* |
|
|
49
47
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
50
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
51
48
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
52
49
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
53
50
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
54
51
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
55
52
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
56
53
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
57
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
58
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
59
54
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
60
55
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
61
56
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
@@ -169,22 +164,6 @@ Task properties.
|
|
|
169
164
|
|
|
170
165
|
---
|
|
171
166
|
|
|
172
|
-
##### ~~`addTip`~~ <a name="addTip" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.addTip"></a>
|
|
173
|
-
|
|
174
|
-
```typescript
|
|
175
|
-
public addTip(message: string): void
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
Prints a "tip" message during synthesis.
|
|
179
|
-
|
|
180
|
-
###### `message`<sup>Required</sup> <a name="message" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.addTip.parameter.message"></a>
|
|
181
|
-
|
|
182
|
-
- *Type:* string
|
|
183
|
-
|
|
184
|
-
The message.
|
|
185
|
-
|
|
186
|
-
---
|
|
187
|
-
|
|
188
167
|
##### `annotateGenerated` <a name="annotateGenerated" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.annotateGenerated"></a>
|
|
189
168
|
|
|
190
169
|
```typescript
|
|
@@ -294,22 +273,6 @@ from the root of _this_ project.
|
|
|
294
273
|
|
|
295
274
|
---
|
|
296
275
|
|
|
297
|
-
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.tryFindJsonFile"></a>
|
|
298
|
-
|
|
299
|
-
```typescript
|
|
300
|
-
public tryFindJsonFile(filePath: string): JsonFile
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
Finds a json file by name.
|
|
304
|
-
|
|
305
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.tryFindJsonFile.parameter.filePath"></a>
|
|
306
|
-
|
|
307
|
-
- *Type:* string
|
|
308
|
-
|
|
309
|
-
The file path.
|
|
310
|
-
|
|
311
|
-
---
|
|
312
|
-
|
|
313
276
|
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.tryFindObjectFile"></a>
|
|
314
277
|
|
|
315
278
|
```typescript
|
|
@@ -382,20 +345,6 @@ add/update`. If you wish to specify a version range use this syntax:
|
|
|
382
345
|
|
|
383
346
|
---
|
|
384
347
|
|
|
385
|
-
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.addCompileCommand"></a>
|
|
386
|
-
|
|
387
|
-
```typescript
|
|
388
|
-
public addCompileCommand(commands: ...string[]): void
|
|
389
|
-
```
|
|
390
|
-
|
|
391
|
-
DEPRECATED.
|
|
392
|
-
|
|
393
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.addCompileCommand.parameter.commands"></a>
|
|
394
|
-
|
|
395
|
-
- *Type:* ...string[]
|
|
396
|
-
|
|
397
|
-
---
|
|
398
|
-
|
|
399
348
|
##### `addDeps` <a name="addDeps" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.addDeps"></a>
|
|
400
349
|
|
|
401
350
|
```typescript
|
|
@@ -514,36 +463,6 @@ The scripts to set.
|
|
|
514
463
|
|
|
515
464
|
---
|
|
516
465
|
|
|
517
|
-
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.addTestCommand"></a>
|
|
518
|
-
|
|
519
|
-
```typescript
|
|
520
|
-
public addTestCommand(commands: ...string[]): void
|
|
521
|
-
```
|
|
522
|
-
|
|
523
|
-
DEPRECATED.
|
|
524
|
-
|
|
525
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.addTestCommand.parameter.commands"></a>
|
|
526
|
-
|
|
527
|
-
- *Type:* ...string[]
|
|
528
|
-
|
|
529
|
-
---
|
|
530
|
-
|
|
531
|
-
##### ~~`hasScript`~~ <a name="hasScript" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.hasScript"></a>
|
|
532
|
-
|
|
533
|
-
```typescript
|
|
534
|
-
public hasScript(name: string): boolean
|
|
535
|
-
```
|
|
536
|
-
|
|
537
|
-
Indicates if a script by the name name is defined.
|
|
538
|
-
|
|
539
|
-
###### `name`<sup>Required</sup> <a name="name" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.hasScript.parameter.name"></a>
|
|
540
|
-
|
|
541
|
-
- *Type:* string
|
|
542
|
-
|
|
543
|
-
The name of the script.
|
|
544
|
-
|
|
545
|
-
---
|
|
546
|
-
|
|
547
466
|
##### `removeScript` <a name="removeScript" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.removeScript"></a>
|
|
548
467
|
|
|
549
468
|
```typescript
|
|
@@ -705,21 +624,16 @@ When given a project, this it the project itself.
|
|
|
705
624
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
706
625
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
707
626
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
708
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
709
627
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
710
628
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
711
629
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
712
630
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
713
631
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
714
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
715
632
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
716
633
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
717
634
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
718
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
719
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
720
635
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
721
636
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
722
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
723
637
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
|
724
638
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
725
639
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
@@ -730,7 +644,6 @@ When given a project, this it the project itself.
|
|
|
730
644
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
731
645
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
732
646
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
733
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
734
647
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
735
648
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
736
649
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
@@ -1043,16 +956,6 @@ If undefined, this is the root project.
|
|
|
1043
956
|
|
|
1044
957
|
---
|
|
1045
958
|
|
|
1046
|
-
##### `projectType`<sup>Required</sup> <a name="projectType" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.projectType"></a>
|
|
1047
|
-
|
|
1048
|
-
```typescript
|
|
1049
|
-
public readonly projectType: ProjectType;
|
|
1050
|
-
```
|
|
1051
|
-
|
|
1052
|
-
- *Type:* projen.ProjectType
|
|
1053
|
-
|
|
1054
|
-
---
|
|
1055
|
-
|
|
1056
959
|
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.autoApprove"></a>
|
|
1057
960
|
|
|
1058
961
|
```typescript
|
|
@@ -1121,18 +1024,6 @@ This will be `undefined` for subprojects.
|
|
|
1121
1024
|
|
|
1122
1025
|
---
|
|
1123
1026
|
|
|
1124
|
-
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.allowLibraryDependencies"></a>
|
|
1125
|
-
|
|
1126
|
-
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
1127
|
-
|
|
1128
|
-
```typescript
|
|
1129
|
-
public readonly allowLibraryDependencies: boolean;
|
|
1130
|
-
```
|
|
1131
|
-
|
|
1132
|
-
- *Type:* boolean
|
|
1133
|
-
|
|
1134
|
-
---
|
|
1135
|
-
|
|
1136
1027
|
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.artifactsDirectory"></a>
|
|
1137
1028
|
|
|
1138
1029
|
```typescript
|
|
@@ -1171,30 +1062,6 @@ public readonly bundler: Bundler;
|
|
|
1171
1062
|
|
|
1172
1063
|
---
|
|
1173
1064
|
|
|
1174
|
-
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.entrypoint"></a>
|
|
1175
|
-
|
|
1176
|
-
- *Deprecated:* use `package.entrypoint`
|
|
1177
|
-
|
|
1178
|
-
```typescript
|
|
1179
|
-
public readonly entrypoint: string;
|
|
1180
|
-
```
|
|
1181
|
-
|
|
1182
|
-
- *Type:* string
|
|
1183
|
-
|
|
1184
|
-
---
|
|
1185
|
-
|
|
1186
|
-
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.manifest"></a>
|
|
1187
|
-
|
|
1188
|
-
- *Deprecated:* use `package.addField(x, y)`
|
|
1189
|
-
|
|
1190
|
-
```typescript
|
|
1191
|
-
public readonly manifest: any;
|
|
1192
|
-
```
|
|
1193
|
-
|
|
1194
|
-
- *Type:* any
|
|
1195
|
-
|
|
1196
|
-
---
|
|
1197
|
-
|
|
1198
1065
|
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.npmrc"></a>
|
|
1199
1066
|
|
|
1200
1067
|
```typescript
|
|
@@ -1219,20 +1086,6 @@ API for managing the node package.
|
|
|
1219
1086
|
|
|
1220
1087
|
---
|
|
1221
1088
|
|
|
1222
|
-
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.packageManager"></a>
|
|
1223
|
-
|
|
1224
|
-
- *Deprecated:* use `package.packageManager`
|
|
1225
|
-
|
|
1226
|
-
```typescript
|
|
1227
|
-
public readonly packageManager: NodePackageManager;
|
|
1228
|
-
```
|
|
1229
|
-
|
|
1230
|
-
- *Type:* projen.javascript.NodePackageManager
|
|
1231
|
-
|
|
1232
|
-
The package manager to use.
|
|
1233
|
-
|
|
1234
|
-
---
|
|
1235
|
-
|
|
1236
1089
|
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.runScriptCommand"></a>
|
|
1237
1090
|
|
|
1238
1091
|
```typescript
|
|
@@ -1355,23 +1208,6 @@ public readonly prettier: Prettier;
|
|
|
1355
1208
|
|
|
1356
1209
|
---
|
|
1357
1210
|
|
|
1358
|
-
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.publisher"></a>
|
|
1359
|
-
|
|
1360
|
-
- *Deprecated:* use `release.publisher`.
|
|
1361
|
-
|
|
1362
|
-
```typescript
|
|
1363
|
-
public readonly publisher: Publisher;
|
|
1364
|
-
```
|
|
1365
|
-
|
|
1366
|
-
- *Type:* projen.release.Publisher
|
|
1367
|
-
|
|
1368
|
-
Package publisher.
|
|
1369
|
-
|
|
1370
|
-
This will be `undefined` if the project does not have a
|
|
1371
|
-
release workflow.
|
|
1372
|
-
|
|
1373
|
-
---
|
|
1374
|
-
|
|
1375
1211
|
##### `release`<sup>Optional</sup> <a name="release" id="@cdk8s/projen-common.Cdk8sTeamJsiiProject.property.release"></a>
|
|
1376
1212
|
|
|
1377
1213
|
```typescript
|
|
@@ -1572,7 +1408,6 @@ new Cdk8sTeamNodeProject(options: Cdk8sTeamNodeProjectOptions)
|
|
|
1572
1408
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
1573
1409
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
1574
1410
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
1575
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
1576
1411
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
1577
1412
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
1578
1413
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
@@ -1580,20 +1415,16 @@ new Cdk8sTeamNodeProject(options: Cdk8sTeamNodeProjectOptions)
|
|
|
1580
1415
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
1581
1416
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
1582
1417
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
1583
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
1584
1418
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
1585
1419
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
1586
1420
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addBins">addBins</a></code> | *No description.* |
|
|
1587
1421
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
1588
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
1589
1422
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
1590
1423
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
1591
1424
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
1592
1425
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
1593
1426
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
1594
1427
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
1595
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
1596
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
1597
1428
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
1598
1429
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
1599
1430
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
@@ -1707,22 +1538,6 @@ Task properties.
|
|
|
1707
1538
|
|
|
1708
1539
|
---
|
|
1709
1540
|
|
|
1710
|
-
##### ~~`addTip`~~ <a name="addTip" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.addTip"></a>
|
|
1711
|
-
|
|
1712
|
-
```typescript
|
|
1713
|
-
public addTip(message: string): void
|
|
1714
|
-
```
|
|
1715
|
-
|
|
1716
|
-
Prints a "tip" message during synthesis.
|
|
1717
|
-
|
|
1718
|
-
###### `message`<sup>Required</sup> <a name="message" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.addTip.parameter.message"></a>
|
|
1719
|
-
|
|
1720
|
-
- *Type:* string
|
|
1721
|
-
|
|
1722
|
-
The message.
|
|
1723
|
-
|
|
1724
|
-
---
|
|
1725
|
-
|
|
1726
1541
|
##### `annotateGenerated` <a name="annotateGenerated" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.annotateGenerated"></a>
|
|
1727
1542
|
|
|
1728
1543
|
```typescript
|
|
@@ -1832,22 +1647,6 @@ from the root of _this_ project.
|
|
|
1832
1647
|
|
|
1833
1648
|
---
|
|
1834
1649
|
|
|
1835
|
-
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.tryFindJsonFile"></a>
|
|
1836
|
-
|
|
1837
|
-
```typescript
|
|
1838
|
-
public tryFindJsonFile(filePath: string): JsonFile
|
|
1839
|
-
```
|
|
1840
|
-
|
|
1841
|
-
Finds a json file by name.
|
|
1842
|
-
|
|
1843
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.tryFindJsonFile.parameter.filePath"></a>
|
|
1844
|
-
|
|
1845
|
-
- *Type:* string
|
|
1846
|
-
|
|
1847
|
-
The file path.
|
|
1848
|
-
|
|
1849
|
-
---
|
|
1850
|
-
|
|
1851
1650
|
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.tryFindObjectFile"></a>
|
|
1852
1651
|
|
|
1853
1652
|
```typescript
|
|
@@ -1920,20 +1719,6 @@ add/update`. If you wish to specify a version range use this syntax:
|
|
|
1920
1719
|
|
|
1921
1720
|
---
|
|
1922
1721
|
|
|
1923
|
-
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.addCompileCommand"></a>
|
|
1924
|
-
|
|
1925
|
-
```typescript
|
|
1926
|
-
public addCompileCommand(commands: ...string[]): void
|
|
1927
|
-
```
|
|
1928
|
-
|
|
1929
|
-
DEPRECATED.
|
|
1930
|
-
|
|
1931
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.addCompileCommand.parameter.commands"></a>
|
|
1932
|
-
|
|
1933
|
-
- *Type:* ...string[]
|
|
1934
|
-
|
|
1935
|
-
---
|
|
1936
|
-
|
|
1937
1722
|
##### `addDeps` <a name="addDeps" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.addDeps"></a>
|
|
1938
1723
|
|
|
1939
1724
|
```typescript
|
|
@@ -2052,36 +1837,6 @@ The scripts to set.
|
|
|
2052
1837
|
|
|
2053
1838
|
---
|
|
2054
1839
|
|
|
2055
|
-
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.addTestCommand"></a>
|
|
2056
|
-
|
|
2057
|
-
```typescript
|
|
2058
|
-
public addTestCommand(commands: ...string[]): void
|
|
2059
|
-
```
|
|
2060
|
-
|
|
2061
|
-
DEPRECATED.
|
|
2062
|
-
|
|
2063
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.addTestCommand.parameter.commands"></a>
|
|
2064
|
-
|
|
2065
|
-
- *Type:* ...string[]
|
|
2066
|
-
|
|
2067
|
-
---
|
|
2068
|
-
|
|
2069
|
-
##### ~~`hasScript`~~ <a name="hasScript" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.hasScript"></a>
|
|
2070
|
-
|
|
2071
|
-
```typescript
|
|
2072
|
-
public hasScript(name: string): boolean
|
|
2073
|
-
```
|
|
2074
|
-
|
|
2075
|
-
Indicates if a script by the name name is defined.
|
|
2076
|
-
|
|
2077
|
-
###### `name`<sup>Required</sup> <a name="name" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.hasScript.parameter.name"></a>
|
|
2078
|
-
|
|
2079
|
-
- *Type:* string
|
|
2080
|
-
|
|
2081
|
-
The name of the script.
|
|
2082
|
-
|
|
2083
|
-
---
|
|
2084
|
-
|
|
2085
1840
|
##### `removeScript` <a name="removeScript" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.removeScript"></a>
|
|
2086
1841
|
|
|
2087
1842
|
```typescript
|
|
@@ -2243,21 +1998,16 @@ When given a project, this it the project itself.
|
|
|
2243
1998
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
2244
1999
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
2245
2000
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
2246
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
2247
2001
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
2248
2002
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
2249
2003
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
2250
2004
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
2251
2005
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
2252
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
2253
2006
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
2254
2007
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
2255
2008
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
2256
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
2257
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
2258
2009
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
2259
2010
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
2260
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
2261
2011
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
|
2262
2012
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
2263
2013
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
@@ -2268,7 +2018,6 @@ When given a project, this it the project itself.
|
|
|
2268
2018
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
2269
2019
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
2270
2020
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
2271
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
2272
2021
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
2273
2022
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
2274
2023
|
|
|
@@ -2571,16 +2320,6 @@ If undefined, this is the root project.
|
|
|
2571
2320
|
|
|
2572
2321
|
---
|
|
2573
2322
|
|
|
2574
|
-
##### `projectType`<sup>Required</sup> <a name="projectType" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.projectType"></a>
|
|
2575
|
-
|
|
2576
|
-
```typescript
|
|
2577
|
-
public readonly projectType: ProjectType;
|
|
2578
|
-
```
|
|
2579
|
-
|
|
2580
|
-
- *Type:* projen.ProjectType
|
|
2581
|
-
|
|
2582
|
-
---
|
|
2583
|
-
|
|
2584
2323
|
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.autoApprove"></a>
|
|
2585
2324
|
|
|
2586
2325
|
```typescript
|
|
@@ -2649,18 +2388,6 @@ This will be `undefined` for subprojects.
|
|
|
2649
2388
|
|
|
2650
2389
|
---
|
|
2651
2390
|
|
|
2652
|
-
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.allowLibraryDependencies"></a>
|
|
2653
|
-
|
|
2654
|
-
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
2655
|
-
|
|
2656
|
-
```typescript
|
|
2657
|
-
public readonly allowLibraryDependencies: boolean;
|
|
2658
|
-
```
|
|
2659
|
-
|
|
2660
|
-
- *Type:* boolean
|
|
2661
|
-
|
|
2662
|
-
---
|
|
2663
|
-
|
|
2664
2391
|
##### `artifactsDirectory`<sup>Required</sup> <a name="artifactsDirectory" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.artifactsDirectory"></a>
|
|
2665
2392
|
|
|
2666
2393
|
```typescript
|
|
@@ -2699,30 +2426,6 @@ public readonly bundler: Bundler;
|
|
|
2699
2426
|
|
|
2700
2427
|
---
|
|
2701
2428
|
|
|
2702
|
-
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.entrypoint"></a>
|
|
2703
|
-
|
|
2704
|
-
- *Deprecated:* use `package.entrypoint`
|
|
2705
|
-
|
|
2706
|
-
```typescript
|
|
2707
|
-
public readonly entrypoint: string;
|
|
2708
|
-
```
|
|
2709
|
-
|
|
2710
|
-
- *Type:* string
|
|
2711
|
-
|
|
2712
|
-
---
|
|
2713
|
-
|
|
2714
|
-
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.manifest"></a>
|
|
2715
|
-
|
|
2716
|
-
- *Deprecated:* use `package.addField(x, y)`
|
|
2717
|
-
|
|
2718
|
-
```typescript
|
|
2719
|
-
public readonly manifest: any;
|
|
2720
|
-
```
|
|
2721
|
-
|
|
2722
|
-
- *Type:* any
|
|
2723
|
-
|
|
2724
|
-
---
|
|
2725
|
-
|
|
2726
2429
|
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.npmrc"></a>
|
|
2727
2430
|
|
|
2728
2431
|
```typescript
|
|
@@ -2747,20 +2450,6 @@ API for managing the node package.
|
|
|
2747
2450
|
|
|
2748
2451
|
---
|
|
2749
2452
|
|
|
2750
|
-
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.packageManager"></a>
|
|
2751
|
-
|
|
2752
|
-
- *Deprecated:* use `package.packageManager`
|
|
2753
|
-
|
|
2754
|
-
```typescript
|
|
2755
|
-
public readonly packageManager: NodePackageManager;
|
|
2756
|
-
```
|
|
2757
|
-
|
|
2758
|
-
- *Type:* projen.javascript.NodePackageManager
|
|
2759
|
-
|
|
2760
|
-
The package manager to use.
|
|
2761
|
-
|
|
2762
|
-
---
|
|
2763
|
-
|
|
2764
2453
|
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.runScriptCommand"></a>
|
|
2765
2454
|
|
|
2766
2455
|
```typescript
|
|
@@ -2883,23 +2572,6 @@ public readonly prettier: Prettier;
|
|
|
2883
2572
|
|
|
2884
2573
|
---
|
|
2885
2574
|
|
|
2886
|
-
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.publisher"></a>
|
|
2887
|
-
|
|
2888
|
-
- *Deprecated:* use `release.publisher`.
|
|
2889
|
-
|
|
2890
|
-
```typescript
|
|
2891
|
-
public readonly publisher: Publisher;
|
|
2892
|
-
```
|
|
2893
|
-
|
|
2894
|
-
- *Type:* projen.release.Publisher
|
|
2895
|
-
|
|
2896
|
-
Package publisher.
|
|
2897
|
-
|
|
2898
|
-
This will be `undefined` if the project does not have a
|
|
2899
|
-
release workflow.
|
|
2900
|
-
|
|
2901
|
-
---
|
|
2902
|
-
|
|
2903
2575
|
##### `release`<sup>Optional</sup> <a name="release" id="@cdk8s/projen-common.Cdk8sTeamNodeProject.property.release"></a>
|
|
2904
2576
|
|
|
2905
2577
|
```typescript
|
|
@@ -2979,7 +2651,6 @@ new Cdk8sTeamTypeScriptProject(options: Cdk8sTeamTypeScriptProjectOptions)
|
|
|
2979
2651
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addGitIgnore">addGitIgnore</a></code> | Adds a .gitignore pattern. |
|
|
2980
2652
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addPackageIgnore">addPackageIgnore</a></code> | Adds patterns to be ignored by npm. |
|
|
2981
2653
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addTask">addTask</a></code> | Adds a new task to this project. |
|
|
2982
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addTip">addTip</a></code> | Prints a "tip" message during synthesis. |
|
|
2983
2654
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.annotateGenerated">annotateGenerated</a></code> | Marks the provided file(s) as being generated. |
|
|
2984
2655
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.postSynthesize">postSynthesize</a></code> | Called after all components are synthesized. |
|
|
2985
2656
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.preSynthesize">preSynthesize</a></code> | Called before all components are synthesized. |
|
|
@@ -2987,20 +2658,16 @@ new Cdk8sTeamTypeScriptProject(options: Cdk8sTeamTypeScriptProjectOptions)
|
|
|
2987
2658
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.runTaskCommand">runTaskCommand</a></code> | Returns the shell command to execute in order to run a task. |
|
|
2988
2659
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.synth">synth</a></code> | Synthesize all project files into `outdir`. |
|
|
2989
2660
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.tryFindFile">tryFindFile</a></code> | Finds a file at the specified relative path within this project and all its subprojects. |
|
|
2990
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.tryFindJsonFile">tryFindJsonFile</a></code> | Finds a json file by name. |
|
|
2991
2661
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.tryFindObjectFile">tryFindObjectFile</a></code> | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
|
|
2992
2662
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.tryRemoveFile">tryRemoveFile</a></code> | Finds a file at the specified relative path within this project and removes it. |
|
|
2993
2663
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addBins">addBins</a></code> | *No description.* |
|
|
2994
2664
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addBundledDeps">addBundledDeps</a></code> | Defines bundled dependencies. |
|
|
2995
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addCompileCommand">addCompileCommand</a></code> | DEPRECATED. |
|
|
2996
2665
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addDeps">addDeps</a></code> | Defines normal dependencies. |
|
|
2997
2666
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addDevDeps">addDevDeps</a></code> | Defines development/test dependencies. |
|
|
2998
2667
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addFields">addFields</a></code> | Directly set fields in `package.json`. |
|
|
2999
2668
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addKeywords">addKeywords</a></code> | Adds keywords to package.json (deduplicated). |
|
|
3000
2669
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addPeerDeps">addPeerDeps</a></code> | Defines peer dependencies. |
|
|
3001
2670
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addScripts">addScripts</a></code> | Replaces the contents of multiple npm package.json scripts. |
|
|
3002
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addTestCommand">addTestCommand</a></code> | DEPRECATED. |
|
|
3003
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.hasScript">hasScript</a></code> | Indicates if a script by the name name is defined. |
|
|
3004
2671
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.removeScript">removeScript</a></code> | Removes the npm script (always successful). |
|
|
3005
2672
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.renderWorkflowSetup">renderWorkflowSetup</a></code> | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
|
|
3006
2673
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.setScript">setScript</a></code> | Replaces the contents of an npm package.json script. |
|
|
@@ -3114,22 +2781,6 @@ Task properties.
|
|
|
3114
2781
|
|
|
3115
2782
|
---
|
|
3116
2783
|
|
|
3117
|
-
##### ~~`addTip`~~ <a name="addTip" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addTip"></a>
|
|
3118
|
-
|
|
3119
|
-
```typescript
|
|
3120
|
-
public addTip(message: string): void
|
|
3121
|
-
```
|
|
3122
|
-
|
|
3123
|
-
Prints a "tip" message during synthesis.
|
|
3124
|
-
|
|
3125
|
-
###### `message`<sup>Required</sup> <a name="message" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addTip.parameter.message"></a>
|
|
3126
|
-
|
|
3127
|
-
- *Type:* string
|
|
3128
|
-
|
|
3129
|
-
The message.
|
|
3130
|
-
|
|
3131
|
-
---
|
|
3132
|
-
|
|
3133
2784
|
##### `annotateGenerated` <a name="annotateGenerated" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.annotateGenerated"></a>
|
|
3134
2785
|
|
|
3135
2786
|
```typescript
|
|
@@ -3239,22 +2890,6 @@ from the root of _this_ project.
|
|
|
3239
2890
|
|
|
3240
2891
|
---
|
|
3241
2892
|
|
|
3242
|
-
##### ~~`tryFindJsonFile`~~ <a name="tryFindJsonFile" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.tryFindJsonFile"></a>
|
|
3243
|
-
|
|
3244
|
-
```typescript
|
|
3245
|
-
public tryFindJsonFile(filePath: string): JsonFile
|
|
3246
|
-
```
|
|
3247
|
-
|
|
3248
|
-
Finds a json file by name.
|
|
3249
|
-
|
|
3250
|
-
###### `filePath`<sup>Required</sup> <a name="filePath" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.tryFindJsonFile.parameter.filePath"></a>
|
|
3251
|
-
|
|
3252
|
-
- *Type:* string
|
|
3253
|
-
|
|
3254
|
-
The file path.
|
|
3255
|
-
|
|
3256
|
-
---
|
|
3257
|
-
|
|
3258
2893
|
##### `tryFindObjectFile` <a name="tryFindObjectFile" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.tryFindObjectFile"></a>
|
|
3259
2894
|
|
|
3260
2895
|
```typescript
|
|
@@ -3327,20 +2962,6 @@ add/update`. If you wish to specify a version range use this syntax:
|
|
|
3327
2962
|
|
|
3328
2963
|
---
|
|
3329
2964
|
|
|
3330
|
-
##### ~~`addCompileCommand`~~ <a name="addCompileCommand" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addCompileCommand"></a>
|
|
3331
|
-
|
|
3332
|
-
```typescript
|
|
3333
|
-
public addCompileCommand(commands: ...string[]): void
|
|
3334
|
-
```
|
|
3335
|
-
|
|
3336
|
-
DEPRECATED.
|
|
3337
|
-
|
|
3338
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addCompileCommand.parameter.commands"></a>
|
|
3339
|
-
|
|
3340
|
-
- *Type:* ...string[]
|
|
3341
|
-
|
|
3342
|
-
---
|
|
3343
|
-
|
|
3344
2965
|
##### `addDeps` <a name="addDeps" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addDeps"></a>
|
|
3345
2966
|
|
|
3346
2967
|
```typescript
|
|
@@ -3459,36 +3080,6 @@ The scripts to set.
|
|
|
3459
3080
|
|
|
3460
3081
|
---
|
|
3461
3082
|
|
|
3462
|
-
##### ~~`addTestCommand`~~ <a name="addTestCommand" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addTestCommand"></a>
|
|
3463
|
-
|
|
3464
|
-
```typescript
|
|
3465
|
-
public addTestCommand(commands: ...string[]): void
|
|
3466
|
-
```
|
|
3467
|
-
|
|
3468
|
-
DEPRECATED.
|
|
3469
|
-
|
|
3470
|
-
###### `commands`<sup>Required</sup> <a name="commands" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.addTestCommand.parameter.commands"></a>
|
|
3471
|
-
|
|
3472
|
-
- *Type:* ...string[]
|
|
3473
|
-
|
|
3474
|
-
---
|
|
3475
|
-
|
|
3476
|
-
##### ~~`hasScript`~~ <a name="hasScript" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.hasScript"></a>
|
|
3477
|
-
|
|
3478
|
-
```typescript
|
|
3479
|
-
public hasScript(name: string): boolean
|
|
3480
|
-
```
|
|
3481
|
-
|
|
3482
|
-
Indicates if a script by the name name is defined.
|
|
3483
|
-
|
|
3484
|
-
###### `name`<sup>Required</sup> <a name="name" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.hasScript.parameter.name"></a>
|
|
3485
|
-
|
|
3486
|
-
- *Type:* string
|
|
3487
|
-
|
|
3488
|
-
The name of the script.
|
|
3489
|
-
|
|
3490
|
-
---
|
|
3491
|
-
|
|
3492
3083
|
##### `removeScript` <a name="removeScript" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.removeScript"></a>
|
|
3493
3084
|
|
|
3494
3085
|
```typescript
|
|
@@ -3650,21 +3241,16 @@ When given a project, this it the project itself.
|
|
|
3650
3241
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.defaultTask">defaultTask</a></code> | <code>projen.Task</code> | This is the "default" task, the one that executes "projen". |
|
|
3651
3242
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.initProject">initProject</a></code> | <code>projen.InitProject</code> | The options used when this project is bootstrapped via `projen new`. |
|
|
3652
3243
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.parent">parent</a></code> | <code>projen.Project</code> | A parent project. |
|
|
3653
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | *No description.* |
|
|
3654
3244
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.autoApprove">autoApprove</a></code> | <code>projen.github.AutoApprove</code> | Auto approve set up for this project. |
|
|
3655
3245
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.devContainer">devContainer</a></code> | <code>projen.vscode.DevContainer</code> | Access for .devcontainer.json (used for GitHub Codespaces). |
|
|
3656
3246
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.github">github</a></code> | <code>projen.github.GitHub</code> | Access all github components. |
|
|
3657
3247
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.gitpod">gitpod</a></code> | <code>projen.Gitpod</code> | Access for Gitpod. |
|
|
3658
3248
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.vscode">vscode</a></code> | <code>projen.vscode.VsCode</code> | Access all VSCode components. |
|
|
3659
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.allowLibraryDependencies">allowLibraryDependencies</a></code> | <code>boolean</code> | *No description.* |
|
|
3660
3249
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | The build output directory. |
|
|
3661
3250
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.artifactsJavascriptDirectory">artifactsJavascriptDirectory</a></code> | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
|
|
3662
3251
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.bundler">bundler</a></code> | <code>projen.javascript.Bundler</code> | *No description.* |
|
|
3663
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.entrypoint">entrypoint</a></code> | <code>string</code> | *No description.* |
|
|
3664
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.manifest">manifest</a></code> | <code>any</code> | *No description.* |
|
|
3665
3252
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.npmrc">npmrc</a></code> | <code>projen.javascript.NpmConfig</code> | The .npmrc file. |
|
|
3666
3253
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.package">package</a></code> | <code>projen.javascript.NodePackage</code> | API for managing the node package. |
|
|
3667
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.packageManager">packageManager</a></code> | <code>projen.javascript.NodePackageManager</code> | The package manager to use. |
|
|
3668
3254
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.runScriptCommand">runScriptCommand</a></code> | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
|
|
3669
3255
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.autoMerge">autoMerge</a></code> | <code>projen.github.AutoMerge</code> | Component that sets up mergify for merging approved pull requests. |
|
|
3670
3256
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.biome">biome</a></code> | <code>projen.javascript.Biome</code> | *No description.* |
|
|
@@ -3675,7 +3261,6 @@ When given a project, this it the project itself.
|
|
|
3675
3261
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. |
|
|
3676
3262
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.npmignore">npmignore</a></code> | <code>projen.IgnoreFile</code> | The .npmignore file. |
|
|
3677
3263
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.prettier">prettier</a></code> | <code>projen.javascript.Prettier</code> | *No description.* |
|
|
3678
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.publisher">publisher</a></code> | <code>projen.release.Publisher</code> | Package publisher. |
|
|
3679
3264
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.release">release</a></code> | <code>projen.release.Release</code> | Release management. |
|
|
3680
3265
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.upgradeWorkflow">upgradeWorkflow</a></code> | <code>projen.javascript.UpgradeDependencies</code> | The upgrade workflow. |
|
|
3681
3266
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | *No description.* |
|
|
@@ -3988,16 +3573,6 @@ If undefined, this is the root project.
|
|
|
3988
3573
|
|
|
3989
3574
|
---
|
|
3990
3575
|
|
|
3991
|
-
##### `projectType`<sup>Required</sup> <a name="projectType" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.projectType"></a>
|
|
3992
|
-
|
|
3993
|
-
```typescript
|
|
3994
|
-
public readonly projectType: ProjectType;
|
|
3995
|
-
```
|
|
3996
|
-
|
|
3997
|
-
- *Type:* projen.ProjectType
|
|
3998
|
-
|
|
3999
|
-
---
|
|
4000
|
-
|
|
4001
3576
|
##### `autoApprove`<sup>Optional</sup> <a name="autoApprove" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.autoApprove"></a>
|
|
4002
3577
|
|
|
4003
3578
|
```typescript
|
|
@@ -4058,23 +3633,11 @@ This will be `undefined` if gitpod boolean is false
|
|
|
4058
3633
|
public readonly vscode: VsCode;
|
|
4059
3634
|
```
|
|
4060
3635
|
|
|
4061
|
-
- *Type:* projen.vscode.VsCode
|
|
4062
|
-
|
|
4063
|
-
Access all VSCode components.
|
|
4064
|
-
|
|
4065
|
-
This will be `undefined` for subprojects.
|
|
4066
|
-
|
|
4067
|
-
---
|
|
4068
|
-
|
|
4069
|
-
##### ~~`allowLibraryDependencies`~~<sup>Required</sup> <a name="allowLibraryDependencies" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.allowLibraryDependencies"></a>
|
|
4070
|
-
|
|
4071
|
-
- *Deprecated:* use `package.allowLibraryDependencies`
|
|
4072
|
-
|
|
4073
|
-
```typescript
|
|
4074
|
-
public readonly allowLibraryDependencies: boolean;
|
|
4075
|
-
```
|
|
4076
|
-
|
|
4077
|
-
- *Type:* boolean
|
|
3636
|
+
- *Type:* projen.vscode.VsCode
|
|
3637
|
+
|
|
3638
|
+
Access all VSCode components.
|
|
3639
|
+
|
|
3640
|
+
This will be `undefined` for subprojects.
|
|
4078
3641
|
|
|
4079
3642
|
---
|
|
4080
3643
|
|
|
@@ -4116,30 +3679,6 @@ public readonly bundler: Bundler;
|
|
|
4116
3679
|
|
|
4117
3680
|
---
|
|
4118
3681
|
|
|
4119
|
-
##### ~~`entrypoint`~~<sup>Required</sup> <a name="entrypoint" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.entrypoint"></a>
|
|
4120
|
-
|
|
4121
|
-
- *Deprecated:* use `package.entrypoint`
|
|
4122
|
-
|
|
4123
|
-
```typescript
|
|
4124
|
-
public readonly entrypoint: string;
|
|
4125
|
-
```
|
|
4126
|
-
|
|
4127
|
-
- *Type:* string
|
|
4128
|
-
|
|
4129
|
-
---
|
|
4130
|
-
|
|
4131
|
-
##### ~~`manifest`~~<sup>Required</sup> <a name="manifest" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.manifest"></a>
|
|
4132
|
-
|
|
4133
|
-
- *Deprecated:* use `package.addField(x, y)`
|
|
4134
|
-
|
|
4135
|
-
```typescript
|
|
4136
|
-
public readonly manifest: any;
|
|
4137
|
-
```
|
|
4138
|
-
|
|
4139
|
-
- *Type:* any
|
|
4140
|
-
|
|
4141
|
-
---
|
|
4142
|
-
|
|
4143
3682
|
##### `npmrc`<sup>Required</sup> <a name="npmrc" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.npmrc"></a>
|
|
4144
3683
|
|
|
4145
3684
|
```typescript
|
|
@@ -4164,20 +3703,6 @@ API for managing the node package.
|
|
|
4164
3703
|
|
|
4165
3704
|
---
|
|
4166
3705
|
|
|
4167
|
-
##### ~~`packageManager`~~<sup>Required</sup> <a name="packageManager" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.packageManager"></a>
|
|
4168
|
-
|
|
4169
|
-
- *Deprecated:* use `package.packageManager`
|
|
4170
|
-
|
|
4171
|
-
```typescript
|
|
4172
|
-
public readonly packageManager: NodePackageManager;
|
|
4173
|
-
```
|
|
4174
|
-
|
|
4175
|
-
- *Type:* projen.javascript.NodePackageManager
|
|
4176
|
-
|
|
4177
|
-
The package manager to use.
|
|
4178
|
-
|
|
4179
|
-
---
|
|
4180
|
-
|
|
4181
3706
|
##### `runScriptCommand`<sup>Required</sup> <a name="runScriptCommand" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.runScriptCommand"></a>
|
|
4182
3707
|
|
|
4183
3708
|
```typescript
|
|
@@ -4300,23 +3825,6 @@ public readonly prettier: Prettier;
|
|
|
4300
3825
|
|
|
4301
3826
|
---
|
|
4302
3827
|
|
|
4303
|
-
##### ~~`publisher`~~<sup>Optional</sup> <a name="publisher" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.publisher"></a>
|
|
4304
|
-
|
|
4305
|
-
- *Deprecated:* use `release.publisher`.
|
|
4306
|
-
|
|
4307
|
-
```typescript
|
|
4308
|
-
public readonly publisher: Publisher;
|
|
4309
|
-
```
|
|
4310
|
-
|
|
4311
|
-
- *Type:* projen.release.Publisher
|
|
4312
|
-
|
|
4313
|
-
Package publisher.
|
|
4314
|
-
|
|
4315
|
-
This will be `undefined` if the project does not have a
|
|
4316
|
-
release workflow.
|
|
4317
|
-
|
|
4318
|
-
---
|
|
4319
|
-
|
|
4320
3828
|
##### `release`<sup>Optional</sup> <a name="release" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProject.property.release"></a>
|
|
4321
3829
|
|
|
4322
3830
|
```typescript
|
|
@@ -4719,11 +4227,7 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
|
|
|
4719
4227
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
4720
4228
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
4721
4229
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
|
|
4722
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
|
|
4723
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
|
|
4724
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
4725
4230
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
4726
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
|
|
4727
4231
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
|
|
4728
4232
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
|
|
4729
4233
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
|
|
@@ -4755,7 +4259,6 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
|
|
|
4755
4259
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. Most projects should not use this option. |
|
|
4756
4260
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
4757
4261
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
|
|
4758
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
4759
4262
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
4760
4263
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
4761
4264
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.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. |
|
|
@@ -4767,7 +4270,6 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
|
|
|
4767
4270
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
4768
4271
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
4769
4272
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
4770
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
|
|
4771
4273
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
4772
4274
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
4773
4275
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
@@ -4783,10 +4285,8 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
|
|
|
4783
4285
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
4784
4286
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
4785
4287
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
4786
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
4787
4288
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
4788
4289
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
4789
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
4790
4290
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.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. |
|
|
4791
4291
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
4792
4292
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
@@ -4796,7 +4296,6 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
|
|
|
4796
4296
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
|
|
4797
4297
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
4798
4298
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
4799
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
4800
4299
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
4801
4300
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
4802
4301
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
@@ -4805,13 +4304,13 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
|
|
|
4805
4304
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
4806
4305
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
4807
4306
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
4808
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
4809
4307
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
4810
4308
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
4811
4309
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.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`. |
|
|
4812
4310
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
4813
4311
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
4814
4312
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
4313
|
+
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
4815
4314
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
4816
4315
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
4817
4316
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use tasks and github workflows to handle dependency upgrades. |
|
|
@@ -4819,8 +4318,6 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
|
|
|
4819
4318
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
4820
4319
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.jest">jest</a></code> | <code>boolean</code> | Setup jest unit tests. |
|
|
4821
4320
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.jestOptions">jestOptions</a></code> | <code>projen.javascript.JestOptions</code> | Jest options. |
|
|
4822
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
|
|
4823
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
|
|
4824
4321
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
|
4825
4322
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
|
|
4826
4323
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
|
|
@@ -4834,13 +4331,12 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
|
|
|
4834
4331
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
|
|
4835
4332
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
4836
4333
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
4837
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
4838
4334
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
|
4839
4335
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
4840
4336
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
4841
4337
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
4842
4338
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
4843
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a
|
|
4339
|
+
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
|
|
4844
4340
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
4845
4341
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
|
|
4846
4342
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
|
|
@@ -4854,7 +4350,7 @@ const cdk8sTeamJsiiProjectOptions: Cdk8sTeamJsiiProjectOptions = { ... }
|
|
|
4854
4350
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`. |
|
|
4855
4351
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
|
|
4856
4352
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
4857
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig
|
|
4353
|
+
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
4858
4354
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
4859
4355
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
4860
4356
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.additionalCompilerDependencies">additionalCompilerDependencies</a></code> | <code>string[]</code> | Packages that compile the project apart from the typescript/jsii compiler. |
|
|
@@ -5157,51 +4653,6 @@ Add a Gitpod development environment.
|
|
|
5157
4653
|
|
|
5158
4654
|
---
|
|
5159
4655
|
|
|
5160
|
-
##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.mergify"></a>
|
|
5161
|
-
|
|
5162
|
-
- *Deprecated:* use `githubOptions.mergify` instead
|
|
5163
|
-
|
|
5164
|
-
```typescript
|
|
5165
|
-
public readonly mergify: boolean;
|
|
5166
|
-
```
|
|
5167
|
-
|
|
5168
|
-
- *Type:* boolean
|
|
5169
|
-
- *Default:* true
|
|
5170
|
-
|
|
5171
|
-
Whether mergify should be enabled on this repository or not.
|
|
5172
|
-
|
|
5173
|
-
---
|
|
5174
|
-
|
|
5175
|
-
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.mergifyOptions"></a>
|
|
5176
|
-
|
|
5177
|
-
- *Deprecated:* use `githubOptions.mergifyOptions` instead
|
|
5178
|
-
|
|
5179
|
-
```typescript
|
|
5180
|
-
public readonly mergifyOptions: MergifyOptions;
|
|
5181
|
-
```
|
|
5182
|
-
|
|
5183
|
-
- *Type:* projen.github.MergifyOptions
|
|
5184
|
-
- *Default:* default options
|
|
5185
|
-
|
|
5186
|
-
Options for mergify.
|
|
5187
|
-
|
|
5188
|
-
---
|
|
5189
|
-
|
|
5190
|
-
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.projectType"></a>
|
|
5191
|
-
|
|
5192
|
-
- *Deprecated:* no longer supported at the base project level
|
|
5193
|
-
|
|
5194
|
-
```typescript
|
|
5195
|
-
public readonly projectType: ProjectType;
|
|
5196
|
-
```
|
|
5197
|
-
|
|
5198
|
-
- *Type:* projen.ProjectType
|
|
5199
|
-
- *Default:* ProjectType.UNKNOWN
|
|
5200
|
-
|
|
5201
|
-
Which type of project this is (library/app).
|
|
5202
|
-
|
|
5203
|
-
---
|
|
5204
|
-
|
|
5205
4656
|
##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.projenCredentials"></a>
|
|
5206
4657
|
|
|
5207
4658
|
```typescript
|
|
@@ -5215,24 +4666,6 @@ Choose a method of providing GitHub API access for projen workflows.
|
|
|
5215
4666
|
|
|
5216
4667
|
---
|
|
5217
4668
|
|
|
5218
|
-
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.projenTokenSecret"></a>
|
|
5219
|
-
|
|
5220
|
-
- *Deprecated:* use `projenCredentials`
|
|
5221
|
-
|
|
5222
|
-
```typescript
|
|
5223
|
-
public readonly projenTokenSecret: string;
|
|
5224
|
-
```
|
|
5225
|
-
|
|
5226
|
-
- *Type:* string
|
|
5227
|
-
- *Default:* "PROJEN_GITHUB_TOKEN"
|
|
5228
|
-
|
|
5229
|
-
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
|
5230
|
-
|
|
5231
|
-
This token needs to have the `repo`, `workflows`
|
|
5232
|
-
and `packages` scope.
|
|
5233
|
-
|
|
5234
|
-
---
|
|
5235
|
-
|
|
5236
4669
|
##### `readme`<sup>Optional</sup> <a name="readme" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.readme"></a>
|
|
5237
4670
|
|
|
5238
4671
|
```typescript
|
|
@@ -5732,22 +5165,6 @@ which is using npm internally and supports provenance statements independently o
|
|
|
5732
5165
|
|
|
5733
5166
|
---
|
|
5734
5167
|
|
|
5735
|
-
##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmRegistry"></a>
|
|
5736
|
-
|
|
5737
|
-
- *Deprecated:* use `npmRegistryUrl` instead
|
|
5738
|
-
|
|
5739
|
-
```typescript
|
|
5740
|
-
public readonly npmRegistry: string;
|
|
5741
|
-
```
|
|
5742
|
-
|
|
5743
|
-
- *Type:* string
|
|
5744
|
-
|
|
5745
|
-
The host name of the npm registry to publish to.
|
|
5746
|
-
|
|
5747
|
-
Cannot be set together with `npmRegistryUrl`.
|
|
5748
|
-
|
|
5749
|
-
---
|
|
5750
|
-
|
|
5751
5168
|
##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmRegistryUrl"></a>
|
|
5752
5169
|
|
|
5753
5170
|
```typescript
|
|
@@ -5906,25 +5323,6 @@ Options for privately hosted scoped packages.
|
|
|
5906
5323
|
|
|
5907
5324
|
---
|
|
5908
5325
|
|
|
5909
|
-
##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.scripts"></a>
|
|
5910
|
-
|
|
5911
|
-
- *Deprecated:* use `project.addTask()` or `package.setScript()`
|
|
5912
|
-
|
|
5913
|
-
```typescript
|
|
5914
|
-
public readonly scripts: {[ key: string ]: string};
|
|
5915
|
-
```
|
|
5916
|
-
|
|
5917
|
-
- *Type:* {[ key: string ]: string}
|
|
5918
|
-
- *Default:* {}
|
|
5919
|
-
|
|
5920
|
-
npm scripts to include.
|
|
5921
|
-
|
|
5922
|
-
If a script has the same name as a standard script,
|
|
5923
|
-
the standard script will be overwritten.
|
|
5924
|
-
Also adds the script as a task.
|
|
5925
|
-
|
|
5926
|
-
---
|
|
5927
|
-
|
|
5928
5326
|
##### `stability`<sup>Optional</sup> <a name="stability" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.stability"></a>
|
|
5929
5327
|
|
|
5930
5328
|
```typescript
|
|
@@ -6167,21 +5565,6 @@ on a per artifact basis.
|
|
|
6167
5565
|
|
|
6168
5566
|
---
|
|
6169
5567
|
|
|
6170
|
-
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseEveryCommit"></a>
|
|
6171
|
-
|
|
6172
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
6173
|
-
|
|
6174
|
-
```typescript
|
|
6175
|
-
public readonly releaseEveryCommit: boolean;
|
|
6176
|
-
```
|
|
6177
|
-
|
|
6178
|
-
- *Type:* boolean
|
|
6179
|
-
- *Default:* true
|
|
6180
|
-
|
|
6181
|
-
Automatically release new versions every commit to one of branches in `releaseBranches`.
|
|
6182
|
-
|
|
6183
|
-
---
|
|
6184
|
-
|
|
6185
5568
|
##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseFailureIssue"></a>
|
|
6186
5569
|
|
|
6187
5570
|
```typescript
|
|
@@ -6210,21 +5593,6 @@ Only applies if `releaseFailureIssue` is true.
|
|
|
6210
5593
|
|
|
6211
5594
|
---
|
|
6212
5595
|
|
|
6213
|
-
##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseSchedule"></a>
|
|
6214
|
-
|
|
6215
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
|
6216
|
-
|
|
6217
|
-
```typescript
|
|
6218
|
-
public readonly releaseSchedule: string;
|
|
6219
|
-
```
|
|
6220
|
-
|
|
6221
|
-
- *Type:* string
|
|
6222
|
-
- *Default:* no scheduled releases
|
|
6223
|
-
|
|
6224
|
-
CRON schedule to trigger new releases.
|
|
6225
|
-
|
|
6226
|
-
---
|
|
6227
|
-
|
|
6228
5596
|
##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseTagPrefix"></a>
|
|
6229
5597
|
|
|
6230
5598
|
```typescript
|
|
@@ -6347,19 +5715,6 @@ Github Runner Group selection options.
|
|
|
6347
5715
|
|
|
6348
5716
|
---
|
|
6349
5717
|
|
|
6350
|
-
##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.defaultReleaseBranch"></a>
|
|
6351
|
-
|
|
6352
|
-
```typescript
|
|
6353
|
-
public readonly defaultReleaseBranch: string;
|
|
6354
|
-
```
|
|
6355
|
-
|
|
6356
|
-
- *Type:* string
|
|
6357
|
-
- *Default:* "main"
|
|
6358
|
-
|
|
6359
|
-
The name of the main release branch.
|
|
6360
|
-
|
|
6361
|
-
---
|
|
6362
|
-
|
|
6363
5718
|
##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.artifactsDirectory"></a>
|
|
6364
5719
|
|
|
6365
5720
|
```typescript
|
|
@@ -6469,21 +5824,6 @@ Options for PR build workflow.
|
|
|
6469
5824
|
|
|
6470
5825
|
---
|
|
6471
5826
|
|
|
6472
|
-
##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.buildWorkflowTriggers"></a>
|
|
6473
|
-
|
|
6474
|
-
- *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
|
|
6475
|
-
|
|
6476
|
-
```typescript
|
|
6477
|
-
public readonly buildWorkflowTriggers: Triggers;
|
|
6478
|
-
```
|
|
6479
|
-
|
|
6480
|
-
- *Type:* projen.github.workflows.Triggers
|
|
6481
|
-
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
|
|
6482
|
-
|
|
6483
|
-
Build workflow triggers.
|
|
6484
|
-
|
|
6485
|
-
---
|
|
6486
|
-
|
|
6487
5827
|
##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.bundlerOptions"></a>
|
|
6488
5828
|
|
|
6489
5829
|
```typescript
|
|
@@ -6563,6 +5903,19 @@ The copyright years to put in the LICENSE file.
|
|
|
6563
5903
|
|
|
6564
5904
|
---
|
|
6565
5905
|
|
|
5906
|
+
##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.defaultReleaseBranch"></a>
|
|
5907
|
+
|
|
5908
|
+
```typescript
|
|
5909
|
+
public readonly defaultReleaseBranch: string;
|
|
5910
|
+
```
|
|
5911
|
+
|
|
5912
|
+
- *Type:* string
|
|
5913
|
+
- *Default:* "main"
|
|
5914
|
+
|
|
5915
|
+
The name of the main release branch.
|
|
5916
|
+
|
|
5917
|
+
---
|
|
5918
|
+
|
|
6566
5919
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.dependabot"></a>
|
|
6567
5920
|
|
|
6568
5921
|
```typescript
|
|
@@ -6657,41 +6010,6 @@ Jest options.
|
|
|
6657
6010
|
|
|
6658
6011
|
---
|
|
6659
6012
|
|
|
6660
|
-
##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.mutableBuild"></a>
|
|
6661
|
-
|
|
6662
|
-
- *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
|
|
6663
|
-
|
|
6664
|
-
```typescript
|
|
6665
|
-
public readonly mutableBuild: boolean;
|
|
6666
|
-
```
|
|
6667
|
-
|
|
6668
|
-
- *Type:* boolean
|
|
6669
|
-
- *Default:* true
|
|
6670
|
-
|
|
6671
|
-
Automatically update files modified during builds to pull-request branches.
|
|
6672
|
-
|
|
6673
|
-
This means
|
|
6674
|
-
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
6675
|
-
before a PR is merged.
|
|
6676
|
-
|
|
6677
|
-
Implies that PR builds do not have anti-tamper checks.
|
|
6678
|
-
|
|
6679
|
-
---
|
|
6680
|
-
|
|
6681
|
-
##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmignore"></a>
|
|
6682
|
-
|
|
6683
|
-
- *Deprecated:* - use `project.addPackageIgnore`
|
|
6684
|
-
|
|
6685
|
-
```typescript
|
|
6686
|
-
public readonly npmignore: string[];
|
|
6687
|
-
```
|
|
6688
|
-
|
|
6689
|
-
- *Type:* string[]
|
|
6690
|
-
|
|
6691
|
-
Additional entries to .npmignore.
|
|
6692
|
-
|
|
6693
|
-
---
|
|
6694
|
-
|
|
6695
6013
|
##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.npmignoreEnabled"></a>
|
|
6696
6014
|
|
|
6697
6015
|
```typescript
|
|
@@ -6860,21 +6178,6 @@ Automatically release to npm when new versions are introduced.
|
|
|
6860
6178
|
|
|
6861
6179
|
---
|
|
6862
6180
|
|
|
6863
|
-
##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.releaseWorkflow"></a>
|
|
6864
|
-
|
|
6865
|
-
- *Deprecated:* see `release`.
|
|
6866
|
-
|
|
6867
|
-
```typescript
|
|
6868
|
-
public readonly releaseWorkflow: boolean;
|
|
6869
|
-
```
|
|
6870
|
-
|
|
6871
|
-
- *Type:* boolean
|
|
6872
|
-
- *Default:* true if not a subproject
|
|
6873
|
-
|
|
6874
|
-
DEPRECATED: renamed to `release`.
|
|
6875
|
-
|
|
6876
|
-
---
|
|
6877
|
-
|
|
6878
6181
|
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="@cdk8s/projen-common.Cdk8sTeamJsiiProjectOptions.property.workflowBootstrapSteps"></a>
|
|
6879
6182
|
|
|
6880
6183
|
```typescript
|
|
@@ -6951,7 +6254,7 @@ public readonly disableTsconfigDev: boolean;
|
|
|
6951
6254
|
- *Type:* boolean
|
|
6952
6255
|
- *Default:* false
|
|
6953
6256
|
|
|
6954
|
-
Do not generate a
|
|
6257
|
+
Do not generate a development tsconfig file.
|
|
6955
6258
|
|
|
6956
6259
|
---
|
|
6957
6260
|
|
|
@@ -7135,9 +6438,13 @@ public readonly tsconfigDevFile: string;
|
|
|
7135
6438
|
```
|
|
7136
6439
|
|
|
7137
6440
|
- *Type:* string
|
|
7138
|
-
- *Default:* "tsconfig.
|
|
6441
|
+
- *Default:* "{testdir}/tsconfig.json"
|
|
7139
6442
|
|
|
7140
|
-
The name of the development tsconfig
|
|
6443
|
+
The name (and path) of the development tsconfig file.
|
|
6444
|
+
|
|
6445
|
+
By default this lives inside the test directory (e.g. `test/tsconfig.json`)
|
|
6446
|
+
so that the TypeScript language service resolves it as the nearest config
|
|
6447
|
+
for test files.
|
|
7141
6448
|
|
|
7142
6449
|
---
|
|
7143
6450
|
|
|
@@ -7351,11 +6658,7 @@ const cdk8sTeamNodeProjectOptions: Cdk8sTeamNodeProjectOptions = { ... }
|
|
|
7351
6658
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
7352
6659
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
7353
6660
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
|
|
7354
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
|
|
7355
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
|
|
7356
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
7357
6661
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
7358
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
|
|
7359
6662
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
|
|
7360
6663
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
|
|
7361
6664
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
|
|
@@ -7387,7 +6690,6 @@ const cdk8sTeamNodeProjectOptions: Cdk8sTeamNodeProjectOptions = { ... }
|
|
|
7387
6690
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. Most projects should not use this option. |
|
|
7388
6691
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
7389
6692
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
|
|
7390
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
7391
6693
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
7392
6694
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
7393
6695
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.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. |
|
|
@@ -7399,7 +6701,6 @@ const cdk8sTeamNodeProjectOptions: Cdk8sTeamNodeProjectOptions = { ... }
|
|
|
7399
6701
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
7400
6702
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
7401
6703
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
7402
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
|
|
7403
6704
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
7404
6705
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
7405
6706
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
@@ -7415,10 +6716,8 @@ const cdk8sTeamNodeProjectOptions: Cdk8sTeamNodeProjectOptions = { ... }
|
|
|
7415
6716
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
7416
6717
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
7417
6718
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
7418
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
7419
6719
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
7420
6720
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
7421
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
7422
6721
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.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. |
|
|
7423
6722
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
7424
6723
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
@@ -7428,7 +6727,6 @@ const cdk8sTeamNodeProjectOptions: Cdk8sTeamNodeProjectOptions = { ... }
|
|
|
7428
6727
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
|
|
7429
6728
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
7430
6729
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
7431
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
7432
6730
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
7433
6731
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
7434
6732
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
@@ -7437,13 +6735,13 @@ const cdk8sTeamNodeProjectOptions: Cdk8sTeamNodeProjectOptions = { ... }
|
|
|
7437
6735
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
7438
6736
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
7439
6737
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
7440
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
7441
6738
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
7442
6739
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
7443
6740
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.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`. |
|
|
7444
6741
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
7445
6742
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
7446
6743
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
6744
|
+
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
7447
6745
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
7448
6746
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
7449
6747
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use tasks and github workflows to handle dependency upgrades. |
|
|
@@ -7451,8 +6749,6 @@ const cdk8sTeamNodeProjectOptions: Cdk8sTeamNodeProjectOptions = { ... }
|
|
|
7451
6749
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
7452
6750
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.jest">jest</a></code> | <code>boolean</code> | Setup jest unit tests. |
|
|
7453
6751
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.jestOptions">jestOptions</a></code> | <code>projen.javascript.JestOptions</code> | Jest options. |
|
|
7454
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
|
|
7455
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
|
|
7456
6752
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
|
7457
6753
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
|
|
7458
6754
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
|
|
@@ -7466,7 +6762,6 @@ const cdk8sTeamNodeProjectOptions: Cdk8sTeamNodeProjectOptions = { ... }
|
|
|
7466
6762
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
|
|
7467
6763
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
7468
6764
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
7469
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
7470
6765
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
|
7471
6766
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
7472
6767
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
@@ -7764,51 +7059,6 @@ Add a Gitpod development environment.
|
|
|
7764
7059
|
|
|
7765
7060
|
---
|
|
7766
7061
|
|
|
7767
|
-
##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.mergify"></a>
|
|
7768
|
-
|
|
7769
|
-
- *Deprecated:* use `githubOptions.mergify` instead
|
|
7770
|
-
|
|
7771
|
-
```typescript
|
|
7772
|
-
public readonly mergify: boolean;
|
|
7773
|
-
```
|
|
7774
|
-
|
|
7775
|
-
- *Type:* boolean
|
|
7776
|
-
- *Default:* true
|
|
7777
|
-
|
|
7778
|
-
Whether mergify should be enabled on this repository or not.
|
|
7779
|
-
|
|
7780
|
-
---
|
|
7781
|
-
|
|
7782
|
-
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.mergifyOptions"></a>
|
|
7783
|
-
|
|
7784
|
-
- *Deprecated:* use `githubOptions.mergifyOptions` instead
|
|
7785
|
-
|
|
7786
|
-
```typescript
|
|
7787
|
-
public readonly mergifyOptions: MergifyOptions;
|
|
7788
|
-
```
|
|
7789
|
-
|
|
7790
|
-
- *Type:* projen.github.MergifyOptions
|
|
7791
|
-
- *Default:* default options
|
|
7792
|
-
|
|
7793
|
-
Options for mergify.
|
|
7794
|
-
|
|
7795
|
-
---
|
|
7796
|
-
|
|
7797
|
-
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.projectType"></a>
|
|
7798
|
-
|
|
7799
|
-
- *Deprecated:* no longer supported at the base project level
|
|
7800
|
-
|
|
7801
|
-
```typescript
|
|
7802
|
-
public readonly projectType: ProjectType;
|
|
7803
|
-
```
|
|
7804
|
-
|
|
7805
|
-
- *Type:* projen.ProjectType
|
|
7806
|
-
- *Default:* ProjectType.UNKNOWN
|
|
7807
|
-
|
|
7808
|
-
Which type of project this is (library/app).
|
|
7809
|
-
|
|
7810
|
-
---
|
|
7811
|
-
|
|
7812
7062
|
##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.projenCredentials"></a>
|
|
7813
7063
|
|
|
7814
7064
|
```typescript
|
|
@@ -7822,24 +7072,6 @@ Choose a method of providing GitHub API access for projen workflows.
|
|
|
7822
7072
|
|
|
7823
7073
|
---
|
|
7824
7074
|
|
|
7825
|
-
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.projenTokenSecret"></a>
|
|
7826
|
-
|
|
7827
|
-
- *Deprecated:* use `projenCredentials`
|
|
7828
|
-
|
|
7829
|
-
```typescript
|
|
7830
|
-
public readonly projenTokenSecret: string;
|
|
7831
|
-
```
|
|
7832
|
-
|
|
7833
|
-
- *Type:* string
|
|
7834
|
-
- *Default:* "PROJEN_GITHUB_TOKEN"
|
|
7835
|
-
|
|
7836
|
-
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
|
7837
|
-
|
|
7838
|
-
This token needs to have the `repo`, `workflows`
|
|
7839
|
-
and `packages` scope.
|
|
7840
|
-
|
|
7841
|
-
---
|
|
7842
|
-
|
|
7843
7075
|
##### `readme`<sup>Optional</sup> <a name="readme" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.readme"></a>
|
|
7844
7076
|
|
|
7845
7077
|
```typescript
|
|
@@ -8335,23 +7567,7 @@ you will need to use a supported CI/CD provider.
|
|
|
8335
7567
|
Note that the projen `Release` and `Publisher` components are using `publib` to publish packages,
|
|
8336
7568
|
which is using npm internally and supports provenance statements independently of the package manager used.
|
|
8337
7569
|
|
|
8338
|
-
> [https://docs.npmjs.com/generating-provenance-statements](https://docs.npmjs.com/generating-provenance-statements)
|
|
8339
|
-
|
|
8340
|
-
---
|
|
8341
|
-
|
|
8342
|
-
##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmRegistry"></a>
|
|
8343
|
-
|
|
8344
|
-
- *Deprecated:* use `npmRegistryUrl` instead
|
|
8345
|
-
|
|
8346
|
-
```typescript
|
|
8347
|
-
public readonly npmRegistry: string;
|
|
8348
|
-
```
|
|
8349
|
-
|
|
8350
|
-
- *Type:* string
|
|
8351
|
-
|
|
8352
|
-
The host name of the npm registry to publish to.
|
|
8353
|
-
|
|
8354
|
-
Cannot be set together with `npmRegistryUrl`.
|
|
7570
|
+
> [https://docs.npmjs.com/generating-provenance-statements](https://docs.npmjs.com/generating-provenance-statements)
|
|
8355
7571
|
|
|
8356
7572
|
---
|
|
8357
7573
|
|
|
@@ -8513,25 +7729,6 @@ Options for privately hosted scoped packages.
|
|
|
8513
7729
|
|
|
8514
7730
|
---
|
|
8515
7731
|
|
|
8516
|
-
##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.scripts"></a>
|
|
8517
|
-
|
|
8518
|
-
- *Deprecated:* use `project.addTask()` or `package.setScript()`
|
|
8519
|
-
|
|
8520
|
-
```typescript
|
|
8521
|
-
public readonly scripts: {[ key: string ]: string};
|
|
8522
|
-
```
|
|
8523
|
-
|
|
8524
|
-
- *Type:* {[ key: string ]: string}
|
|
8525
|
-
- *Default:* {}
|
|
8526
|
-
|
|
8527
|
-
npm scripts to include.
|
|
8528
|
-
|
|
8529
|
-
If a script has the same name as a standard script,
|
|
8530
|
-
the standard script will be overwritten.
|
|
8531
|
-
Also adds the script as a task.
|
|
8532
|
-
|
|
8533
|
-
---
|
|
8534
|
-
|
|
8535
7732
|
##### `stability`<sup>Optional</sup> <a name="stability" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.stability"></a>
|
|
8536
7733
|
|
|
8537
7734
|
```typescript
|
|
@@ -8774,21 +7971,6 @@ on a per artifact basis.
|
|
|
8774
7971
|
|
|
8775
7972
|
---
|
|
8776
7973
|
|
|
8777
|
-
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseEveryCommit"></a>
|
|
8778
|
-
|
|
8779
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
8780
|
-
|
|
8781
|
-
```typescript
|
|
8782
|
-
public readonly releaseEveryCommit: boolean;
|
|
8783
|
-
```
|
|
8784
|
-
|
|
8785
|
-
- *Type:* boolean
|
|
8786
|
-
- *Default:* true
|
|
8787
|
-
|
|
8788
|
-
Automatically release new versions every commit to one of branches in `releaseBranches`.
|
|
8789
|
-
|
|
8790
|
-
---
|
|
8791
|
-
|
|
8792
7974
|
##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseFailureIssue"></a>
|
|
8793
7975
|
|
|
8794
7976
|
```typescript
|
|
@@ -8817,21 +7999,6 @@ Only applies if `releaseFailureIssue` is true.
|
|
|
8817
7999
|
|
|
8818
8000
|
---
|
|
8819
8001
|
|
|
8820
|
-
##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseSchedule"></a>
|
|
8821
|
-
|
|
8822
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
|
8823
|
-
|
|
8824
|
-
```typescript
|
|
8825
|
-
public readonly releaseSchedule: string;
|
|
8826
|
-
```
|
|
8827
|
-
|
|
8828
|
-
- *Type:* string
|
|
8829
|
-
- *Default:* no scheduled releases
|
|
8830
|
-
|
|
8831
|
-
CRON schedule to trigger new releases.
|
|
8832
|
-
|
|
8833
|
-
---
|
|
8834
|
-
|
|
8835
8002
|
##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseTagPrefix"></a>
|
|
8836
8003
|
|
|
8837
8004
|
```typescript
|
|
@@ -8954,19 +8121,6 @@ Github Runner Group selection options.
|
|
|
8954
8121
|
|
|
8955
8122
|
---
|
|
8956
8123
|
|
|
8957
|
-
##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.defaultReleaseBranch"></a>
|
|
8958
|
-
|
|
8959
|
-
```typescript
|
|
8960
|
-
public readonly defaultReleaseBranch: string;
|
|
8961
|
-
```
|
|
8962
|
-
|
|
8963
|
-
- *Type:* string
|
|
8964
|
-
- *Default:* "main"
|
|
8965
|
-
|
|
8966
|
-
The name of the main release branch.
|
|
8967
|
-
|
|
8968
|
-
---
|
|
8969
|
-
|
|
8970
8124
|
##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.artifactsDirectory"></a>
|
|
8971
8125
|
|
|
8972
8126
|
```typescript
|
|
@@ -9076,21 +8230,6 @@ Options for PR build workflow.
|
|
|
9076
8230
|
|
|
9077
8231
|
---
|
|
9078
8232
|
|
|
9079
|
-
##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.buildWorkflowTriggers"></a>
|
|
9080
|
-
|
|
9081
|
-
- *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
|
|
9082
|
-
|
|
9083
|
-
```typescript
|
|
9084
|
-
public readonly buildWorkflowTriggers: Triggers;
|
|
9085
|
-
```
|
|
9086
|
-
|
|
9087
|
-
- *Type:* projen.github.workflows.Triggers
|
|
9088
|
-
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9089
|
-
|
|
9090
|
-
Build workflow triggers.
|
|
9091
|
-
|
|
9092
|
-
---
|
|
9093
|
-
|
|
9094
8233
|
##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.bundlerOptions"></a>
|
|
9095
8234
|
|
|
9096
8235
|
```typescript
|
|
@@ -9170,6 +8309,19 @@ The copyright years to put in the LICENSE file.
|
|
|
9170
8309
|
|
|
9171
8310
|
---
|
|
9172
8311
|
|
|
8312
|
+
##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.defaultReleaseBranch"></a>
|
|
8313
|
+
|
|
8314
|
+
```typescript
|
|
8315
|
+
public readonly defaultReleaseBranch: string;
|
|
8316
|
+
```
|
|
8317
|
+
|
|
8318
|
+
- *Type:* string
|
|
8319
|
+
- *Default:* "main"
|
|
8320
|
+
|
|
8321
|
+
The name of the main release branch.
|
|
8322
|
+
|
|
8323
|
+
---
|
|
8324
|
+
|
|
9173
8325
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.dependabot"></a>
|
|
9174
8326
|
|
|
9175
8327
|
```typescript
|
|
@@ -9264,41 +8416,6 @@ Jest options.
|
|
|
9264
8416
|
|
|
9265
8417
|
---
|
|
9266
8418
|
|
|
9267
|
-
##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.mutableBuild"></a>
|
|
9268
|
-
|
|
9269
|
-
- *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
|
|
9270
|
-
|
|
9271
|
-
```typescript
|
|
9272
|
-
public readonly mutableBuild: boolean;
|
|
9273
|
-
```
|
|
9274
|
-
|
|
9275
|
-
- *Type:* boolean
|
|
9276
|
-
- *Default:* true
|
|
9277
|
-
|
|
9278
|
-
Automatically update files modified during builds to pull-request branches.
|
|
9279
|
-
|
|
9280
|
-
This means
|
|
9281
|
-
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
9282
|
-
before a PR is merged.
|
|
9283
|
-
|
|
9284
|
-
Implies that PR builds do not have anti-tamper checks.
|
|
9285
|
-
|
|
9286
|
-
---
|
|
9287
|
-
|
|
9288
|
-
##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmignore"></a>
|
|
9289
|
-
|
|
9290
|
-
- *Deprecated:* - use `project.addPackageIgnore`
|
|
9291
|
-
|
|
9292
|
-
```typescript
|
|
9293
|
-
public readonly npmignore: string[];
|
|
9294
|
-
```
|
|
9295
|
-
|
|
9296
|
-
- *Type:* string[]
|
|
9297
|
-
|
|
9298
|
-
Additional entries to .npmignore.
|
|
9299
|
-
|
|
9300
|
-
---
|
|
9301
|
-
|
|
9302
8419
|
##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.npmignoreEnabled"></a>
|
|
9303
8420
|
|
|
9304
8421
|
```typescript
|
|
@@ -9467,21 +8584,6 @@ Automatically release to npm when new versions are introduced.
|
|
|
9467
8584
|
|
|
9468
8585
|
---
|
|
9469
8586
|
|
|
9470
|
-
##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.releaseWorkflow"></a>
|
|
9471
|
-
|
|
9472
|
-
- *Deprecated:* see `release`.
|
|
9473
|
-
|
|
9474
|
-
```typescript
|
|
9475
|
-
public readonly releaseWorkflow: boolean;
|
|
9476
|
-
```
|
|
9477
|
-
|
|
9478
|
-
- *Type:* boolean
|
|
9479
|
-
- *Default:* true if not a subproject
|
|
9480
|
-
|
|
9481
|
-
DEPRECATED: renamed to `release`.
|
|
9482
|
-
|
|
9483
|
-
---
|
|
9484
|
-
|
|
9485
8587
|
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="@cdk8s/projen-common.Cdk8sTeamNodeProjectOptions.property.workflowBootstrapSteps"></a>
|
|
9486
8588
|
|
|
9487
8589
|
```typescript
|
|
@@ -9625,11 +8727,7 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
|
|
|
9625
8727
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.github">github</a></code> | <code>boolean</code> | Enable GitHub integration. |
|
|
9626
8728
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.githubOptions">githubOptions</a></code> | <code>projen.github.GitHubOptions</code> | Options for GitHub integration. |
|
|
9627
8729
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.gitpod">gitpod</a></code> | <code>boolean</code> | Add a Gitpod development environment. |
|
|
9628
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.mergify">mergify</a></code> | <code>boolean</code> | Whether mergify should be enabled on this repository or not. |
|
|
9629
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.mergifyOptions">mergifyOptions</a></code> | <code>projen.github.MergifyOptions</code> | Options for mergify. |
|
|
9630
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.projectType">projectType</a></code> | <code>projen.ProjectType</code> | Which type of project this is (library/app). |
|
|
9631
8730
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.projenCredentials">projenCredentials</a></code> | <code>projen.github.GithubCredentials</code> | Choose a method of providing GitHub API access for projen workflows. |
|
|
9632
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.projenTokenSecret">projenTokenSecret</a></code> | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. |
|
|
9633
8731
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.readme">readme</a></code> | <code>projen.SampleReadmeProps</code> | The README setup. |
|
|
9634
8732
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.stale">stale</a></code> | <code>boolean</code> | Auto-close of stale issues and pull request. |
|
|
9635
8733
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.staleOptions">staleOptions</a></code> | <code>projen.github.StaleOptions</code> | Auto-close stale issues and pull requests. |
|
|
@@ -9661,7 +8759,6 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
|
|
|
9661
8759
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.minNodeVersion">minNodeVersion</a></code> | <code>string</code> | The minimum node version required by this package to function. Most projects should not use this option. |
|
|
9662
8760
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmAccess">npmAccess</a></code> | <code>projen.javascript.NpmAccess</code> | Access level of the npm package. |
|
|
9663
8761
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmProvenance">npmProvenance</a></code> | <code>boolean</code> | Should provenance statements be generated when the package is published. |
|
|
9664
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmRegistry">npmRegistry</a></code> | <code>string</code> | The host name of the npm registry to publish to. |
|
|
9665
8762
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmRegistryUrl">npmRegistryUrl</a></code> | <code>string</code> | The base URL of the npm package registry. |
|
|
9666
8763
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmTokenSecret">npmTokenSecret</a></code> | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages. |
|
|
9667
8764
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.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. |
|
|
@@ -9673,7 +8770,6 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
|
|
|
9673
8770
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.repository">repository</a></code> | <code>string</code> | The repository is the location where the actual code for your package lives. |
|
|
9674
8771
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.repositoryDirectory">repositoryDirectory</a></code> | <code>string</code> | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. |
|
|
9675
8772
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.scopedPackagesOptions">scopedPackagesOptions</a></code> | <code>projen.javascript.ScopedPackagesOptions[]</code> | Options for privately hosted scoped packages. |
|
|
9676
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.scripts">scripts</a></code> | <code>{[ key: string ]: string}</code> | npm scripts to include. |
|
|
9677
8773
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.stability">stability</a></code> | <code>string</code> | Package's Stability. |
|
|
9678
8774
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.yarnBerryOptions">yarnBerryOptions</a></code> | <code>projen.javascript.YarnBerryOptions</code> | Options for Yarn Berry. |
|
|
9679
8775
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.bumpPackage">bumpPackage</a></code> | <code>string</code> | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. |
|
|
@@ -9689,10 +8785,8 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
|
|
|
9689
8785
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releasableCommits">releasableCommits</a></code> | <code>projen.ReleasableCommits</code> | Find commits that should be considered releasable Used to decide if a release is required. |
|
|
9690
8786
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseBranches">releaseBranches</a></code> | <code>{[ key: string ]: projen.release.BranchOptions}</code> | Defines additional release branches. |
|
|
9691
8787
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseEnvironment">releaseEnvironment</a></code> | <code>string</code> | The GitHub Actions environment used for the release. |
|
|
9692
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseEveryCommit">releaseEveryCommit</a></code> | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`. |
|
|
9693
8788
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseFailureIssue">releaseFailureIssue</a></code> | <code>boolean</code> | Create a github issue on every failed publishing task. |
|
|
9694
8789
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseFailureIssueLabel">releaseFailureIssueLabel</a></code> | <code>string</code> | The label to apply to issues indicating publish failures. |
|
|
9695
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseSchedule">releaseSchedule</a></code> | <code>string</code> | CRON schedule to trigger new releases. |
|
|
9696
8790
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.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. |
|
|
9697
8791
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseTrigger">releaseTrigger</a></code> | <code>projen.release.ReleaseTrigger</code> | The release trigger to use. |
|
|
9698
8792
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseWorkflowEnv">releaseWorkflowEnv</a></code> | <code>{[ key: string ]: string}</code> | Build environment variables for release workflows. |
|
|
@@ -9702,7 +8796,6 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
|
|
|
9702
8796
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowContainerImage">workflowContainerImage</a></code> | <code>string</code> | Container image to use for GitHub workflows. |
|
|
9703
8797
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowRunsOn">workflowRunsOn</a></code> | <code>string[]</code> | Github Runner selection labels. |
|
|
9704
8798
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowRunsOnGroup">workflowRunsOnGroup</a></code> | <code>projen.GroupRunnerOptions</code> | Github Runner Group selection options. |
|
|
9705
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
9706
8799
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.artifactsDirectory">artifactsDirectory</a></code> | <code>string</code> | A directory which will contain build artifacts. |
|
|
9707
8800
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.auditDeps">auditDeps</a></code> | <code>boolean</code> | Run security audit on dependencies. |
|
|
9708
8801
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.auditDepsOptions">auditDepsOptions</a></code> | <code>projen.javascript.AuditOptions</code> | Security audit options. |
|
|
@@ -9711,13 +8804,13 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
|
|
|
9711
8804
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.biomeOptions">biomeOptions</a></code> | <code>projen.javascript.BiomeOptions</code> | Biome options. |
|
|
9712
8805
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.buildWorkflow">buildWorkflow</a></code> | <code>boolean</code> | Define a GitHub workflow for building PRs. |
|
|
9713
8806
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.buildWorkflowOptions">buildWorkflowOptions</a></code> | <code>projen.javascript.BuildWorkflowOptions</code> | Options for PR build workflow. |
|
|
9714
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.buildWorkflowTriggers">buildWorkflowTriggers</a></code> | <code>projen.github.workflows.Triggers</code> | Build workflow triggers. |
|
|
9715
8807
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.bundlerOptions">bundlerOptions</a></code> | <code>projen.javascript.BundlerOptions</code> | Options for `Bundler`. |
|
|
9716
8808
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.checkLicenses">checkLicenses</a></code> | <code>projen.javascript.LicenseCheckerOptions</code> | Configure which licenses should be deemed acceptable for use by dependencies. |
|
|
9717
8809
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.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`. |
|
|
9718
8810
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.codeCovTokenSecret">codeCovTokenSecret</a></code> | <code>string</code> | Define the secret name for a specified https://codecov.io/ token. |
|
|
9719
8811
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.copyrightOwner">copyrightOwner</a></code> | <code>string</code> | License copyright owner. |
|
|
9720
8812
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.copyrightPeriod">copyrightPeriod</a></code> | <code>string</code> | The copyright years to put in the LICENSE file. |
|
|
8813
|
+
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.defaultReleaseBranch">defaultReleaseBranch</a></code> | <code>string</code> | The name of the main release branch. |
|
|
9721
8814
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.dependabot">dependabot</a></code> | <code>boolean</code> | Use dependabot to handle dependency upgrades. |
|
|
9722
8815
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.dependabotOptions">dependabotOptions</a></code> | <code>projen.github.DependabotOptions</code> | Options for dependabot. |
|
|
9723
8816
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.depsUpgrade">depsUpgrade</a></code> | <code>boolean</code> | Use tasks and github workflows to handle dependency upgrades. |
|
|
@@ -9725,8 +8818,6 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
|
|
|
9725
8818
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.gitignore">gitignore</a></code> | <code>string[]</code> | Additional entries to .gitignore. |
|
|
9726
8819
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.jest">jest</a></code> | <code>boolean</code> | Setup jest unit tests. |
|
|
9727
8820
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.jestOptions">jestOptions</a></code> | <code>projen.javascript.JestOptions</code> | Jest options. |
|
|
9728
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.mutableBuild">mutableBuild</a></code> | <code>boolean</code> | Automatically update files modified during builds to pull-request branches. |
|
|
9729
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmignore">npmignore</a></code> | <code>string[]</code> | Additional entries to .npmignore. |
|
|
9730
8821
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmignoreEnabled">npmignoreEnabled</a></code> | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. |
|
|
9731
8822
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmIgnoreOptions">npmIgnoreOptions</a></code> | <code>projen.IgnoreFileOptions</code> | Configuration options for .npmignore file. |
|
|
9732
8823
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.package">package</a></code> | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). |
|
|
@@ -9740,13 +8831,12 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
|
|
|
9740
8831
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.pullRequestTemplateContents">pullRequestTemplateContents</a></code> | <code>string[]</code> | The contents of the pull request template. |
|
|
9741
8832
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.release">release</a></code> | <code>boolean</code> | Add release management to this project. |
|
|
9742
8833
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseToNpm">releaseToNpm</a></code> | <code>boolean</code> | Automatically release to npm when new versions are introduced. |
|
|
9743
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseWorkflow">releaseWorkflow</a></code> | <code>boolean</code> | DEPRECATED: renamed to `release`. |
|
|
9744
8834
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowBootstrapSteps">workflowBootstrapSteps</a></code> | <code>projen.github.workflows.JobStep[]</code> | Workflow steps to use in order to bootstrap this repo. |
|
|
9745
8835
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowGitIdentity">workflowGitIdentity</a></code> | <code>projen.github.GitIdentity</code> | The git identity to use in workflows. |
|
|
9746
8836
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowNodeVersion">workflowNodeVersion</a></code> | <code>string</code> | The node version used in GitHub Actions workflows. |
|
|
9747
8837
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowPackageCache">workflowPackageCache</a></code> | <code>boolean</code> | Enable Node.js package cache in GitHub workflows. |
|
|
9748
8838
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.disableTsconfig">disableTsconfig</a></code> | <code>boolean</code> | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). |
|
|
9749
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a
|
|
8839
|
+
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.disableTsconfigDev">disableTsconfigDev</a></code> | <code>boolean</code> | Do not generate a development tsconfig file. |
|
|
9750
8840
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.docgen">docgen</a></code> | <code>boolean</code> | Docgen by Typedoc. |
|
|
9751
8841
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.docsDirectory">docsDirectory</a></code> | <code>string</code> | Docs directory. |
|
|
9752
8842
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.entrypointTypes">entrypointTypes</a></code> | <code>string</code> | The .d.ts file that includes the type declarations for this module. |
|
|
@@ -9760,7 +8850,7 @@ const cdk8sTeamTypeScriptProjectOptions: Cdk8sTeamTypeScriptProjectOptions = { .
|
|
|
9760
8850
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.testdir">testdir</a></code> | <code>string</code> | Jest tests directory. Tests files should be named `xxx.test.ts`. |
|
|
9761
8851
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.tsconfig">tsconfig</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom TSConfig. |
|
|
9762
8852
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
|
|
9763
|
-
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig
|
|
8853
|
+
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name (and path) of the development tsconfig file. |
|
|
9764
8854
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.tsJestOptions">tsJestOptions</a></code> | <code>projen.typescript.TsJestOptions</code> | Options for ts-jest. |
|
|
9765
8855
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
|
|
9766
8856
|
| <code><a href="#@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.additionalCompilerDependencies">additionalCompilerDependencies</a></code> | <code>string[]</code> | Packages that compile the project apart from the typescript/jsii compiler. |
|
|
@@ -10057,51 +9147,6 @@ Add a Gitpod development environment.
|
|
|
10057
9147
|
|
|
10058
9148
|
---
|
|
10059
9149
|
|
|
10060
|
-
##### ~~`mergify`~~<sup>Optional</sup> <a name="mergify" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.mergify"></a>
|
|
10061
|
-
|
|
10062
|
-
- *Deprecated:* use `githubOptions.mergify` instead
|
|
10063
|
-
|
|
10064
|
-
```typescript
|
|
10065
|
-
public readonly mergify: boolean;
|
|
10066
|
-
```
|
|
10067
|
-
|
|
10068
|
-
- *Type:* boolean
|
|
10069
|
-
- *Default:* true
|
|
10070
|
-
|
|
10071
|
-
Whether mergify should be enabled on this repository or not.
|
|
10072
|
-
|
|
10073
|
-
---
|
|
10074
|
-
|
|
10075
|
-
##### ~~`mergifyOptions`~~<sup>Optional</sup> <a name="mergifyOptions" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.mergifyOptions"></a>
|
|
10076
|
-
|
|
10077
|
-
- *Deprecated:* use `githubOptions.mergifyOptions` instead
|
|
10078
|
-
|
|
10079
|
-
```typescript
|
|
10080
|
-
public readonly mergifyOptions: MergifyOptions;
|
|
10081
|
-
```
|
|
10082
|
-
|
|
10083
|
-
- *Type:* projen.github.MergifyOptions
|
|
10084
|
-
- *Default:* default options
|
|
10085
|
-
|
|
10086
|
-
Options for mergify.
|
|
10087
|
-
|
|
10088
|
-
---
|
|
10089
|
-
|
|
10090
|
-
##### ~~`projectType`~~<sup>Optional</sup> <a name="projectType" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.projectType"></a>
|
|
10091
|
-
|
|
10092
|
-
- *Deprecated:* no longer supported at the base project level
|
|
10093
|
-
|
|
10094
|
-
```typescript
|
|
10095
|
-
public readonly projectType: ProjectType;
|
|
10096
|
-
```
|
|
10097
|
-
|
|
10098
|
-
- *Type:* projen.ProjectType
|
|
10099
|
-
- *Default:* ProjectType.UNKNOWN
|
|
10100
|
-
|
|
10101
|
-
Which type of project this is (library/app).
|
|
10102
|
-
|
|
10103
|
-
---
|
|
10104
|
-
|
|
10105
9150
|
##### `projenCredentials`<sup>Optional</sup> <a name="projenCredentials" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.projenCredentials"></a>
|
|
10106
9151
|
|
|
10107
9152
|
```typescript
|
|
@@ -10115,24 +9160,6 @@ Choose a method of providing GitHub API access for projen workflows.
|
|
|
10115
9160
|
|
|
10116
9161
|
---
|
|
10117
9162
|
|
|
10118
|
-
##### ~~`projenTokenSecret`~~<sup>Optional</sup> <a name="projenTokenSecret" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.projenTokenSecret"></a>
|
|
10119
|
-
|
|
10120
|
-
- *Deprecated:* use `projenCredentials`
|
|
10121
|
-
|
|
10122
|
-
```typescript
|
|
10123
|
-
public readonly projenTokenSecret: string;
|
|
10124
|
-
```
|
|
10125
|
-
|
|
10126
|
-
- *Type:* string
|
|
10127
|
-
- *Default:* "PROJEN_GITHUB_TOKEN"
|
|
10128
|
-
|
|
10129
|
-
The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
|
|
10130
|
-
|
|
10131
|
-
This token needs to have the `repo`, `workflows`
|
|
10132
|
-
and `packages` scope.
|
|
10133
|
-
|
|
10134
|
-
---
|
|
10135
|
-
|
|
10136
9163
|
##### `readme`<sup>Optional</sup> <a name="readme" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.readme"></a>
|
|
10137
9164
|
|
|
10138
9165
|
```typescript
|
|
@@ -10632,22 +9659,6 @@ which is using npm internally and supports provenance statements independently o
|
|
|
10632
9659
|
|
|
10633
9660
|
---
|
|
10634
9661
|
|
|
10635
|
-
##### ~~`npmRegistry`~~<sup>Optional</sup> <a name="npmRegistry" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmRegistry"></a>
|
|
10636
|
-
|
|
10637
|
-
- *Deprecated:* use `npmRegistryUrl` instead
|
|
10638
|
-
|
|
10639
|
-
```typescript
|
|
10640
|
-
public readonly npmRegistry: string;
|
|
10641
|
-
```
|
|
10642
|
-
|
|
10643
|
-
- *Type:* string
|
|
10644
|
-
|
|
10645
|
-
The host name of the npm registry to publish to.
|
|
10646
|
-
|
|
10647
|
-
Cannot be set together with `npmRegistryUrl`.
|
|
10648
|
-
|
|
10649
|
-
---
|
|
10650
|
-
|
|
10651
9662
|
##### `npmRegistryUrl`<sup>Optional</sup> <a name="npmRegistryUrl" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmRegistryUrl"></a>
|
|
10652
9663
|
|
|
10653
9664
|
```typescript
|
|
@@ -10806,25 +9817,6 @@ Options for privately hosted scoped packages.
|
|
|
10806
9817
|
|
|
10807
9818
|
---
|
|
10808
9819
|
|
|
10809
|
-
##### ~~`scripts`~~<sup>Optional</sup> <a name="scripts" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.scripts"></a>
|
|
10810
|
-
|
|
10811
|
-
- *Deprecated:* use `project.addTask()` or `package.setScript()`
|
|
10812
|
-
|
|
10813
|
-
```typescript
|
|
10814
|
-
public readonly scripts: {[ key: string ]: string};
|
|
10815
|
-
```
|
|
10816
|
-
|
|
10817
|
-
- *Type:* {[ key: string ]: string}
|
|
10818
|
-
- *Default:* {}
|
|
10819
|
-
|
|
10820
|
-
npm scripts to include.
|
|
10821
|
-
|
|
10822
|
-
If a script has the same name as a standard script,
|
|
10823
|
-
the standard script will be overwritten.
|
|
10824
|
-
Also adds the script as a task.
|
|
10825
|
-
|
|
10826
|
-
---
|
|
10827
|
-
|
|
10828
9820
|
##### `stability`<sup>Optional</sup> <a name="stability" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.stability"></a>
|
|
10829
9821
|
|
|
10830
9822
|
```typescript
|
|
@@ -11067,21 +10059,6 @@ on a per artifact basis.
|
|
|
11067
10059
|
|
|
11068
10060
|
---
|
|
11069
10061
|
|
|
11070
|
-
##### ~~`releaseEveryCommit`~~<sup>Optional</sup> <a name="releaseEveryCommit" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseEveryCommit"></a>
|
|
11071
|
-
|
|
11072
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
11073
|
-
|
|
11074
|
-
```typescript
|
|
11075
|
-
public readonly releaseEveryCommit: boolean;
|
|
11076
|
-
```
|
|
11077
|
-
|
|
11078
|
-
- *Type:* boolean
|
|
11079
|
-
- *Default:* true
|
|
11080
|
-
|
|
11081
|
-
Automatically release new versions every commit to one of branches in `releaseBranches`.
|
|
11082
|
-
|
|
11083
|
-
---
|
|
11084
|
-
|
|
11085
10062
|
##### `releaseFailureIssue`<sup>Optional</sup> <a name="releaseFailureIssue" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseFailureIssue"></a>
|
|
11086
10063
|
|
|
11087
10064
|
```typescript
|
|
@@ -11110,21 +10087,6 @@ Only applies if `releaseFailureIssue` is true.
|
|
|
11110
10087
|
|
|
11111
10088
|
---
|
|
11112
10089
|
|
|
11113
|
-
##### ~~`releaseSchedule`~~<sup>Optional</sup> <a name="releaseSchedule" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseSchedule"></a>
|
|
11114
|
-
|
|
11115
|
-
- *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
|
11116
|
-
|
|
11117
|
-
```typescript
|
|
11118
|
-
public readonly releaseSchedule: string;
|
|
11119
|
-
```
|
|
11120
|
-
|
|
11121
|
-
- *Type:* string
|
|
11122
|
-
- *Default:* no scheduled releases
|
|
11123
|
-
|
|
11124
|
-
CRON schedule to trigger new releases.
|
|
11125
|
-
|
|
11126
|
-
---
|
|
11127
|
-
|
|
11128
10090
|
##### `releaseTagPrefix`<sup>Optional</sup> <a name="releaseTagPrefix" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseTagPrefix"></a>
|
|
11129
10091
|
|
|
11130
10092
|
```typescript
|
|
@@ -11247,19 +10209,6 @@ Github Runner Group selection options.
|
|
|
11247
10209
|
|
|
11248
10210
|
---
|
|
11249
10211
|
|
|
11250
|
-
##### `defaultReleaseBranch`<sup>Required</sup> <a name="defaultReleaseBranch" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.defaultReleaseBranch"></a>
|
|
11251
|
-
|
|
11252
|
-
```typescript
|
|
11253
|
-
public readonly defaultReleaseBranch: string;
|
|
11254
|
-
```
|
|
11255
|
-
|
|
11256
|
-
- *Type:* string
|
|
11257
|
-
- *Default:* "main"
|
|
11258
|
-
|
|
11259
|
-
The name of the main release branch.
|
|
11260
|
-
|
|
11261
|
-
---
|
|
11262
|
-
|
|
11263
10212
|
##### `artifactsDirectory`<sup>Optional</sup> <a name="artifactsDirectory" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.artifactsDirectory"></a>
|
|
11264
10213
|
|
|
11265
10214
|
```typescript
|
|
@@ -11369,21 +10318,6 @@ Options for PR build workflow.
|
|
|
11369
10318
|
|
|
11370
10319
|
---
|
|
11371
10320
|
|
|
11372
|
-
##### ~~`buildWorkflowTriggers`~~<sup>Optional</sup> <a name="buildWorkflowTriggers" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.buildWorkflowTriggers"></a>
|
|
11373
|
-
|
|
11374
|
-
- *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers`
|
|
11375
|
-
|
|
11376
|
-
```typescript
|
|
11377
|
-
public readonly buildWorkflowTriggers: Triggers;
|
|
11378
|
-
```
|
|
11379
|
-
|
|
11380
|
-
- *Type:* projen.github.workflows.Triggers
|
|
11381
|
-
- *Default:* "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11382
|
-
|
|
11383
|
-
Build workflow triggers.
|
|
11384
|
-
|
|
11385
|
-
---
|
|
11386
|
-
|
|
11387
10321
|
##### `bundlerOptions`<sup>Optional</sup> <a name="bundlerOptions" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.bundlerOptions"></a>
|
|
11388
10322
|
|
|
11389
10323
|
```typescript
|
|
@@ -11463,6 +10397,19 @@ The copyright years to put in the LICENSE file.
|
|
|
11463
10397
|
|
|
11464
10398
|
---
|
|
11465
10399
|
|
|
10400
|
+
##### `defaultReleaseBranch`<sup>Optional</sup> <a name="defaultReleaseBranch" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.defaultReleaseBranch"></a>
|
|
10401
|
+
|
|
10402
|
+
```typescript
|
|
10403
|
+
public readonly defaultReleaseBranch: string;
|
|
10404
|
+
```
|
|
10405
|
+
|
|
10406
|
+
- *Type:* string
|
|
10407
|
+
- *Default:* "main"
|
|
10408
|
+
|
|
10409
|
+
The name of the main release branch.
|
|
10410
|
+
|
|
10411
|
+
---
|
|
10412
|
+
|
|
11466
10413
|
##### `dependabot`<sup>Optional</sup> <a name="dependabot" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.dependabot"></a>
|
|
11467
10414
|
|
|
11468
10415
|
```typescript
|
|
@@ -11557,41 +10504,6 @@ Jest options.
|
|
|
11557
10504
|
|
|
11558
10505
|
---
|
|
11559
10506
|
|
|
11560
|
-
##### ~~`mutableBuild`~~<sup>Optional</sup> <a name="mutableBuild" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.mutableBuild"></a>
|
|
11561
|
-
|
|
11562
|
-
- *Deprecated:* - Use `buildWorkflowOptions.mutableBuild`
|
|
11563
|
-
|
|
11564
|
-
```typescript
|
|
11565
|
-
public readonly mutableBuild: boolean;
|
|
11566
|
-
```
|
|
11567
|
-
|
|
11568
|
-
- *Type:* boolean
|
|
11569
|
-
- *Default:* true
|
|
11570
|
-
|
|
11571
|
-
Automatically update files modified during builds to pull-request branches.
|
|
11572
|
-
|
|
11573
|
-
This means
|
|
11574
|
-
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
|
|
11575
|
-
before a PR is merged.
|
|
11576
|
-
|
|
11577
|
-
Implies that PR builds do not have anti-tamper checks.
|
|
11578
|
-
|
|
11579
|
-
---
|
|
11580
|
-
|
|
11581
|
-
##### ~~`npmignore`~~<sup>Optional</sup> <a name="npmignore" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmignore"></a>
|
|
11582
|
-
|
|
11583
|
-
- *Deprecated:* - use `project.addPackageIgnore`
|
|
11584
|
-
|
|
11585
|
-
```typescript
|
|
11586
|
-
public readonly npmignore: string[];
|
|
11587
|
-
```
|
|
11588
|
-
|
|
11589
|
-
- *Type:* string[]
|
|
11590
|
-
|
|
11591
|
-
Additional entries to .npmignore.
|
|
11592
|
-
|
|
11593
|
-
---
|
|
11594
|
-
|
|
11595
10507
|
##### `npmignoreEnabled`<sup>Optional</sup> <a name="npmignoreEnabled" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.npmignoreEnabled"></a>
|
|
11596
10508
|
|
|
11597
10509
|
```typescript
|
|
@@ -11760,21 +10672,6 @@ Automatically release to npm when new versions are introduced.
|
|
|
11760
10672
|
|
|
11761
10673
|
---
|
|
11762
10674
|
|
|
11763
|
-
##### ~~`releaseWorkflow`~~<sup>Optional</sup> <a name="releaseWorkflow" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.releaseWorkflow"></a>
|
|
11764
|
-
|
|
11765
|
-
- *Deprecated:* see `release`.
|
|
11766
|
-
|
|
11767
|
-
```typescript
|
|
11768
|
-
public readonly releaseWorkflow: boolean;
|
|
11769
|
-
```
|
|
11770
|
-
|
|
11771
|
-
- *Type:* boolean
|
|
11772
|
-
- *Default:* true if not a subproject
|
|
11773
|
-
|
|
11774
|
-
DEPRECATED: renamed to `release`.
|
|
11775
|
-
|
|
11776
|
-
---
|
|
11777
|
-
|
|
11778
10675
|
##### `workflowBootstrapSteps`<sup>Optional</sup> <a name="workflowBootstrapSteps" id="@cdk8s/projen-common.Cdk8sTeamTypeScriptProjectOptions.property.workflowBootstrapSteps"></a>
|
|
11779
10676
|
|
|
11780
10677
|
```typescript
|
|
@@ -11851,7 +10748,7 @@ public readonly disableTsconfigDev: boolean;
|
|
|
11851
10748
|
- *Type:* boolean
|
|
11852
10749
|
- *Default:* false
|
|
11853
10750
|
|
|
11854
|
-
Do not generate a
|
|
10751
|
+
Do not generate a development tsconfig file.
|
|
11855
10752
|
|
|
11856
10753
|
---
|
|
11857
10754
|
|
|
@@ -12035,9 +10932,13 @@ public readonly tsconfigDevFile: string;
|
|
|
12035
10932
|
```
|
|
12036
10933
|
|
|
12037
10934
|
- *Type:* string
|
|
12038
|
-
- *Default:* "tsconfig.
|
|
10935
|
+
- *Default:* "{testdir}/tsconfig.json"
|
|
10936
|
+
|
|
10937
|
+
The name (and path) of the development tsconfig file.
|
|
12039
10938
|
|
|
12040
|
-
|
|
10939
|
+
By default this lives inside the test directory (e.g. `test/tsconfig.json`)
|
|
10940
|
+
so that the TypeScript language service resolves it as the nearest config
|
|
10941
|
+
for test files.
|
|
12041
10942
|
|
|
12042
10943
|
---
|
|
12043
10944
|
|