projen 0.33.9 → 0.34.2
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 +579 -357
- package/API.md +139 -84
- package/docs/aws-lambda.md +5 -4
- package/docs/bundling.md +30 -0
- package/lib/awscdk/auto-discover.d.ts +0 -13
- package/lib/awscdk/auto-discover.js +5 -15
- package/lib/awscdk/cdk-config.js +1 -1
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/java-app.js +1 -1
- package/lib/awscdk/lambda-function.d.ts +16 -26
- package/lib/awscdk/lambda-function.js +29 -27
- package/lib/awscdk-app-ts.js +2 -3
- package/lib/awscdk-construct.js +3 -4
- package/lib/cdk8s-app-ts.js +1 -1
- package/lib/cdk8s-construct.js +1 -1
- package/lib/cdktf-construct.js +1 -1
- package/lib/component.js +1 -1
- package/lib/construct-lib.js +1 -1
- package/lib/deps/dependencies.js +1 -1
- package/lib/dev-env.js +1 -1
- package/lib/docker-compose.js +2 -2
- package/lib/eslint.js +1 -1
- package/lib/file.js +1 -1
- package/lib/git/gitattributes.js +1 -1
- 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.d.ts +15 -0
- package/lib/github/github.js +7 -3
- package/lib/github/index.d.ts +1 -0
- package/lib/github/index.js +2 -1
- package/lib/github/mergify.js +1 -1
- package/lib/github/pr-template.js +1 -1
- package/lib/github/pull-request-lint.d.ts +61 -0
- package/lib/github/pull-request-lint.js +62 -0
- package/lib/github/stale.js +1 -1
- package/lib/github/task-workflow.js +1 -1
- package/lib/github/workflows.js +1 -1
- package/lib/gitpod.js +1 -1
- package/lib/ignore-file.js +1 -1
- package/lib/ini.js +1 -1
- 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 +1 -1
- package/lib/javascript/bundler.d.ts +69 -33
- package/lib/javascript/bundler.js +43 -17
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/projenrc.js +1 -1
- package/lib/javascript/util.d.ts +1 -0
- package/lib/javascript/util.js +16 -0
- package/lib/jest.js +1 -1
- package/lib/jsii-project.js +1 -1
- package/lib/json/projenrc.js +1 -1
- package/lib/json.js +1 -1
- package/lib/license.js +1 -1
- package/lib/logger.js +1 -1
- package/lib/makefile.js +1 -1
- package/lib/node-package.d.ts +7 -0
- package/lib/node-package.js +9 -8
- package/lib/node-project.d.ts +2 -2
- package/lib/node-project.js +15 -14
- package/lib/object-file.js +1 -1
- package/lib/project-build.js +1 -1
- package/lib/project.js +6 -5
- package/lib/projects.js +1 -1
- package/lib/python/pip.js +1 -1
- package/lib/python/poetry.js +2 -2
- package/lib/python/projenrc.js +1 -1
- 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 +1 -1
- package/lib/python/setuppy.js +1 -1
- package/lib/python/setuptools.js +1 -1
- package/lib/python/venv.js +1 -1
- package/lib/readme.js +1 -1
- package/lib/release/publisher.d.ts +7 -0
- package/lib/release/publisher.js +4 -3
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.js +1 -1
- package/lib/sample-file.js +2 -2
- package/lib/semver.js +1 -1
- package/lib/source-code.js +1 -1
- package/lib/tasks/runtime.js +1 -1
- package/lib/tasks/task.js +1 -1
- package/lib/tasks/tasks.js +1 -1
- package/lib/textfile.js +1 -1
- package/lib/toml.js +1 -1
- package/lib/typescript/projenrc.js +1 -1
- package/lib/typescript-config.js +1 -1
- package/lib/typescript.js +3 -3
- package/lib/upgrade-dependencies.js +2 -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 +4 -4
- package/lib/web/tailwind.js +1 -1
- package/lib/xmlfile.js +1 -1
- package/lib/yaml.js +1 -1
- package/package.json +5 -5
package/API.md
CHANGED
|
@@ -63,6 +63,7 @@ Name|Description
|
|
|
63
63
|
[github.GitHub](#projen-github-github)|*No description*
|
|
64
64
|
[github.GithubWorkflow](#projen-github-githubworkflow)|Workflow for GitHub.
|
|
65
65
|
[github.Mergify](#projen-github-mergify)|*No description*
|
|
66
|
+
[github.PullRequestLint](#projen-github-pullrequestlint)|Configure validations to run on GitHub pull requests.
|
|
66
67
|
[github.PullRequestTemplate](#projen-github-pullrequesttemplate)|Template for GitHub pull requests.
|
|
67
68
|
[github.Stale](#projen-github-stale)|Warns and then closes issues and PRs that have had no activity for a specified amount of time.
|
|
68
69
|
[github.TaskWorkflow](#projen-github-taskworkflow)|A GitHub workflow for common build tasks within a project.
|
|
@@ -197,7 +198,9 @@ Name|Description
|
|
|
197
198
|
[github.MergifyConditionalOperator](#projen-github-mergifyconditionaloperator)|The Mergify conditional operators that can be used are: `or` and `and`.
|
|
198
199
|
[github.MergifyOptions](#projen-github-mergifyoptions)|*No description*
|
|
199
200
|
[github.MergifyRule](#projen-github-mergifyrule)|*No description*
|
|
201
|
+
[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)|Options for PullRequestLint.
|
|
200
202
|
[github.PullRequestTemplateOptions](#projen-github-pullrequesttemplateoptions)|Options for `PullRequestTemplate`.
|
|
203
|
+
[github.SemanticTitleOptions](#projen-github-semantictitleoptions)|Options for linting that PR titles follow Conventional Commits.
|
|
201
204
|
[github.StaleBehavior](#projen-github-stalebehavior)|Stale behavior.
|
|
202
205
|
[github.StaleOptions](#projen-github-staleoptions)|Options for `Stale`.
|
|
203
206
|
[github.TaskWorkflowOptions](#projen-github-taskworkflowoptions)|*No description*
|
|
@@ -211,9 +214,10 @@ Name|Description
|
|
|
211
214
|
[java.PluginOptions](#projen-java-pluginoptions)|Options for Maven plugins.
|
|
212
215
|
[java.PomOptions](#projen-java-pomoptions)|Options for `Pom`.
|
|
213
216
|
[java.ProjenrcOptions](#projen-java-projenrcoptions)|Options for `Projenrc`.
|
|
214
|
-
[javascript.
|
|
215
|
-
[javascript.
|
|
217
|
+
[javascript.AddBundleOptions](#projen-javascript-addbundleoptions)|Options for `addBundle()`.
|
|
218
|
+
[javascript.Bundle](#projen-javascript-bundle)|*No description*
|
|
216
219
|
[javascript.BundlerOptions](#projen-javascript-bundleroptions)|Options for `Bundler`.
|
|
220
|
+
[javascript.BundlingOptions](#projen-javascript-bundlingoptions)|Options for bundling.
|
|
217
221
|
[javascript.NpmConfigOptions](#projen-javascript-npmconfigoptions)|Options to configure the local NPM config.
|
|
218
222
|
[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)|*No description*
|
|
219
223
|
[json.ProjenrcOptions](#projen-json-projenrcoptions)|*No description*
|
|
@@ -407,7 +411,7 @@ new AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
407
411
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
408
412
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
409
413
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
410
|
-
* **bundlerOptions** (<code>[javascript.
|
|
414
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
411
415
|
* **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
|
|
412
416
|
* **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
|
|
413
417
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -618,7 +622,7 @@ new AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
618
622
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
619
623
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
620
624
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
621
|
-
* **bundlerOptions** (<code>[javascript.
|
|
625
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
622
626
|
* **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
|
|
623
627
|
* **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
|
|
624
628
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -796,7 +800,7 @@ new Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
796
800
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
797
801
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
798
802
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
799
|
-
* **bundlerOptions** (<code>[javascript.
|
|
803
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
800
804
|
* **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
|
|
801
805
|
* **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
|
|
802
806
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -1027,7 +1031,7 @@ new ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
1027
1031
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
1028
1032
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
1029
1033
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
1030
|
-
* **bundlerOptions** (<code>[javascript.
|
|
1034
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
1031
1035
|
* **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
|
|
1032
1036
|
* **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
|
|
1033
1037
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -1182,7 +1186,7 @@ new ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
1182
1186
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
1183
1187
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
1184
1188
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
1185
|
-
* **bundlerOptions** (<code>[javascript.
|
|
1189
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
1186
1190
|
* **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
|
|
1187
1191
|
* **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
|
|
1188
1192
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -1350,7 +1354,7 @@ new ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
1350
1354
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
1351
1355
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
1352
1356
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
1353
|
-
* **bundlerOptions** (<code>[javascript.
|
|
1357
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
1354
1358
|
* **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
|
|
1355
1359
|
* **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
|
|
1356
1360
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -1525,7 +1529,7 @@ new ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
1525
1529
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
1526
1530
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
1527
1531
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
1528
|
-
* **bundlerOptions** (<code>[javascript.
|
|
1532
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
1529
1533
|
* **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
|
|
1530
1534
|
* **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
|
|
1531
1535
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -2598,7 +2602,7 @@ new JsiiProject(options: JsiiProjectOptions)
|
|
|
2598
2602
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
2599
2603
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
2600
2604
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
2601
|
-
* **bundlerOptions** (<code>[javascript.
|
|
2605
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
2602
2606
|
* **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
|
|
2603
2607
|
* **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
|
|
2604
2608
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -3352,7 +3356,7 @@ new NodeProject(options: NodeProjectOptions)
|
|
|
3352
3356
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3353
3357
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3354
3358
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3355
|
-
* **bundlerOptions** (<code>[javascript.
|
|
3359
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
3356
3360
|
* **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
|
|
3357
3361
|
* **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
|
|
3358
3362
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -4517,7 +4521,7 @@ new TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
4517
4521
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4518
4522
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4519
4523
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4520
|
-
* **bundlerOptions** (<code>[javascript.
|
|
4524
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4521
4525
|
* **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
|
|
4522
4526
|
* **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
|
|
4523
4527
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -4658,7 +4662,7 @@ new TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
4658
4662
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4659
4663
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4660
4664
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4661
|
-
* **bundlerOptions** (<code>[javascript.
|
|
4665
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4662
4666
|
* **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
|
|
4663
4667
|
* **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
|
|
4664
4668
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -4799,7 +4803,7 @@ new TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
4799
4803
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4800
4804
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4801
4805
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4802
|
-
* **bundlerOptions** (<code>[javascript.
|
|
4806
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
4803
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
|
|
4804
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
|
|
4805
4809
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -5169,26 +5173,10 @@ new awscdk.AutoDiscover(project: Project, options: AutoDiscoverOptions)
|
|
|
5169
5173
|
|
|
5170
5174
|
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
5171
5175
|
* **options** (<code>[awscdk.AutoDiscoverOptions](#projen-awscdk-autodiscoveroptions)</code>) *No description*
|
|
5172
|
-
* **libdir** (<code>string</code>) Output directory (where .js files go).
|
|
5173
5176
|
* **srcdir** (<code>string</code>) Project source tree (relative to project output directory).
|
|
5174
5177
|
* **lambdaOptions** (<code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code>) Options for auto-discovery of AWS Lambda functions. __*Optional*__
|
|
5175
5178
|
|
|
5176
5179
|
|
|
5177
|
-
### Methods
|
|
5178
|
-
|
|
5179
|
-
|
|
5180
|
-
#### preSynthesize()🔹 <a id="projen-awscdk-autodiscover-presynthesize"></a>
|
|
5181
|
-
|
|
5182
|
-
Called before synthesis.
|
|
5183
|
-
|
|
5184
|
-
```ts
|
|
5185
|
-
preSynthesize(): void
|
|
5186
|
-
```
|
|
5187
|
-
|
|
5188
|
-
|
|
5189
|
-
|
|
5190
|
-
|
|
5191
|
-
|
|
5192
5180
|
|
|
5193
5181
|
|
|
5194
5182
|
## class AwsCdkJavaApp 🔹 <a id="projen-awscdk-awscdkjavaapp"></a>
|
|
@@ -5386,24 +5374,14 @@ new awscdk.LambdaFunction(project: Project, options: LambdaFunctionOptions)
|
|
|
5386
5374
|
|
|
5387
5375
|
* **project** (<code>[Project](#projen-project)</code>) The project to use.
|
|
5388
5376
|
* **options** (<code>[awscdk.LambdaFunctionOptions](#projen-awscdk-lambdafunctionoptions)</code>) Options.
|
|
5389
|
-
* **
|
|
5377
|
+
* **bundlingOptions** (<code>[javascript.BundlingOptions](#projen-javascript-bundlingoptions)</code>) Bundling options for this AWS Lambda function. __*Default*__: defaults
|
|
5390
5378
|
* **runtime** (<code>[awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)</code>) The node.js version to target. __*Default*__: Runtime.NODEJS_14_X
|
|
5391
5379
|
* **entrypoint** (<code>string</code>) A path from the project root directory to a TypeScript file which contains the AWS Lambda handler entrypoint (exports a `handler` function).
|
|
5392
|
-
* **libdir** (<code>string</code>) JavaScript output directory (where .js files go).
|
|
5393
|
-
* **srcdir** (<code>string</code>) Project source directory tree (where .ts files live).
|
|
5394
5380
|
* **constructFile** (<code>string</code>) The name of the generated TypeScript source file. __*Default*__: The name of the entrypoint file, with the `-function.ts` suffix instead of `.lambda.ts`.
|
|
5395
5381
|
* **constructName** (<code>string</code>) The name of the generated `lambda.Function` subclass. __*Default*__: A pascal cased version of the name of the entrypoint file, with the extension `Function` (e.g. `ResizeImageFunction`).
|
|
5396
5382
|
|
|
5397
5383
|
|
|
5398
5384
|
|
|
5399
|
-
### Properties
|
|
5400
|
-
|
|
5401
|
-
|
|
5402
|
-
Name | Type | Description
|
|
5403
|
-
-----|------|-------------
|
|
5404
|
-
**bundleTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The bundle task for this function.
|
|
5405
|
-
|
|
5406
|
-
|
|
5407
5385
|
|
|
5408
5386
|
## class LambdaRuntime 🔹 <a id="projen-awscdk-lambdaruntime"></a>
|
|
5409
5387
|
|
|
@@ -5724,6 +5702,8 @@ new github.GitHub(project: Project, options?: GitHubOptions)
|
|
|
5724
5702
|
* **options** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) *No description*
|
|
5725
5703
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5726
5704
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for Mergify. __*Default*__: default options
|
|
5705
|
+
* **pullRequestLint** (<code>boolean</code>) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits. __*Default*__: true
|
|
5706
|
+
* **pullRequestLintOptions** (<code>[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)</code>) Options for configuring a pull request linter. __*Default*__: see defaults in `PullRequestLintOptions`
|
|
5727
5707
|
* **workflows** (<code>boolean</code>) Enables GitHub workflows. __*Default*__: true
|
|
5728
5708
|
|
|
5729
5709
|
|
|
@@ -5942,6 +5922,33 @@ addRule(rule: MergifyRule): void
|
|
|
5942
5922
|
|
|
5943
5923
|
|
|
5944
5924
|
|
|
5925
|
+
## class PullRequestLint 🔹 <a id="projen-github-pullrequestlint"></a>
|
|
5926
|
+
|
|
5927
|
+
Configure validations to run on GitHub pull requests.
|
|
5928
|
+
|
|
5929
|
+
Only generates a file if at least one linter is configured.
|
|
5930
|
+
|
|
5931
|
+
__Submodule__: github
|
|
5932
|
+
|
|
5933
|
+
__Extends__: [Component](#projen-component)
|
|
5934
|
+
|
|
5935
|
+
### Initializer
|
|
5936
|
+
|
|
5937
|
+
|
|
5938
|
+
|
|
5939
|
+
|
|
5940
|
+
```ts
|
|
5941
|
+
new github.PullRequestLint(github: GitHub, options?: PullRequestLintOptions)
|
|
5942
|
+
```
|
|
5943
|
+
|
|
5944
|
+
* **github** (<code>[github.GitHub](#projen-github-github)</code>) *No description*
|
|
5945
|
+
* **options** (<code>[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)</code>) *No description*
|
|
5946
|
+
* **semanticTitle** (<code>boolean</code>) Validate that pull request titles follow Conventional Commits. __*Default*__: true
|
|
5947
|
+
* **semanticTitleOptions** (<code>[github.SemanticTitleOptions](#projen-github-semantictitleoptions)</code>) Options for validating the conventional commit title linter. __*Default*__: title must start with "feat", "fix", or "chore"
|
|
5948
|
+
|
|
5949
|
+
|
|
5950
|
+
|
|
5951
|
+
|
|
5945
5952
|
## class PullRequestTemplate 🔹 <a id="projen-github-pullrequesttemplate"></a>
|
|
5946
5953
|
|
|
5947
5954
|
Template for GitHub pull requests.
|
|
@@ -6421,6 +6428,8 @@ Name | Type | Description
|
|
|
6421
6428
|
|
|
6422
6429
|
Adds support for bundling JavaScript applications and dependencies into a single file.
|
|
6423
6430
|
|
|
6431
|
+
In the future, this will also supports bundling websites.
|
|
6432
|
+
|
|
6424
6433
|
__Submodule__: javascript
|
|
6425
6434
|
|
|
6426
6435
|
__Extends__: [Component](#projen-component)
|
|
@@ -6436,6 +6445,7 @@ new javascript.Bundler(project: Project, options?: BundlerOptions)
|
|
|
6436
6445
|
|
|
6437
6446
|
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
6438
6447
|
* **options** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) *No description*
|
|
6448
|
+
* **assetsDir** (<code>string</code>) Output directory for all bundles. __*Default*__: "assets"
|
|
6439
6449
|
* **esbuildVersion** (<code>string</code>) The semantic version requirement for `esbuild`. __*Default*__: no specific version (implies latest)
|
|
6440
6450
|
|
|
6441
6451
|
|
|
@@ -6446,31 +6456,30 @@ new javascript.Bundler(project: Project, options?: BundlerOptions)
|
|
|
6446
6456
|
Name | Type | Description
|
|
6447
6457
|
-----|------|-------------
|
|
6448
6458
|
**bundleTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | Gets or creates the singleton "bundle" task of the project.
|
|
6449
|
-
**
|
|
6459
|
+
**bundledir**🔹 | <code>string</code> | Root bundle directory.
|
|
6460
|
+
**esbuildVersion**?🔹 | <code>string</code> | The semantic version requirement for `esbuild` (if defined).<br/>__*Optional*__
|
|
6450
6461
|
|
|
6451
6462
|
### Methods
|
|
6452
6463
|
|
|
6453
6464
|
|
|
6454
|
-
#### addBundle(
|
|
6465
|
+
#### addBundle(entrypoint, options)🔹 <a id="projen-javascript-bundler-addbundle"></a>
|
|
6455
6466
|
|
|
6456
6467
|
Adds a task to the project which bundles a specific entrypoint and all of its dependencies into a single javascript output file.
|
|
6457
6468
|
|
|
6458
6469
|
```ts
|
|
6459
|
-
addBundle(
|
|
6470
|
+
addBundle(entrypoint: string, options: AddBundleOptions): Bundle
|
|
6460
6471
|
```
|
|
6461
6472
|
|
|
6462
|
-
* **
|
|
6463
|
-
* **options** (<code>[javascript.
|
|
6464
|
-
* **entrypoint** (<code>string</code>) The entrypoint of the code you wish to bundle.
|
|
6465
|
-
* **outfile** (<code>string</code>) This option sets the output file name for the build operation.
|
|
6466
|
-
* **platform** (<code>string</code>) esbuild platform.
|
|
6467
|
-
* **target** (<code>string</code>) esbuild target.
|
|
6473
|
+
* **entrypoint** (<code>string</code>) *No description*
|
|
6474
|
+
* **options** (<code>[javascript.AddBundleOptions](#projen-javascript-addbundleoptions)</code>) Bundling options.
|
|
6468
6475
|
* **externals** (<code>Array<string></code>) You can mark a file or a package as external to exclude it from your build. __*Default*__: []
|
|
6469
|
-
* **sourcemap** (<code>boolean</code>) Include a source map in the bundle. __*Default*__:
|
|
6476
|
+
* **sourcemap** (<code>boolean</code>) Include a source map in the bundle. __*Default*__: false
|
|
6470
6477
|
* **watchTask** (<code>boolean</code>) In addition to the `bundle:xyz` task, creates `bundle:xyz:watch` task which will invoke the same esbuild command with the `--watch` flag. __*Default*__: true
|
|
6478
|
+
* **platform** (<code>string</code>) esbuild platform.
|
|
6479
|
+
* **target** (<code>string</code>) esbuild target.
|
|
6471
6480
|
|
|
6472
6481
|
__Returns__:
|
|
6473
|
-
* <code>[
|
|
6482
|
+
* <code>[javascript.Bundle](#projen-javascript-bundle)</code>
|
|
6474
6483
|
|
|
6475
6484
|
#### *static* of(project)🔹 <a id="projen-javascript-bundler-of"></a>
|
|
6476
6485
|
|
|
@@ -8263,7 +8272,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8263
8272
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8264
8273
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8265
8274
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
8266
|
-
* **bundlerOptions** (<code>[javascript.
|
|
8275
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
8267
8276
|
* **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
|
|
8268
8277
|
* **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
|
|
8269
8278
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -8403,7 +8412,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8403
8412
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8404
8413
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8405
8414
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
8406
|
-
* **bundlerOptions** (<code>[javascript.
|
|
8415
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
8407
8416
|
* **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
|
|
8408
8417
|
* **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
|
|
8409
8418
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -8616,7 +8625,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
8616
8625
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8617
8626
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8618
8627
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
8619
|
-
* **bundlerOptions** (<code>[javascript.
|
|
8628
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
8620
8629
|
* **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
|
|
8621
8630
|
* **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
|
|
8622
8631
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -8797,7 +8806,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
8797
8806
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8798
8807
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8799
8808
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
8800
|
-
* **bundlerOptions** (<code>[javascript.
|
|
8809
|
+
* **bundlerOptions** (<code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code>) Options for `Bundler`. __*Optional*__
|
|
8801
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
|
|
8802
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
|
|
8803
8812
|
* **copyrightOwner** (<code>string</code>) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
@@ -8923,7 +8932,7 @@ Name | Type | Description
|
|
|
8923
8932
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
8924
8933
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
8925
8934
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
8926
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
8935
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
8927
8936
|
**catalog**?🔹 | <code>[Catalog](#projen-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
|
|
8928
8937
|
**cdkAssert**?🔹 | <code>boolean</code> | Install the @aws-cdk/assert library?<br/>__*Default*__: true
|
|
8929
8938
|
**cdkDependencies**?🔹 | <code>Array<string></code> | Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?<br/>__*Optional*__
|
|
@@ -9077,7 +9086,7 @@ Name | Type | Description
|
|
|
9077
9086
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
9078
9087
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
9079
9088
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
9080
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
9089
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
9081
9090
|
**cdkDependencies**?🔹 | <code>Array<string></code> | Which AWS CDK modules (those that start with "@aws-cdk/") this app uses.<br/>__*Optional*__
|
|
9082
9091
|
**cdkVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for CDK.<br/>__*Default*__: false
|
|
9083
9092
|
**cdkout**?🔹 | <code>string</code> | cdk.out directory.<br/>__*Default*__: "cdk.out"
|
|
@@ -9234,7 +9243,7 @@ Name | Type | Description
|
|
|
9234
9243
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
9235
9244
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
9236
9245
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
9237
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
9246
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
9238
9247
|
**cdk8sCliVersion**?🔹 | <code>string</code> | cdk8s-cli version.<br/>__*Default*__: "cdk8sVersion"
|
|
9239
9248
|
**cdk8sCliVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for CDK8s-cli.<br/>__*Default*__: false
|
|
9240
9249
|
**cdk8sPlusVersion**?🔹 | <code>string</code> | cdk8s-plus-17 version.<br/>__*Default*__: "cdk8sVersion"
|
|
@@ -9358,6 +9367,7 @@ Name | Type | Description
|
|
|
9358
9367
|
Name | Type | Description
|
|
9359
9368
|
-----|------|-------------
|
|
9360
9369
|
**accessKeyIdSecret**?🔹 | <code>string</code> | GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.<br/>__*Default*__: "AWS_ACCESS_KEY_ID"
|
|
9370
|
+
**roleToAssume**?🔹 | <code>string</code> | ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (`registry` contains AWS CodeArtifact URL).<br/>__*Default*__: undefined
|
|
9361
9371
|
**secretAccessKeySecret**?🔹 | <code>string</code> | GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.<br/>__*Default*__: "AWS_SECRET_ACCESS_KEY"
|
|
9362
9372
|
|
|
9363
9373
|
|
|
@@ -9392,7 +9402,7 @@ Name | Type | Description
|
|
|
9392
9402
|
**bin**?⚠️ | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
9393
9403
|
**buildWorkflow**?⚠️ | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
9394
9404
|
**bundledDeps**?⚠️ | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
9395
|
-
**bundlerOptions**?⚠️ | <code>[javascript.
|
|
9405
|
+
**bundlerOptions**?⚠️ | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
9396
9406
|
**catalog**?⚠️ | <code>[Catalog](#projen-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
|
|
9397
9407
|
**cdkAssert**?⚠️ | <code>boolean</code> | Install the @aws-cdk/assert library?<br/>__*Default*__: true
|
|
9398
9408
|
**cdkDependencies**?⚠️ | <code>Array<string></code> | Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?<br/>__*Optional*__
|
|
@@ -9548,7 +9558,7 @@ Name | Type | Description
|
|
|
9548
9558
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
9549
9559
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
9550
9560
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
9551
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
9561
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
9552
9562
|
**catalog**?🔹 | <code>[Catalog](#projen-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
|
|
9553
9563
|
**cdk8sPlusVersion**?🔹 | <code>string</code> | cdk8s-plus-17 version.<br/>__*Default*__: "cdk8sVersion"
|
|
9554
9564
|
**cdk8sPlusVersionPinning**?🔹 | <code>boolean</code> | Use pinned version instead of caret version for cdk8s-plus-17.<br/>__*Default*__: false
|
|
@@ -9701,7 +9711,7 @@ Name | Type | Description
|
|
|
9701
9711
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
9702
9712
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
9703
9713
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
9704
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
9714
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
9705
9715
|
**catalog**?🔹 | <code>[Catalog](#projen-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
|
|
9706
9716
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
9707
9717
|
**codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
@@ -9848,7 +9858,7 @@ Name | Type | Description
|
|
|
9848
9858
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
9849
9859
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
9850
9860
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
9851
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
9861
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
9852
9862
|
**catalog**?🔹 | <code>[Catalog](#projen-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
|
|
9853
9863
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
9854
9864
|
**codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
@@ -10684,7 +10694,7 @@ Name | Type | Description
|
|
|
10684
10694
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
10685
10695
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
10686
10696
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
10687
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
10697
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
10688
10698
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
10689
10699
|
**codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
10690
10700
|
**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.<br/>__*Default*__: false
|
|
@@ -10972,7 +10982,7 @@ Name | Type | Description
|
|
|
10972
10982
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
10973
10983
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
10974
10984
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
10975
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
10985
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
10976
10986
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
10977
10987
|
**codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
10978
10988
|
**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.<br/>__*Default*__: false
|
|
@@ -11323,7 +11333,7 @@ Name | Type | Description
|
|
|
11323
11333
|
**bin**?⚠️ | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
11324
11334
|
**buildWorkflow**?⚠️ | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11325
11335
|
**bundledDeps**?⚠️ | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11326
|
-
**bundlerOptions**?⚠️ | <code>[javascript.
|
|
11336
|
+
**bundlerOptions**?⚠️ | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11327
11337
|
**clobber**?⚠️ | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
11328
11338
|
**codeArtifactOptions**?⚠️ | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
11329
11339
|
**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.<br/>__*Default*__: false
|
|
@@ -11456,7 +11466,7 @@ Name | Type | Description
|
|
|
11456
11466
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
11457
11467
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11458
11468
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11459
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
11469
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
11460
11470
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
11461
11471
|
**codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
11462
11472
|
**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.<br/>__*Default*__: false
|
|
@@ -11680,7 +11690,6 @@ Options for `AutoDiscover`.
|
|
|
11680
11690
|
|
|
11681
11691
|
Name | Type | Description
|
|
11682
11692
|
-----|------|-------------
|
|
11683
|
-
**libdir**🔹 | <code>string</code> | Output directory (where .js files go).
|
|
11684
11693
|
**srcdir**🔹 | <code>string</code> | Project source tree (relative to project output directory).
|
|
11685
11694
|
**lambdaOptions**?🔹 | <code>[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)</code> | Options for auto-discovery of AWS Lambda functions.<br/>__*Optional*__
|
|
11686
11695
|
|
|
@@ -11788,7 +11797,7 @@ auto-discovery.
|
|
|
11788
11797
|
|
|
11789
11798
|
Name | Type | Description
|
|
11790
11799
|
-----|------|-------------
|
|
11791
|
-
**
|
|
11800
|
+
**bundlingOptions**?🔹 | <code>[javascript.BundlingOptions](#projen-javascript-bundlingoptions)</code> | Bundling options for this AWS Lambda function.<br/>__*Default*__: defaults
|
|
11792
11801
|
**runtime**?🔹 | <code>[awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)</code> | The node.js version to target.<br/>__*Default*__: Runtime.NODEJS_14_X
|
|
11793
11802
|
|
|
11794
11803
|
|
|
@@ -11803,11 +11812,9 @@ Options for `Function`.
|
|
|
11803
11812
|
Name | Type | Description
|
|
11804
11813
|
-----|------|-------------
|
|
11805
11814
|
**entrypoint**🔹 | <code>string</code> | A path from the project root directory to a TypeScript file which contains the AWS Lambda handler entrypoint (exports a `handler` function).
|
|
11806
|
-
**
|
|
11807
|
-
**srcdir**🔹 | <code>string</code> | Project source directory tree (where .ts files live).
|
|
11815
|
+
**bundlingOptions**?🔹 | <code>[javascript.BundlingOptions](#projen-javascript-bundlingoptions)</code> | Bundling options for this AWS Lambda function.<br/>__*Default*__: defaults
|
|
11808
11816
|
**constructFile**?🔹 | <code>string</code> | The name of the generated TypeScript source file.<br/>__*Default*__: The name of the entrypoint file, with the `-function.ts` suffix instead of `.lambda.ts`.
|
|
11809
11817
|
**constructName**?🔹 | <code>string</code> | The name of the generated `lambda.Function` subclass.<br/>__*Default*__: A pascal cased version of the name of the entrypoint file, with the extension `Function` (e.g. `ResizeImageFunction`).
|
|
11810
|
-
**externals**?🔹 | <code>Array<string></code> | Names of modules which should not be included in the bundle.<br/>__*Default*__: by default, the "aws-sdk" module will be excluded from the bundle. Note that if you use this option you will need to add "aws-sdk" explicitly.
|
|
11811
11818
|
**runtime**?🔹 | <code>[awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)</code> | The node.js version to target.<br/>__*Default*__: Runtime.NODEJS_14_X
|
|
11812
11819
|
|
|
11813
11820
|
|
|
@@ -11952,6 +11959,8 @@ Name | Type | Description
|
|
|
11952
11959
|
-----|------|-------------
|
|
11953
11960
|
**mergify**?🔹 | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
|
|
11954
11961
|
**mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for Mergify.<br/>__*Default*__: default options
|
|
11962
|
+
**pullRequestLint**?🔹 | <code>boolean</code> | Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.<br/>__*Default*__: true
|
|
11963
|
+
**pullRequestLintOptions**?🔹 | <code>[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)</code> | Options for configuring a pull request linter.<br/>__*Default*__: see defaults in `PullRequestLintOptions`
|
|
11955
11964
|
**workflows**?🔹 | <code>boolean</code> | Enables GitHub workflows.<br/>__*Default*__: true
|
|
11956
11965
|
|
|
11957
11966
|
|
|
@@ -12028,6 +12037,20 @@ Name | Type | Description
|
|
|
12028
12037
|
|
|
12029
12038
|
|
|
12030
12039
|
|
|
12040
|
+
## struct PullRequestLintOptions 🔹 <a id="projen-github-pullrequestlintoptions"></a>
|
|
12041
|
+
|
|
12042
|
+
|
|
12043
|
+
Options for PullRequestLint.
|
|
12044
|
+
|
|
12045
|
+
|
|
12046
|
+
|
|
12047
|
+
Name | Type | Description
|
|
12048
|
+
-----|------|-------------
|
|
12049
|
+
**semanticTitle**?🔹 | <code>boolean</code> | Validate that pull request titles follow Conventional Commits.<br/>__*Default*__: true
|
|
12050
|
+
**semanticTitleOptions**?🔹 | <code>[github.SemanticTitleOptions](#projen-github-semantictitleoptions)</code> | Options for validating the conventional commit title linter.<br/>__*Default*__: title must start with "feat", "fix", or "chore"
|
|
12051
|
+
|
|
12052
|
+
|
|
12053
|
+
|
|
12031
12054
|
## struct PullRequestTemplateOptions 🔹 <a id="projen-github-pullrequesttemplateoptions"></a>
|
|
12032
12055
|
|
|
12033
12056
|
|
|
@@ -12041,6 +12064,20 @@ Name | Type | Description
|
|
|
12041
12064
|
|
|
12042
12065
|
|
|
12043
12066
|
|
|
12067
|
+
## struct SemanticTitleOptions 🔹 <a id="projen-github-semantictitleoptions"></a>
|
|
12068
|
+
|
|
12069
|
+
|
|
12070
|
+
Options for linting that PR titles follow Conventional Commits.
|
|
12071
|
+
|
|
12072
|
+
|
|
12073
|
+
|
|
12074
|
+
Name | Type | Description
|
|
12075
|
+
-----|------|-------------
|
|
12076
|
+
**requireScope**?🔹 | <code>boolean</code> | Configure that a scope must always be provided.<br/>__*Default*__: false
|
|
12077
|
+
**types**?🔹 | <code>Array<string></code> | Configure a list of commit types that are allowed.<br/>__*Default*__: ["feat", "fix", "chore"]
|
|
12078
|
+
|
|
12079
|
+
|
|
12080
|
+
|
|
12044
12081
|
## struct StaleBehavior 🔹 <a id="projen-github-stalebehavior"></a>
|
|
12045
12082
|
|
|
12046
12083
|
|
|
@@ -12318,35 +12355,36 @@ Name | Type | Description
|
|
|
12318
12355
|
|
|
12319
12356
|
|
|
12320
12357
|
|
|
12321
|
-
## struct
|
|
12358
|
+
## struct AddBundleOptions 🔹 <a id="projen-javascript-addbundleoptions"></a>
|
|
12322
12359
|
|
|
12323
12360
|
|
|
12324
|
-
Options for
|
|
12361
|
+
Options for `addBundle()`.
|
|
12325
12362
|
|
|
12326
12363
|
|
|
12327
12364
|
|
|
12328
12365
|
Name | Type | Description
|
|
12329
12366
|
-----|------|-------------
|
|
12330
|
-
**entrypoint**🔹 | <code>string</code> | The entrypoint of the code you wish to bundle.
|
|
12331
|
-
**outfile**🔹 | <code>string</code> | This option sets the output file name for the build operation.
|
|
12332
12367
|
**platform**🔹 | <code>string</code> | esbuild platform.
|
|
12333
12368
|
**target**🔹 | <code>string</code> | esbuild target.
|
|
12334
12369
|
**externals**?🔹 | <code>Array<string></code> | You can mark a file or a package as external to exclude it from your build.<br/>__*Default*__: []
|
|
12335
|
-
**sourcemap**?🔹 | <code>boolean</code> | Include a source map in the bundle.<br/>__*Default*__:
|
|
12370
|
+
**sourcemap**?🔹 | <code>boolean</code> | Include a source map in the bundle.<br/>__*Default*__: false
|
|
12336
12371
|
**watchTask**?🔹 | <code>boolean</code> | In addition to the `bundle:xyz` task, creates `bundle:xyz:watch` task which will invoke the same esbuild command with the `--watch` flag.<br/>__*Default*__: true
|
|
12337
12372
|
|
|
12338
12373
|
|
|
12339
12374
|
|
|
12340
|
-
## struct
|
|
12375
|
+
## struct Bundle 🔹 <a id="projen-javascript-bundle"></a>
|
|
12376
|
+
|
|
12377
|
+
__Obtainable from__: [Bundler](#projen-javascript-bundler).[addBundle](#projen-javascript-bundler#projen-javascript-bundler-addbundle)()
|
|
12341
12378
|
|
|
12342
12379
|
|
|
12343
|
-
Common options for `Bundler`.
|
|
12344
12380
|
|
|
12345
12381
|
|
|
12346
12382
|
|
|
12347
12383
|
Name | Type | Description
|
|
12348
12384
|
-----|------|-------------
|
|
12349
|
-
**
|
|
12385
|
+
**bundleTask**🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The task that produces this bundle.
|
|
12386
|
+
**outfile**🔹 | <code>string</code> | Location of the output file (relative to project root).
|
|
12387
|
+
**watchTask**?🔹 | <code>[tasks.Task](#projen-tasks-task)</code> | The "watch" task for this bundle.<br/>__*Optional*__
|
|
12350
12388
|
|
|
12351
12389
|
|
|
12352
12390
|
|
|
@@ -12359,10 +12397,26 @@ Options for `Bundler`.
|
|
|
12359
12397
|
|
|
12360
12398
|
Name | Type | Description
|
|
12361
12399
|
-----|------|-------------
|
|
12400
|
+
**assetsDir**?🔹 | <code>string</code> | Output directory for all bundles.<br/>__*Default*__: "assets"
|
|
12362
12401
|
**esbuildVersion**?🔹 | <code>string</code> | The semantic version requirement for `esbuild`.<br/>__*Default*__: no specific version (implies latest)
|
|
12363
12402
|
|
|
12364
12403
|
|
|
12365
12404
|
|
|
12405
|
+
## struct BundlingOptions 🔹 <a id="projen-javascript-bundlingoptions"></a>
|
|
12406
|
+
|
|
12407
|
+
|
|
12408
|
+
Options for bundling.
|
|
12409
|
+
|
|
12410
|
+
|
|
12411
|
+
|
|
12412
|
+
Name | Type | Description
|
|
12413
|
+
-----|------|-------------
|
|
12414
|
+
**externals**?🔹 | <code>Array<string></code> | You can mark a file or a package as external to exclude it from your build.<br/>__*Default*__: []
|
|
12415
|
+
**sourcemap**?🔹 | <code>boolean</code> | Include a source map in the bundle.<br/>__*Default*__: false
|
|
12416
|
+
**watchTask**?🔹 | <code>boolean</code> | In addition to the `bundle:xyz` task, creates `bundle:xyz:watch` task which will invoke the same esbuild command with the `--watch` flag.<br/>__*Default*__: true
|
|
12417
|
+
|
|
12418
|
+
|
|
12419
|
+
|
|
12366
12420
|
## struct NpmConfigOptions 🔹 <a id="projen-javascript-npmconfigoptions"></a>
|
|
12367
12421
|
|
|
12368
12422
|
|
|
@@ -12765,6 +12819,7 @@ Name | Type | Description
|
|
|
12765
12819
|
Name | Type | Description
|
|
12766
12820
|
-----|------|-------------
|
|
12767
12821
|
**accessKeyIdSecret**?🔹 | <code>string</code> | GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.<br/>__*Default*__: "AWS_ACCESS_KEY_ID"
|
|
12822
|
+
**roleToAssume**?🔹 | <code>string</code> | ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (`registry` contains AWS CodeArtifact URL).<br/>__*Default*__: undefined
|
|
12768
12823
|
**secretAccessKeySecret**?🔹 | <code>string</code> | GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.<br/>__*Default*__: "AWS_SECRET_ACCESS_KEY"
|
|
12769
12824
|
|
|
12770
12825
|
|
|
@@ -13303,7 +13358,7 @@ Name | Type | Description
|
|
|
13303
13358
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
13304
13359
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
13305
13360
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
13306
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
13361
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
13307
13362
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
13308
13363
|
**codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
13309
13364
|
**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.<br/>__*Default*__: false
|
|
@@ -13423,7 +13478,7 @@ Name | Type | Description
|
|
|
13423
13478
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
13424
13479
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
13425
13480
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
13426
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
13481
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
13427
13482
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
13428
13483
|
**codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
13429
13484
|
**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.<br/>__*Default*__: false
|
|
@@ -13586,7 +13641,7 @@ Name | Type | Description
|
|
|
13586
13641
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
13587
13642
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
13588
13643
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
13589
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
13644
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
13590
13645
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
13591
13646
|
**codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
13592
13647
|
**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.<br/>__*Default*__: false
|
|
@@ -13734,7 +13789,7 @@ Name | Type | Description
|
|
|
13734
13789
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
13735
13790
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
13736
13791
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
13737
|
-
**bundlerOptions**?🔹 | <code>[javascript.
|
|
13792
|
+
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
13738
13793
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
13739
13794
|
**codeArtifactOptions**?🔹 | <code>[CodeArtifactOptions](#projen-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
13740
13795
|
**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.<br/>__*Default*__: false
|