projen 0.51.15 → 0.52.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 +334 -269
- package/API.md +70 -16
- package/README.md +0 -1
- package/changelog.md +1 -6
- package/docs/eject.md +30 -0
- package/lib/awscdk/auto-discover.js +1 -1
- package/lib/awscdk/awscdk-app-java.js +1 -1
- package/lib/awscdk/awscdk-app-ts.js +1 -1
- package/lib/awscdk/awscdk-construct.js +2 -2
- package/lib/awscdk/awscdk-deps-java.js +1 -1
- package/lib/awscdk/awscdk-deps-js.js +1 -1
- package/lib/awscdk/awscdk-deps.js +1 -1
- package/lib/awscdk/cdk-config.js +1 -1
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/lambda-function.js +6 -5
- package/lib/build/build-workflow.d.ts +8 -1
- package/lib/build/build-workflow.js +4 -4
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/jsii-docgen.js +1 -1
- package/lib/cdk/jsii-project.js +1 -1
- package/lib/cdk8s/cdk8s-app-ts.js +1 -1
- package/lib/cdk8s/cdk8s-construct.js +1 -1
- package/lib/cdktf/cdktf-construct.js +1 -1
- package/lib/component.js +1 -1
- package/lib/dependencies.js +8 -6
- package/lib/dev-env.js +1 -1
- package/lib/docker-compose.js +2 -2
- package/lib/file.d.ts +22 -8
- package/lib/file.js +32 -12
- package/lib/gitattributes.js +3 -3
- package/lib/github/auto-approve.js +1 -1
- package/lib/github/auto-merge.js +1 -1
- package/lib/github/dependabot.js +1 -1
- package/lib/github/github-project.js +1 -1
- package/lib/github/github.js +1 -1
- package/lib/github/mergify.js +1 -1
- package/lib/github/pr-template.js +3 -2
- package/lib/github/pull-request-lint.js +1 -1
- package/lib/github/stale.js +1 -1
- package/lib/github/task-workflow.js +1 -1
- package/lib/github/workflows.js +1 -1
- package/lib/gitlab/configuration.js +1 -1
- package/lib/gitlab/gitlab-configuration.js +1 -1
- package/lib/gitlab/nested-configuration.js +1 -1
- package/lib/gitpod.js +1 -1
- package/lib/ignore-file.js +6 -3
- package/lib/ini.js +3 -3
- package/lib/java/java-project.js +1 -1
- package/lib/java/junit.js +1 -1
- package/lib/java/maven-compile.js +1 -1
- package/lib/java/maven-packaging.js +1 -1
- package/lib/java/maven-sample.js +1 -1
- package/lib/java/pom.js +1 -1
- package/lib/java/projenrc.js +5 -5
- package/lib/javascript/bundler.js +1 -1
- package/lib/javascript/eslint.js +1 -1
- package/lib/javascript/jest.js +1 -1
- package/lib/javascript/node-package.js +1 -1
- package/lib/javascript/node-project.d.ts +8 -1
- package/lib/javascript/node-project.js +7 -4
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/prettier.js +1 -1
- package/lib/javascript/projenrc.js +4 -4
- package/lib/javascript/typescript-config.js +1 -1
- package/lib/javascript/upgrade-dependencies.js +2 -2
- package/lib/json.js +3 -3
- package/lib/license.js +3 -3
- package/lib/logger.js +1 -1
- package/lib/makefile.js +1 -1
- package/lib/object-file.d.ts +0 -13
- package/lib/object-file.js +4 -5
- package/lib/project-build.js +3 -3
- package/lib/project.d.ts +18 -1
- package/lib/project.js +54 -15
- package/lib/projects.js +1 -1
- package/lib/projenrc-json.js +5 -5
- package/lib/python/pip.js +1 -1
- package/lib/python/poetry.js +2 -2
- package/lib/python/projenrc.js +4 -4
- package/lib/python/pytest.js +1 -1
- package/lib/python/python-project.js +1 -1
- package/lib/python/python-sample.js +1 -1
- package/lib/python/requirements-file.js +3 -3
- package/lib/python/setuppy.js +3 -3
- package/lib/python/setuptools.js +1 -1
- package/lib/python/venv.js +1 -1
- package/lib/readme.js +1 -1
- package/lib/release/bump-version.task.js +2 -2
- package/lib/release/publisher.js +1 -1
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.js +1 -1
- package/lib/run-task.js +1823 -0
- package/lib/sample-file.js +2 -2
- package/lib/semver.js +1 -1
- package/lib/source-code.d.ts +4 -0
- package/lib/source-code.js +8 -2
- package/lib/task-runtime.d.ts +6 -0
- package/lib/task-runtime.js +13 -6
- package/lib/task.js +1 -1
- package/lib/tasks.d.ts +6 -6
- package/lib/tasks.js +18 -11
- package/lib/testing.js +1 -1
- package/lib/textfile.js +1 -1
- package/lib/toml.js +3 -3
- package/lib/typescript/projenrc.js +4 -4
- package/lib/typescript/typescript-typedoc.js +1 -1
- package/lib/typescript/typescript.js +7 -5
- package/lib/util.d.ts +2 -0
- package/lib/util.js +22 -2
- package/lib/version.js +1 -1
- package/lib/vscode/devcontainer.js +1 -1
- package/lib/vscode/launch-config.js +1 -1
- package/lib/vscode/vscode.js +1 -1
- package/lib/web/next.js +3 -3
- package/lib/web/postcss.js +1 -1
- package/lib/web/react.js +8 -11
- package/lib/web/tailwind.js +1 -1
- package/lib/xmlfile.js +3 -3
- package/lib/yaml.js +3 -3
- package/node_modules/xmlbuilder2/node_modules/@types/node/README.md +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/events.d.ts +31 -3
- package/node_modules/xmlbuilder2/node_modules/@types/node/package.json +2 -2
- package/node_modules/xmlbuilder2/node_modules/@types/node/util.d.ts +1 -1
- package/package.json +4 -1
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
package/API.md
CHANGED
|
@@ -856,6 +856,7 @@ new FileBase(project: Project, filePath: string, options?: FileBaseOptions)
|
|
|
856
856
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
857
857
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
858
858
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
859
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
859
860
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
860
861
|
|
|
861
862
|
|
|
@@ -870,7 +871,7 @@ Name | Type | Description
|
|
|
870
871
|
**path**🔹 | <code>string</code> | The file path, relative to the project root.
|
|
871
872
|
**readonly**🔹 | <code>boolean</code> | Indicates if the file should be read-only or read-write.
|
|
872
873
|
**changed**?🔹 | <code>boolean</code> | Indicates if the file has been changed during synthesis.<br/>__*Optional*__
|
|
873
|
-
|
|
874
|
+
**marker**?🔹 | <code>string</code> | The projen marker, used to identify files as projen-generated.<br/>__*Optional*__
|
|
874
875
|
|
|
875
876
|
### Methods
|
|
876
877
|
|
|
@@ -1209,8 +1210,8 @@ new IniFile(project: Project, filePath: string, options: IniFileOptions)
|
|
|
1209
1210
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
1210
1211
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
1211
1212
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
1213
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
1212
1214
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
1213
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
1214
1215
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
1215
1216
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
1216
1217
|
|
|
@@ -1254,8 +1255,8 @@ new JsonFile(project: Project, filePath: string, options: JsonFileOptions)
|
|
|
1254
1255
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
1255
1256
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
1256
1257
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
1258
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
1257
1259
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
1258
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
1259
1260
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
1260
1261
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
1261
1262
|
* **newline** (<code>boolean</code>) Adds a newline at the end of the file. __*Default*__: true
|
|
@@ -1448,6 +1449,7 @@ new Makefile(project: Project, filePath: string, options?: MakefileOptions)
|
|
|
1448
1449
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
1449
1450
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
1450
1451
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
1452
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
1451
1453
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
1452
1454
|
* **all** (<code>Array<string></code>) List of targets to build when Make is invoked without specifying any targets. __*Default*__: []
|
|
1453
1455
|
* **rules** (<code>Array<[Rule](#projen-rule)></code>) Rules to include in the Makefile. __*Default*__: []
|
|
@@ -1562,8 +1564,8 @@ new ObjectFile(project: Project, filePath: string, options: ObjectFileOptions)
|
|
|
1562
1564
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
1563
1565
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
1564
1566
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
1567
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
1565
1568
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
1566
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
1567
1569
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
1568
1570
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
1569
1571
|
|
|
@@ -1574,7 +1576,6 @@ new ObjectFile(project: Project, filePath: string, options: ObjectFileOptions)
|
|
|
1574
1576
|
|
|
1575
1577
|
Name | Type | Description
|
|
1576
1578
|
-----|------|-------------
|
|
1577
|
-
**marker**🔹 | <code>boolean</code> | Indicates if the projen marker JSON-comment will be added to the output object.
|
|
1578
1579
|
**omitEmpty**🔹 | <code>boolean</code> | Indicates if empty objects and arrays are omitted from the output object.
|
|
1579
1580
|
|
|
1580
1581
|
### Methods
|
|
@@ -1681,8 +1682,8 @@ Name | Type | Description
|
|
|
1681
1682
|
**buildTask**🔹 | <code>[Task](#projen-task)</code> | <span></span>
|
|
1682
1683
|
**compileTask**🔹 | <code>[Task](#projen-task)</code> | <span></span>
|
|
1683
1684
|
**components**🔹 | <code>Array<[Component](#projen-component)></code> | Returns all the components within this project.
|
|
1684
|
-
**defaultTask**🔹 | <code>[Task](#projen-task)</code> | This is the "default" task, the one that executes "projen".
|
|
1685
1685
|
**deps**🔹 | <code>[Dependencies](#projen-dependencies)</code> | Project dependencies.
|
|
1686
|
+
**ejected**🔹 | <code>boolean</code> | Whether or not the project is being ejected.
|
|
1686
1687
|
**files**🔹 | <code>Array<[FileBase](#projen-filebase)></code> | All files in this project.
|
|
1687
1688
|
**gitattributes**🔹 | <code>[GitAttributesFile](#projen-gitattributesfile)</code> | The .gitattributes file for this repository.
|
|
1688
1689
|
**gitignore**🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | .gitignore.
|
|
@@ -1697,6 +1698,7 @@ Name | Type | Description
|
|
|
1697
1698
|
**root**🔹 | <code>[Project](#projen-project)</code> | The root project.
|
|
1698
1699
|
**tasks**🔹 | <code>[Tasks](#projen-tasks)</code> | Project tasks.
|
|
1699
1700
|
**testTask**🔹 | <code>[Task](#projen-task)</code> | <span></span>
|
|
1701
|
+
**defaultTask**?🔹 | <code>[Task](#projen-task)</code> | This is the "default" task, the one that executes "projen".<br/>__*Optional*__
|
|
1700
1702
|
**initProject**?🔹 | <code>[InitProject](#projen-initproject)</code> | The options used when this project is bootstrapped via `projen new`.<br/>__*Optional*__
|
|
1701
1703
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | A parent project.<br/>__*Optional*__
|
|
1702
1704
|
*static* **DEFAULT_TASK**🔹 | <code>string</code> | The name of the default task (the task executed when `projen` is run without arguments).
|
|
@@ -2238,6 +2240,7 @@ new SourceCode(project: Project, filePath: string, options?: SourceCodeOptions)
|
|
|
2238
2240
|
Name | Type | Description
|
|
2239
2241
|
-----|------|-------------
|
|
2240
2242
|
**filePath**🔹 | <code>string</code> | <span></span>
|
|
2243
|
+
**marker**?🔹 | <code>string</code> | __*Optional*__
|
|
2241
2244
|
|
|
2242
2245
|
### Methods
|
|
2243
2246
|
|
|
@@ -2524,6 +2527,7 @@ Name | Type | Description
|
|
|
2524
2527
|
**manifest**🔹 | <code>[TasksManifest](#projen-tasksmanifest)</code> | The contents of tasks.json.
|
|
2525
2528
|
**tasks**🔹 | <code>Array<[TaskSpec](#projen-taskspec)></code> | The tasks in this project.
|
|
2526
2529
|
**workdir**🔹 | <code>string</code> | The root directory of the project and the cwd for executing tasks.
|
|
2530
|
+
*static* **MANIFEST_FILE**🔹 | <code>string</code> | The project-relative path of the tasks manifest file.
|
|
2527
2531
|
|
|
2528
2532
|
### Methods
|
|
2529
2533
|
|
|
@@ -2586,7 +2590,6 @@ Name | Type | Description
|
|
|
2586
2590
|
-----|------|-------------
|
|
2587
2591
|
**all**🔹 | <code>Array<[Task](#projen-task)></code> | All tasks.
|
|
2588
2592
|
**env**🔹 | <code>Map<string, string></code> | Returns a copy of the currently global environment for this project.
|
|
2589
|
-
*static* **MANIFEST_FILE**🔹 | <code>string</code> | The project-relative path of the tasks manifest file.
|
|
2590
2593
|
|
|
2591
2594
|
### Methods
|
|
2592
2595
|
|
|
@@ -2638,6 +2641,18 @@ removeTask(name: string): Task
|
|
|
2638
2641
|
__Returns__:
|
|
2639
2642
|
* <code>[Task](#projen-task)</code>
|
|
2640
2643
|
|
|
2644
|
+
#### synthesize()🔹 <a id="projen-tasks-synthesize"></a>
|
|
2645
|
+
|
|
2646
|
+
Synthesizes files to the project output directory.
|
|
2647
|
+
|
|
2648
|
+
```ts
|
|
2649
|
+
synthesize(): void
|
|
2650
|
+
```
|
|
2651
|
+
|
|
2652
|
+
|
|
2653
|
+
|
|
2654
|
+
|
|
2655
|
+
|
|
2641
2656
|
#### tryFind(name)🔹 <a id="projen-tasks-tryfind"></a>
|
|
2642
2657
|
|
|
2643
2658
|
Finds a task by name.
|
|
@@ -2699,6 +2714,7 @@ new TextFile(project: Project, filePath: string, options?: TextFileOptions)
|
|
|
2699
2714
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
2700
2715
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
2701
2716
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
2717
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
2702
2718
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
2703
2719
|
* **lines** (<code>Array<string></code>) The contents of the text file. __*Default*__: [] empty file
|
|
2704
2720
|
|
|
@@ -2755,8 +2771,8 @@ new TomlFile(project: Project, filePath: string, options: TomlFileOptions)
|
|
|
2755
2771
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
2756
2772
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
2757
2773
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
2774
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
2758
2775
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
2759
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
2760
2776
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
2761
2777
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
2762
2778
|
|
|
@@ -2839,8 +2855,8 @@ new XmlFile(project: Project, filePath: string, options?: XmlFileOptions)
|
|
|
2839
2855
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
2840
2856
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
2841
2857
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
2858
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
2842
2859
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
2843
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
2844
2860
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
2845
2861
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
2846
2862
|
|
|
@@ -2884,8 +2900,8 @@ new YamlFile(project: Project, filePath: string, options: YamlFileOptions)
|
|
|
2884
2900
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
2885
2901
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
2886
2902
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
2903
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
2887
2904
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
2888
|
-
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: true
|
|
2889
2905
|
* **obj** (<code>any</code>) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
2890
2906
|
* **omitEmpty** (<code>boolean</code>) Omits empty objects and arrays. __*Default*__: false
|
|
2891
2907
|
* **lineWidth** (<code>number</code>) Maximum line width (set to 0 to disable folding). __*Default*__: 0
|
|
@@ -3046,6 +3062,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
3046
3062
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3047
3063
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3048
3064
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3065
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
3049
3066
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
3050
3067
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
3051
3068
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -3554,6 +3571,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3554
3571
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3555
3572
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3556
3573
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3574
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
3557
3575
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
3558
3576
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
3559
3577
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -3825,6 +3843,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3825
3843
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3826
3844
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3827
3845
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3846
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
3828
3847
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
3829
3848
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
3830
3849
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -4032,6 +4051,7 @@ new build.BuildWorkflow(project: Project, options: BuildWorkflowOptions)
|
|
|
4032
4051
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build. __*Default*__: []
|
|
4033
4052
|
* **preBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute before the build. __*Default*__: []
|
|
4034
4053
|
* **runsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4054
|
+
* **workflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4035
4055
|
|
|
4036
4056
|
|
|
4037
4057
|
|
|
@@ -4248,6 +4268,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4248
4268
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4249
4269
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4250
4270
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4271
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4251
4272
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4252
4273
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
4253
4274
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -4433,6 +4454,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4433
4454
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4434
4455
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4435
4456
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4457
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4436
4458
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4437
4459
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
4438
4460
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -4604,6 +4626,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4604
4626
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4605
4627
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4606
4628
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4629
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4607
4630
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4608
4631
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
4609
4632
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -4779,6 +4802,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4779
4802
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4780
4803
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4781
4804
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4805
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4782
4806
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4783
4807
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
4784
4808
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -4961,6 +4985,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4961
4985
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4962
4986
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4963
4987
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4988
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
4964
4989
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4965
4990
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
4966
4991
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -7016,6 +7041,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
7016
7041
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
7017
7042
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
7018
7043
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
7044
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
7019
7045
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
7020
7046
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
7021
7047
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -8779,6 +8805,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
8779
8805
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8780
8806
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8781
8807
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
8808
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
8782
8809
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
8783
8810
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
8784
8811
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -8929,6 +8956,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8929
8956
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8930
8957
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8931
8958
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
8959
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
8932
8960
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
8933
8961
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
8934
8962
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -9079,6 +9107,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
9079
9107
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9080
9108
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9081
9109
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9110
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9082
9111
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
9083
9112
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
9084
9113
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -9474,6 +9503,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
9474
9503
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9475
9504
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9476
9505
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9506
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9477
9507
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
9478
9508
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
9479
9509
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -9622,6 +9652,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
9622
9652
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9623
9653
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9624
9654
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9655
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9625
9656
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
9626
9657
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
9627
9658
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -9842,6 +9873,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
9842
9873
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9843
9874
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9844
9875
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9876
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
9845
9877
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
9846
9878
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
9847
9879
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -9913,6 +9945,7 @@ new web.ReactTypeDef(project: ReactTypeScriptProject, filePath: string, options?
|
|
|
9913
9945
|
* **committed** (<code>boolean</code>) Indicates whether this file should be committed to git or ignored. __*Default*__: true
|
|
9914
9946
|
* **editGitignore** (<code>boolean</code>) Update the project's .gitignore file. __*Default*__: true
|
|
9915
9947
|
* **executable** (<code>boolean</code>) Whether the generated file should be marked as executable. __*Default*__: false
|
|
9948
|
+
* **marker** (<code>boolean</code>) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
|
|
9916
9949
|
* **readonly** (<code>boolean</code>) Whether the generated file should be readonly. __*Default*__: true
|
|
9917
9950
|
|
|
9918
9951
|
|
|
@@ -10031,6 +10064,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
10031
10064
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
10032
10065
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
10033
10066
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
10067
|
+
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
10034
10068
|
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
10035
10069
|
* **codeCov** (<code>boolean</code>) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. __*Default*__: false
|
|
10036
10070
|
* **codeCovTokenSecret** (<code>string</code>) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
|
|
@@ -10330,6 +10364,7 @@ Name | Type | Description
|
|
|
10330
10364
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10331
10365
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10332
10366
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10367
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10333
10368
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
10334
10369
|
|
|
10335
10370
|
|
|
@@ -10601,7 +10636,7 @@ Name | Type | Description
|
|
|
10601
10636
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10602
10637
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10603
10638
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10604
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
10639
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10605
10640
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
10606
10641
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
10607
10642
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -10638,7 +10673,7 @@ Name | Type | Description
|
|
|
10638
10673
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10639
10674
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10640
10675
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10641
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
10676
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10642
10677
|
**newline**?🔹 | <code>boolean</code> | Adds a newline at the end of the file.<br/>__*Default*__: true
|
|
10643
10678
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
10644
10679
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
@@ -10688,6 +10723,7 @@ Name | Type | Description
|
|
|
10688
10723
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10689
10724
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10690
10725
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10726
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10691
10727
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
10692
10728
|
**rules**?🔹 | <code>Array<[Rule](#projen-rule)></code> | Rules to include in the Makefile.<br/>__*Default*__: []
|
|
10693
10729
|
|
|
@@ -10705,7 +10741,7 @@ Name | Type | Description
|
|
|
10705
10741
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10706
10742
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10707
10743
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10708
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
10744
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10709
10745
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
10710
10746
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
10711
10747
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -10946,6 +10982,7 @@ Name | Type | Description
|
|
|
10946
10982
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10947
10983
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10948
10984
|
**lines**?🔹 | <code>Array<string></code> | The contents of the text file.<br/>__*Default*__: [] empty file
|
|
10985
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10949
10986
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
10950
10987
|
|
|
10951
10988
|
|
|
@@ -10962,7 +10999,7 @@ Name | Type | Description
|
|
|
10962
10999
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10963
11000
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10964
11001
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10965
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
11002
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
10966
11003
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
10967
11004
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
10968
11005
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -10996,7 +11033,7 @@ Name | Type | Description
|
|
|
10996
11033
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
10997
11034
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
10998
11035
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
10999
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
11036
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
11000
11037
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
11001
11038
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
11002
11039
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -11016,7 +11053,7 @@ Name | Type | Description
|
|
|
11016
11053
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
11017
11054
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
11018
11055
|
**lineWidth**?🔹 | <code>number</code> | Maximum line width (set to 0 to disable folding).<br/>__*Default*__: 0
|
|
11019
|
-
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__:
|
|
11056
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
11020
11057
|
**obj**?🔹 | <code>any</code> | The object that will be serialized.<br/>__*Default*__: {} an empty object (use `file.obj` to mutate).
|
|
11021
11058
|
**omitEmpty**?🔹 | <code>boolean</code> | Omits empty objects and arrays.<br/>__*Default*__: false
|
|
11022
11059
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
@@ -11070,6 +11107,7 @@ Name | Type | Description
|
|
|
11070
11107
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11071
11108
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11072
11109
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11110
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11073
11111
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11074
11112
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11075
11113
|
**catalog**?🔹 | <code>[cdk.Catalog](#projen-cdk-catalog)</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.<br/>__*Default*__: new version will be announced
|
|
@@ -11359,6 +11397,7 @@ Name | Type | Description
|
|
|
11359
11397
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11360
11398
|
**buildCommand**?🔹 | <code>string</code> | A command to execute before synthesis.<br/>__*Default*__: no build command
|
|
11361
11399
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11400
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11362
11401
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11363
11402
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11364
11403
|
**cdkAssert**?⚠️ | <code>boolean</code> | Warning: NodeJS only.<br/>__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
|
|
@@ -11557,6 +11596,7 @@ Name | Type | Description
|
|
|
11557
11596
|
**bugsEmail**?⚠️ | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11558
11597
|
**bugsUrl**?⚠️ | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11559
11598
|
**buildWorkflow**?⚠️ | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11599
|
+
**buildWorkflowTriggers**?⚠️ | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11560
11600
|
**bundledDeps**?⚠️ | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11561
11601
|
**bundlerOptions**?⚠️ | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11562
11602
|
**catalog**?⚠️ | <code>[cdk.Catalog](#projen-cdk-catalog)</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.<br/>__*Default*__: new version will be announced
|
|
@@ -11805,6 +11845,7 @@ Name | Type | Description
|
|
|
11805
11845
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build.<br/>__*Default*__: []
|
|
11806
11846
|
**preBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before the build.<br/>__*Default*__: []
|
|
11807
11847
|
**runsOn**?🔹 | <code>Array<string></code> | Github Runner selection labels.<br/>__*Default*__: ["ubuntu-latest"]
|
|
11848
|
+
**workflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11808
11849
|
|
|
11809
11850
|
|
|
11810
11851
|
|
|
@@ -11851,6 +11892,7 @@ Name | Type | Description
|
|
|
11851
11892
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11852
11893
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11853
11894
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11895
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
11854
11896
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11855
11897
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11856
11898
|
**catalog**?🔹 | <code>[cdk.Catalog](#projen-cdk-catalog)</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.<br/>__*Default*__: new version will be announced
|
|
@@ -12068,6 +12110,7 @@ Name | Type | Description
|
|
|
12068
12110
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12069
12111
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12070
12112
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
12113
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
12071
12114
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12072
12115
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
12073
12116
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -12239,6 +12282,7 @@ Name | Type | Description
|
|
|
12239
12282
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12240
12283
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12241
12284
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
12285
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
12242
12286
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12243
12287
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
12244
12288
|
**cdk8sCliVersion**?🔹 | <code>string</code> | cdk8s-cli version.<br/>__*Default*__: "cdk8sVersion"
|
|
@@ -12391,6 +12435,7 @@ Name | Type | Description
|
|
|
12391
12435
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12392
12436
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12393
12437
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
12438
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
12394
12439
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12395
12440
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
12396
12441
|
**catalog**?🔹 | <code>[cdk.Catalog](#projen-cdk-catalog)</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.<br/>__*Default*__: new version will be announced
|
|
@@ -12550,6 +12595,7 @@ Name | Type | Description
|
|
|
12550
12595
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12551
12596
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12552
12597
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
12598
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
12553
12599
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12554
12600
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
12555
12601
|
**catalog**?🔹 | <code>[cdk.Catalog](#projen-cdk-catalog)</code> | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.<br/>__*Default*__: new version will be announced
|
|
@@ -14103,6 +14149,7 @@ Name | Type | Description
|
|
|
14103
14149
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
14104
14150
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
14105
14151
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
14152
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
14106
14153
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
14107
14154
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
14108
14155
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15163,6 +15210,7 @@ Name | Type | Description
|
|
|
15163
15210
|
**bugsEmail**?⚠️ | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15164
15211
|
**bugsUrl**?⚠️ | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15165
15212
|
**buildWorkflow**?⚠️ | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15213
|
+
**buildWorkflowTriggers**?⚠️ | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15166
15214
|
**bundledDeps**?⚠️ | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15167
15215
|
**bundlerOptions**?⚠️ | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15168
15216
|
**clobber**?⚠️ | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15303,6 +15351,7 @@ Name | Type | Description
|
|
|
15303
15351
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15304
15352
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15305
15353
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15354
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15306
15355
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15307
15356
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15308
15357
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15548,6 +15597,7 @@ Name | Type | Description
|
|
|
15548
15597
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15549
15598
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15550
15599
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15600
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15551
15601
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15552
15602
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15553
15603
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15676,6 +15726,7 @@ Name | Type | Description
|
|
|
15676
15726
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15677
15727
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15678
15728
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15729
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15679
15730
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15680
15731
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15681
15732
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15846,6 +15897,7 @@ Name | Type | Description
|
|
|
15846
15897
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
15847
15898
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
15848
15899
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
15900
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
15849
15901
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
15850
15902
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
15851
15903
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
@@ -15972,6 +16024,7 @@ Name | Type | Description
|
|
|
15972
16024
|
**committed**?🔹 | <code>boolean</code> | Indicates whether this file should be committed to git or ignored.<br/>__*Default*__: true
|
|
15973
16025
|
**editGitignore**?🔹 | <code>boolean</code> | Update the project's .gitignore file.<br/>__*Default*__: true
|
|
15974
16026
|
**executable**?🔹 | <code>boolean</code> | Whether the generated file should be marked as executable.<br/>__*Default*__: false
|
|
16027
|
+
**marker**?🔹 | <code>boolean</code> | Adds the projen marker to the file.<br/>__*Default*__: marker will be included as long as the project is not ejected
|
|
15975
16028
|
**readonly**?🔹 | <code>boolean</code> | Whether the generated file should be readonly.<br/>__*Default*__: true
|
|
15976
16029
|
|
|
15977
16030
|
|
|
@@ -16002,6 +16055,7 @@ Name | Type | Description
|
|
|
16002
16055
|
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
16003
16056
|
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
16004
16057
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
16058
|
+
**buildWorkflowTriggers**?🔹 | <code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code> | Build workflow triggers.<br/>__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
16005
16059
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
16006
16060
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
16007
16061
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
package/README.md
CHANGED
package/changelog.md
CHANGED
|
@@ -1,7 +1,2 @@
|
|
|
1
1
|
|
|
2
|
-
### [0.
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
### Features
|
|
6
|
-
|
|
7
|
-
* **cdk8s:** import an explicit k8s spec version ([#1558](https://github.com/projen/projen/issues/1558)) ([01bdd63](https://github.com/projen/projen/commit/01bdd638fa870cf45fd97c1ee8f031f29f815c17)), closes [#1557](https://github.com/projen/projen/issues/1557)
|
|
2
|
+
### [0.52.1](https://github.com/projen/projen/compare/v0.52.0...v0.52.1) (2022-01-26)
|
package/docs/eject.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Ejecting
|
|
2
|
+
|
|
3
|
+
To stop from using projen to manage your project configuration,
|
|
4
|
+
you can `eject` at any time and continue to manage your configuration manually.
|
|
5
|
+
|
|
6
|
+
Running `projen eject` will do the following:
|
|
7
|
+
|
|
8
|
+
- uninstall projen as a project dependency
|
|
9
|
+
- change projen-managed files from readonly to user-writeable
|
|
10
|
+
- remove "Generated by projen" markers from projen-generated files
|
|
11
|
+
- remove projen metadata files
|
|
12
|
+
- remove the projen synthesis step from the `build` task
|
|
13
|
+
- remove the `default` and `eject` tasks
|
|
14
|
+
- "backup" projenrc files to `.projenrc.xyz.bak`
|
|
15
|
+
- a separate task runner file is added to the root directory (see Tasks below
|
|
16
|
+
for more information)
|
|
17
|
+
|
|
18
|
+
You do not need to ever use `eject`, but the option is available if the means of
|
|
19
|
+
customization provided by projen are no longer suitable your project.
|
|
20
|
+
|
|
21
|
+
## Tasks
|
|
22
|
+
|
|
23
|
+
A script will be added to your project so that you can continue using existing
|
|
24
|
+
tasks by running `scripts/run-task <task>` in your command line (or running `npm
|
|
25
|
+
run <task>` in node-based projects) if you so choose. You must retain the
|
|
26
|
+
`tasks.json` file found in the `.projen/` folder to use the task runner.
|
|
27
|
+
|
|
28
|
+
> Note: it is possible some tasks may not work after projen is ejected due to
|
|
29
|
+
the use of projen "builtin" steps. See
|
|
30
|
+
https://github.com/projen/projen/issues/1563 for more information.
|