projen 0.46.3 → 0.47.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 +319 -363
- package/API.md +72 -76
- package/bin/projen +0 -0
- package/changelog.md +7 -0
- package/lib/awscdk/auto-discover.js +1 -1
- package/lib/awscdk/awscdk-app-ts.js +3 -3
- package/lib/awscdk/awscdk-construct.js +2 -2
- package/lib/awscdk/awscdk-deps.js +1 -1
- package/lib/awscdk/cdk-config.d.ts +1 -1
- package/lib/awscdk/cdk-config.js +2 -2
- package/lib/awscdk/cdk-tasks.d.ts +6 -0
- package/lib/awscdk/cdk-tasks.js +7 -3
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/java-app.js +1 -1
- package/lib/awscdk/lambda-function.js +2 -2
- package/lib/build/build-workflow.d.ts +18 -16
- package/lib/build/build-workflow.js +121 -121
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/consts.d.ts +0 -8
- package/lib/cdk/consts.js +2 -25
- package/lib/cdk/jsii-docgen.js +1 -1
- package/lib/cdk/jsii-project.d.ts +1 -5
- package/lib/cdk/jsii-project.js +44 -46
- 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/cli/cmds/new.js +2 -3
- package/lib/component.js +1 -1
- package/lib/dependencies.js +1 -1
- package/lib/dev-env.js +1 -1
- package/lib/docker-compose.js +2 -2
- package/lib/file.js +1 -1
- package/lib/gitattributes.js +1 -1
- package/lib/github/auto-approve.d.ts +3 -2
- package/lib/github/auto-approve.js +7 -6
- package/lib/github/auto-merge.js +1 -1
- package/lib/github/constants.d.ts +5 -5
- package/lib/github/constants.js +7 -17
- package/lib/github/dependabot.js +1 -1
- package/lib/github/github-project.d.ts +10 -0
- package/lib/github/github-project.js +3 -2
- package/lib/github/github.d.ts +16 -0
- package/lib/github/github.js +6 -5
- package/lib/github/mergify.js +1 -1
- package/lib/github/pr-template.js +1 -1
- package/lib/github/pull-request-lint.js +1 -1
- package/lib/github/stale.js +1 -1
- package/lib/github/task-workflow.js +4 -3
- package/lib/github/workflow-actions.d.ts +59 -0
- package/lib/github/workflow-actions.js +82 -0
- package/lib/github/workflows.d.ts +6 -0
- package/lib/github/workflows.js +3 -2
- 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.js +1 -1
- package/lib/javascript/eslint.js +1 -1
- package/lib/javascript/jest.js +7 -7
- package/lib/javascript/node-package.js +1 -1
- package/lib/javascript/node-project.d.ts +2 -22
- package/lib/javascript/node-project.js +26 -29
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/projenrc.js +1 -1
- package/lib/javascript/typescript-config.js +1 -1
- package/lib/javascript/upgrade-dependencies.d.ts +0 -14
- package/lib/javascript/upgrade-dependencies.js +23 -89
- 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/object-file.js +1 -1
- package/lib/project-build.js +1 -1
- package/lib/project.js +1 -1
- package/lib/projects.js +1 -1
- package/lib/projenrc-json.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.js +4 -4
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.d.ts +0 -8
- package/lib/release/release.js +12 -14
- package/lib/sample-file.js +2 -2
- package/lib/semver.js +1 -1
- package/lib/source-code.js +1 -1
- package/lib/task-runtime.js +1 -1
- package/lib/task.js +1 -1
- package/lib/tasks.js +1 -1
- package/lib/testing.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/typescript-typedoc.js +1 -1
- package/lib/typescript/typescript.js +3 -3
- 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 +2 -2
- package/releasetag.txt +1 -0
- package/version.txt +1 -0
- package/dist/changelog.md +0 -7
- package/dist/releasetag.txt +0 -1
- package/dist/version.txt +0 -1
package/API.md
CHANGED
|
@@ -228,7 +228,6 @@ Name|Description
|
|
|
228
228
|
[javascript.JestOptions](#projen-javascript-jestoptions)|*No description*
|
|
229
229
|
[javascript.NodePackageOptions](#projen-javascript-nodepackageoptions)|*No description*
|
|
230
230
|
[javascript.NodeProjectOptions](#projen-javascript-nodeprojectoptions)|*No description*
|
|
231
|
-
[javascript.NodeWorkflowSteps](#projen-javascript-nodeworkflowsteps)|*No description*
|
|
232
231
|
[javascript.NpmConfigOptions](#projen-javascript-npmconfigoptions)|Options to configure the local NPM config.
|
|
233
232
|
[javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)|*No description*
|
|
234
233
|
[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)|*No description*
|
|
@@ -2906,6 +2905,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2906
2905
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
2907
2906
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
2908
2907
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
2908
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
2909
2909
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
2910
2910
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
2911
2911
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -2943,7 +2943,6 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2943
2943
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
2944
2944
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
2945
2945
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
2946
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
2947
2946
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
2948
2947
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
2949
2948
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -3199,6 +3198,7 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
|
|
|
3199
3198
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3200
3199
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3201
3200
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3201
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
3202
3202
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3203
3203
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
3204
3204
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -3222,7 +3222,7 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
|
|
|
3222
3222
|
* **sampleJavaPackage** (<code>string</code>) The java package to use for the code sample. __*Default*__: "org.acme"
|
|
3223
3223
|
* **buildCommand** (<code>string</code>) A command to execute before synthesis. __*Default*__: no build command
|
|
3224
3224
|
* **cdkout** (<code>string</code>) cdk.out directory. __*Default*__: "cdk.out"
|
|
3225
|
-
* **context** (<code>Map<string,
|
|
3225
|
+
* **context** (<code>Map<string, any></code>) Additional context to include in `cdk.json`. __*Default*__: no additional context
|
|
3226
3226
|
* **featureFlags** (<code>boolean</code>) Include all feature flags in cdk.json. __*Default*__: true
|
|
3227
3227
|
* **requireApproval** (<code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code>) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
|
|
3228
3228
|
* **watchExcludes** (<code>Array<string></code>) Glob patterns to exclude from `cdk watch`. __*Default*__: []
|
|
@@ -3298,6 +3298,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3298
3298
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3299
3299
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3300
3300
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3301
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
3301
3302
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3302
3303
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
3303
3304
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -3335,7 +3336,6 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3335
3336
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
3336
3337
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
3337
3338
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
3338
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
3339
3339
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3340
3340
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3341
3341
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -3409,7 +3409,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3409
3409
|
* **typescriptVersion** (<code>string</code>) TypeScript version to use. __*Default*__: "latest"
|
|
3410
3410
|
* **buildCommand** (<code>string</code>) A command to execute before synthesis. __*Default*__: no build command
|
|
3411
3411
|
* **cdkout** (<code>string</code>) cdk.out directory. __*Default*__: "cdk.out"
|
|
3412
|
-
* **context** (<code>Map<string,
|
|
3412
|
+
* **context** (<code>Map<string, any></code>) Additional context to include in `cdk.json`. __*Default*__: no additional context
|
|
3413
3413
|
* **featureFlags** (<code>boolean</code>) Include all feature flags in cdk.json. __*Default*__: true
|
|
3414
3414
|
* **requireApproval** (<code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code>) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
|
|
3415
3415
|
* **watchExcludes** (<code>Array<string></code>) Glob patterns to exclude from `cdk watch`. __*Default*__: []
|
|
@@ -3478,7 +3478,7 @@ new awscdk.CdkConfig(project: Project, options: CdkConfigOptions)
|
|
|
3478
3478
|
* **options** (<code>[awscdk.CdkConfigOptions](#projen-awscdk-cdkconfigoptions)</code>) *No description*
|
|
3479
3479
|
* **buildCommand** (<code>string</code>) A command to execute before synthesis. __*Default*__: no build command
|
|
3480
3480
|
* **cdkout** (<code>string</code>) cdk.out directory. __*Default*__: "cdk.out"
|
|
3481
|
-
* **context** (<code>Map<string,
|
|
3481
|
+
* **context** (<code>Map<string, any></code>) Additional context to include in `cdk.json`. __*Default*__: no additional context
|
|
3482
3482
|
* **featureFlags** (<code>boolean</code>) Include all feature flags in cdk.json. __*Default*__: true
|
|
3483
3483
|
* **requireApproval** (<code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code>) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
|
|
3484
3484
|
* **watchExcludes** (<code>Array<string></code>) Glob patterns to exclude from `cdk watch`. __*Default*__: []
|
|
@@ -3527,6 +3527,7 @@ Name | Type | Description
|
|
|
3527
3527
|
**destroy**🔹 | <code>[Task](#projen-task)</code> | Destroys all the stacks.
|
|
3528
3528
|
**diff**🔹 | <code>[Task](#projen-task)</code> | Diff against production.
|
|
3529
3529
|
**synth**🔹 | <code>[Task](#projen-task)</code> | Synthesizes your app.
|
|
3530
|
+
**synthSilent**🔹 | <code>[Task](#projen-task)</code> | Synthesizes your app and suppresses stdout.
|
|
3530
3531
|
**watch**🔹 | <code>[Task](#projen-task)</code> | Watch task.
|
|
3531
3532
|
|
|
3532
3533
|
|
|
@@ -3566,6 +3567,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3566
3567
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3567
3568
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3568
3569
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3570
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
3569
3571
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3570
3572
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
3571
3573
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -3603,7 +3605,6 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3603
3605
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
3604
3606
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
3605
3607
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
3606
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
3607
3608
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3608
3609
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3609
3610
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -3824,7 +3825,6 @@ new build.BuildWorkflow(project: Project, options: BuildWorkflowOptions)
|
|
|
3824
3825
|
* **options** (<code>[build.BuildWorkflowOptions](#projen-build-buildworkflowoptions)</code>) *No description*
|
|
3825
3826
|
* **artifactsDirectory** (<code>string</code>) A name of a directory that includes build artifacts.
|
|
3826
3827
|
* **buildTask** (<code>[Task](#projen-task)</code>) The task to execute in order to build the project.
|
|
3827
|
-
* **antitamper** (<code>boolean</code>) Enable anti-tamper check. __*Default*__: true
|
|
3828
3828
|
* **containerImage** (<code>string</code>) The container image to use for builds. __*Default*__: the default workflow container
|
|
3829
3829
|
* **env** (<code>Map<string, string></code>) Build environment variables. __*Default*__: {}
|
|
3830
3830
|
* **gitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) Git identity to use for the workflow. __*Default*__: default identity
|
|
@@ -3848,6 +3848,10 @@ Name | Type | Description
|
|
|
3848
3848
|
|
|
3849
3849
|
Adds another job to the build workflow which is executed after the build job succeeded.
|
|
3850
3850
|
|
|
3851
|
+
Jobs are executed _only_ if the build did NOT self mutate. If the build
|
|
3852
|
+
self-mutate, the branch will either be updated or the build will fail (in
|
|
3853
|
+
forks), so there is no point in executing the post-build job.
|
|
3854
|
+
|
|
3851
3855
|
```ts
|
|
3852
3856
|
addPostBuildJob(id: string, job: Job): void
|
|
3853
3857
|
```
|
|
@@ -3935,6 +3939,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3935
3939
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3936
3940
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3937
3941
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3942
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
3938
3943
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3939
3944
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
3940
3945
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -3972,7 +3977,6 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3972
3977
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
3973
3978
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
3974
3979
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
3975
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
3976
3980
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3977
3981
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3978
3982
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4118,6 +4122,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4118
4122
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4119
4123
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4120
4124
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4125
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
4121
4126
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4122
4127
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
4123
4128
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -4155,7 +4160,6 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4155
4160
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
4156
4161
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4157
4162
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4158
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4159
4163
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4160
4164
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4161
4165
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4287,6 +4291,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4287
4291
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4288
4292
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4289
4293
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4294
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
4290
4295
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4291
4296
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
4292
4297
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -4324,7 +4329,6 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4324
4329
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
4325
4330
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4326
4331
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4327
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4328
4332
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4329
4333
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4330
4334
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4458,6 +4462,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4458
4462
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4459
4463
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4460
4464
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4465
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
4461
4466
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4462
4467
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
4463
4468
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -4495,7 +4500,6 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4495
4500
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
4496
4501
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4497
4502
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4498
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4499
4503
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4500
4504
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4501
4505
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4638,6 +4642,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4638
4642
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4639
4643
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4640
4644
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4645
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
4641
4646
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4642
4647
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
4643
4648
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -4675,7 +4680,6 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4675
4680
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
4676
4681
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4677
4682
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4678
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4679
4683
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4680
4684
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4681
4685
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4780,15 +4784,15 @@ __Extends__: [Component](#projen-component)
|
|
|
4780
4784
|
|
|
4781
4785
|
|
|
4782
4786
|
```ts
|
|
4783
|
-
new github.AutoApprove(github: GitHub, options
|
|
4787
|
+
new github.AutoApprove(github: GitHub, options?: AutoApproveOptions)
|
|
4784
4788
|
```
|
|
4785
4789
|
|
|
4786
4790
|
* **github** (<code>[github.GitHub](#projen-github-github)</code>) *No description*
|
|
4787
4791
|
* **options** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) *No description*
|
|
4788
|
-
* **secret** (<code>string</code>) A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope.
|
|
4789
4792
|
* **allowedUsernames** (<code>Array<string></code>) Only pull requests authored by these Github usernames will be auto-approved. __*Default*__: ['github-bot']
|
|
4790
4793
|
* **label** (<code>string</code>) Only pull requests with this label will be auto-approved. __*Default*__: 'auto-approve'
|
|
4791
4794
|
* **runsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4795
|
+
* **secret** (<code>string</code>) A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope. __*Default*__: "GITHUB_TOKEN"
|
|
4792
4796
|
|
|
4793
4797
|
|
|
4794
4798
|
|
|
@@ -4913,6 +4917,7 @@ new github.GitHub(project: Project, options?: GitHubOptions)
|
|
|
4913
4917
|
* **options** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) *No description*
|
|
4914
4918
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4915
4919
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for Mergify. __*Default*__: default options
|
|
4920
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
4916
4921
|
* **pullRequestLint** (<code>boolean</code>) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits. __*Default*__: true
|
|
4917
4922
|
* **pullRequestLintOptions** (<code>[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)</code>) Options for configuring a pull request linter. __*Default*__: see defaults in `PullRequestLintOptions`
|
|
4918
4923
|
* **workflows** (<code>boolean</code>) Enables GitHub workflows. __*Default*__: true
|
|
@@ -4924,6 +4929,7 @@ new github.GitHub(project: Project, options?: GitHubOptions)
|
|
|
4924
4929
|
|
|
4925
4930
|
Name | Type | Description
|
|
4926
4931
|
-----|------|-------------
|
|
4932
|
+
**projenTokenSecret**🔹 | <code>string</code> | The name of a secret with a GitHub Personal Access Token to be used by projen workflows.
|
|
4927
4933
|
**workflows**🔹 | <code>Array<[github.GithubWorkflow](#projen-github-githubworkflow)></code> | All workflows.
|
|
4928
4934
|
**workflowsEnabled**🔹 | <code>boolean</code> | Are workflows enabled?
|
|
4929
4935
|
**mergify**?🔹 | <code>[github.Mergify](#projen-github-mergify)</code> | The `Mergify` configured on this repository.<br/>__*Optional*__
|
|
@@ -5041,6 +5047,7 @@ new github.GitHubProject(options: GitHubProjectOptions)
|
|
|
5041
5047
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5042
5048
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
5043
5049
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
5050
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
5044
5051
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
5045
5052
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
5046
5053
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -5115,6 +5122,7 @@ new github.GithubWorkflow(github: GitHub, name: string, options?: GithubWorkflow
|
|
|
5115
5122
|
Name | Type | Description
|
|
5116
5123
|
-----|------|-------------
|
|
5117
5124
|
**name**🔹 | <code>string</code> | The name of the workflow.
|
|
5125
|
+
**projenTokenSecret**🔹 | <code>string</code> | The name of a secret that includes a PAT that can be used by workflows.
|
|
5118
5126
|
**concurrency**?🔹 | <code>string</code> | Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.<br/>__*Default*__: disabled
|
|
5119
5127
|
**file**?🔹 | <code>[YamlFile](#projen-yamlfile)</code> | The workflow YAML file.<br/>__*Optional*__
|
|
5120
5128
|
|
|
@@ -5424,6 +5432,7 @@ new java.JavaProject(options: JavaProjectOptions)
|
|
|
5424
5432
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5425
5433
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
5426
5434
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
5435
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
5427
5436
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
5428
5437
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
5429
5438
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -6397,6 +6406,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6397
6406
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
6398
6407
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
6399
6408
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
6409
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
6400
6410
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
6401
6411
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
6402
6412
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -6434,7 +6444,6 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6434
6444
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
6435
6445
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
6436
6446
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
6437
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
6438
6447
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
6439
6448
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
6440
6449
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -6499,7 +6508,6 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6499
6508
|
Name | Type | Description
|
|
6500
6509
|
-----|------|-------------
|
|
6501
6510
|
**allowLibraryDependencies**⚠️ | <code>boolean</code> | <span></span>
|
|
6502
|
-
**antitamper**🔹 | <code>boolean</code> | Indicates if workflows have anti-tamper checks.
|
|
6503
6511
|
**artifactsDirectory**🔹 | <code>string</code> | The build output directory.
|
|
6504
6512
|
**artifactsJavascriptDirectory**🔹 | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`).
|
|
6505
6513
|
**bundler**🔹 | <code>[javascript.Bundler](#projen-javascript-bundler)</code> | <span></span>
|
|
@@ -7294,6 +7302,7 @@ new python.PythonProject(options: PythonProjectOptions)
|
|
|
7294
7302
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
7295
7303
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
7296
7304
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
7305
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
7297
7306
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
7298
7307
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
7299
7308
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -7794,7 +7803,6 @@ new release.Release(project: GitHubProject, options: ReleaseOptions)
|
|
|
7794
7803
|
|
|
7795
7804
|
* **project** (<code>[github.GitHubProject](#projen-github-githubproject)</code>) *No description*
|
|
7796
7805
|
* **options** (<code>[release.ReleaseOptions](#projen-release-releaseoptions)</code>) *No description*
|
|
7797
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
7798
7806
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
7799
7807
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
7800
7808
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8029,6 +8037,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
8029
8037
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8030
8038
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8031
8039
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8040
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
8032
8041
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8033
8042
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8034
8043
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8066,7 +8075,6 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
8066
8075
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
8067
8076
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8068
8077
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8069
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8070
8078
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8071
8079
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8072
8080
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8177,6 +8185,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8177
8185
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8178
8186
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8179
8187
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8188
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
8180
8189
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8181
8190
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8182
8191
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8214,7 +8223,6 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8214
8223
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
8215
8224
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8216
8225
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8217
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8218
8226
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8219
8227
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8220
8228
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8325,6 +8333,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8325
8333
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8326
8334
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8327
8335
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8336
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
8328
8337
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8329
8338
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8330
8339
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8362,7 +8371,6 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8362
8371
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
8363
8372
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8364
8373
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8365
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8366
8374
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8367
8375
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8368
8376
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8718,6 +8726,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8718
8726
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8719
8727
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8720
8728
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8729
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
8721
8730
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8722
8731
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8723
8732
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8755,7 +8764,6 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8755
8764
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
8756
8765
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8757
8766
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8758
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8759
8767
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8760
8768
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8761
8769
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8864,6 +8872,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8864
8872
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8865
8873
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8866
8874
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8875
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
8867
8876
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8868
8877
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8869
8878
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8901,7 +8910,6 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8901
8910
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
8902
8911
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8903
8912
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8904
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8905
8913
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8906
8914
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8907
8915
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -9082,6 +9090,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
9082
9090
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
9083
9091
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
9084
9092
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
9093
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
9085
9094
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
9086
9095
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
9087
9096
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -9119,7 +9128,6 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
9119
9128
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
9120
9129
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
9121
9130
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
9122
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
9123
9131
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
9124
9132
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
9125
9133
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -9269,6 +9277,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9269
9277
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
9270
9278
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
9271
9279
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
9280
|
+
* **projenTokenSecret** (<code>string</code>) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
9272
9281
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
9273
9282
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
9274
9283
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -9306,7 +9315,6 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9306
9315
|
* **repositoryDirectory** (<code>string</code>) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. __*Optional*__
|
|
9307
9316
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
9308
9317
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
9309
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
9310
9318
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
9311
9319
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
9312
9320
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -10352,7 +10360,6 @@ Name | Type | Description
|
|
|
10352
10360
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
10353
10361
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
10354
10362
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10355
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10356
10363
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10357
10364
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
10358
10365
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -10442,9 +10449,10 @@ Name | Type | Description
|
|
|
10442
10449
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10443
10450
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10444
10451
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
10452
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
10445
10453
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
10446
10454
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
10447
|
-
**projenUpgradeSecret
|
|
10455
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
10448
10456
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
10449
10457
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
10450
10458
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -10561,7 +10569,7 @@ Name | Type | Description
|
|
|
10561
10569
|
**cdkout**?🔹 | <code>string</code> | cdk.out directory.<br/>__*Default*__: "cdk.out"
|
|
10562
10570
|
**clobber**?🔹 | <code>boolean</code> | Add a `clobber` task which resets the repo to origin.<br/>__*Default*__: true
|
|
10563
10571
|
**compileOptions**?🔹 | <code>[java.MavenCompileOptions](#projen-java-mavencompileoptions)</code> | Compile options.<br/>__*Default*__: defaults
|
|
10564
|
-
**context**?🔹 | <code>Map<string,
|
|
10572
|
+
**context**?🔹 | <code>Map<string, any></code> | Additional context to include in `cdk.json`.<br/>__*Default*__: no additional context
|
|
10565
10573
|
**deps**?🔹 | <code>Array<string></code> | List of runtime dependencies for this project.<br/>__*Default*__: []
|
|
10566
10574
|
**description**?🔹 | <code>string</code> | Description of a project is always good.<br/>__*Default*__: undefined
|
|
10567
10575
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
@@ -10581,6 +10589,7 @@ Name | Type | Description
|
|
|
10581
10589
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
10582
10590
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10583
10591
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10592
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
10584
10593
|
**projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
|
|
10585
10594
|
**projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
|
|
10586
10595
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
@@ -10612,7 +10621,6 @@ Name | Type | Description
|
|
|
10612
10621
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
10613
10622
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
10614
10623
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10615
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10616
10624
|
**appEntrypoint**?🔹 | <code>string</code> | The CDK app's entrypoint (relative to the source directory, which is "src" by default).<br/>__*Default*__: "main.ts"
|
|
10617
10625
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10618
10626
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
@@ -10643,7 +10651,7 @@ Name | Type | Description
|
|
|
10643
10651
|
**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
|
|
10644
10652
|
**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.<br/>__*Default*__: if this option is not specified, only public repositories are supported
|
|
10645
10653
|
**constructsVersion**?🔹 | <code>string</code> | Minimum version of the `constructs` library to depend on.<br/>__*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
|
|
10646
|
-
**context**?🔹 | <code>Map<string,
|
|
10654
|
+
**context**?🔹 | <code>Map<string, any></code> | Additional context to include in `cdk.json`.<br/>__*Default*__: no additional context
|
|
10647
10655
|
**copyrightOwner**?🔹 | <code>string</code> | License copyright owner.<br/>__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
|
|
10648
10656
|
**copyrightPeriod**?🔹 | <code>string</code> | The copyright years to put in the LICENSE file.<br/>__*Default*__: current year
|
|
10649
10657
|
**dependabot**?🔹 | <code>boolean</code> | Use dependabot to handle dependency upgrades.<br/>__*Default*__: false
|
|
@@ -10702,9 +10710,10 @@ Name | Type | Description
|
|
|
10702
10710
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10703
10711
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10704
10712
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
10713
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
10705
10714
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
10706
10715
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
10707
|
-
**projenUpgradeSecret
|
|
10716
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
10708
10717
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
10709
10718
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
10710
10719
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -10766,7 +10775,7 @@ Name | Type | Description
|
|
|
10766
10775
|
-----|------|-------------
|
|
10767
10776
|
**buildCommand**?🔹 | <code>string</code> | A command to execute before synthesis.<br/>__*Default*__: no build command
|
|
10768
10777
|
**cdkout**?🔹 | <code>string</code> | cdk.out directory.<br/>__*Default*__: "cdk.out"
|
|
10769
|
-
**context**?🔹 | <code>Map<string,
|
|
10778
|
+
**context**?🔹 | <code>Map<string, any></code> | Additional context to include in `cdk.json`.<br/>__*Default*__: no additional context
|
|
10770
10779
|
**featureFlags**?🔹 | <code>boolean</code> | Include all feature flags in cdk.json.<br/>__*Default*__: true
|
|
10771
10780
|
**requireApproval**?🔹 | <code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.<br/>__*Default*__: ApprovalLevel.BROADENING
|
|
10772
10781
|
**watchExcludes**?🔹 | <code>Array<string></code> | Glob patterns to exclude from `cdk watch`.<br/>__*Default*__: []
|
|
@@ -10786,7 +10795,7 @@ Name | Type | Description
|
|
|
10786
10795
|
**app**🔹 | <code>string</code> | The command line to execute in order to synthesize the CDK application (language specific).
|
|
10787
10796
|
**buildCommand**?🔹 | <code>string</code> | A command to execute before synthesis.<br/>__*Default*__: no build command
|
|
10788
10797
|
**cdkout**?🔹 | <code>string</code> | cdk.out directory.<br/>__*Default*__: "cdk.out"
|
|
10789
|
-
**context**?🔹 | <code>Map<string,
|
|
10798
|
+
**context**?🔹 | <code>Map<string, any></code> | Additional context to include in `cdk.json`.<br/>__*Default*__: no additional context
|
|
10790
10799
|
**featureFlags**?🔹 | <code>boolean</code> | Include all feature flags in cdk.json.<br/>__*Default*__: true
|
|
10791
10800
|
**requireApproval**?🔹 | <code>[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)</code> | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.<br/>__*Default*__: ApprovalLevel.BROADENING
|
|
10792
10801
|
**watchExcludes**?🔹 | <code>Array<string></code> | Glob patterns to exclude from `cdk watch`.<br/>__*Default*__: []
|
|
@@ -10810,7 +10819,6 @@ Name | Type | Description
|
|
|
10810
10819
|
**name**⚠️ | <code>string</code> | This is the name of your project.
|
|
10811
10820
|
**repositoryUrl**⚠️ | <code>string</code> | Git repository URL.
|
|
10812
10821
|
**allowLibraryDependencies**?⚠️ | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10813
|
-
**antitamper**?⚠️ | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10814
10822
|
**artifactsDirectory**?⚠️ | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10815
10823
|
**authorEmail**?⚠️ | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
10816
10824
|
**authorName**?⚠️ | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -10900,6 +10908,7 @@ Name | Type | Description
|
|
|
10900
10908
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10901
10909
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10902
10910
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
10911
|
+
**projenTokenSecret**?⚠️ | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
10903
10912
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
10904
10913
|
**projenUpgradeSchedule**?⚠️ | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
10905
10914
|
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
@@ -11031,7 +11040,6 @@ Name | Type | Description
|
|
|
11031
11040
|
-----|------|-------------
|
|
11032
11041
|
**artifactsDirectory**🔹 | <code>string</code> | A name of a directory that includes build artifacts.
|
|
11033
11042
|
**buildTask**🔹 | <code>[Task](#projen-task)</code> | The task to execute in order to build the project.
|
|
11034
|
-
**antitamper**?🔹 | <code>boolean</code> | Enable anti-tamper check.<br/>__*Default*__: true
|
|
11035
11043
|
**containerImage**?🔹 | <code>string</code> | The container image to use for builds.<br/>__*Default*__: the default workflow container
|
|
11036
11044
|
**env**?🔹 | <code>Map<string, string></code> | Build environment variables.<br/>__*Default*__: {}
|
|
11037
11045
|
**gitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | Git identity to use for the workflow.<br/>__*Default*__: default identity
|
|
@@ -11070,7 +11078,6 @@ Name | Type | Description
|
|
|
11070
11078
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11071
11079
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11072
11080
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11073
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11074
11081
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11075
11082
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11076
11083
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -11151,9 +11158,10 @@ Name | Type | Description
|
|
|
11151
11158
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11152
11159
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11153
11160
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11161
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
11154
11162
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11155
11163
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11156
|
-
**projenUpgradeSecret
|
|
11164
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11157
11165
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11158
11166
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
11159
11167
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11285,7 +11293,6 @@ Name | Type | Description
|
|
|
11285
11293
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11286
11294
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11287
11295
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11288
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11289
11296
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11290
11297
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11291
11298
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -11365,9 +11372,10 @@ Name | Type | Description
|
|
|
11365
11372
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11366
11373
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11367
11374
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11375
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
11368
11376
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11369
11377
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11370
|
-
**projenUpgradeSecret
|
|
11378
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11371
11379
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11372
11380
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
11373
11381
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11453,7 +11461,6 @@ Name | Type | Description
|
|
|
11453
11461
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
11454
11462
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11455
11463
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11456
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11457
11464
|
**appEntrypoint**?🔹 | <code>string</code> | The CDK8s app's entrypoint (relative to the source directory, which is "src" by default).<br/>__*Default*__: "main.ts"
|
|
11458
11465
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11459
11466
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
@@ -11536,9 +11543,10 @@ Name | Type | Description
|
|
|
11536
11543
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11537
11544
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11538
11545
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11546
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
11539
11547
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11540
11548
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11541
|
-
**projenUpgradeSecret
|
|
11549
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11542
11550
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11543
11551
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
11544
11552
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11602,7 +11610,6 @@ Name | Type | Description
|
|
|
11602
11610
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11603
11611
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11604
11612
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11605
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11606
11613
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11607
11614
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11608
11615
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -11687,9 +11694,10 @@ Name | Type | Description
|
|
|
11687
11694
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11688
11695
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11689
11696
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11697
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
11690
11698
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11691
11699
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11692
|
-
**projenUpgradeSecret
|
|
11700
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11693
11701
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11694
11702
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
11695
11703
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11759,7 +11767,6 @@ Name | Type | Description
|
|
|
11759
11767
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11760
11768
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11761
11769
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11762
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11763
11770
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11764
11771
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11765
11772
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -11840,9 +11847,10 @@ Name | Type | Description
|
|
|
11840
11847
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11841
11848
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11842
11849
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11850
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
11843
11851
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11844
11852
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11845
|
-
**projenUpgradeSecret
|
|
11853
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11846
11854
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11847
11855
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
11848
11856
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11905,10 +11913,10 @@ Options for 'AutoApprove'.
|
|
|
11905
11913
|
|
|
11906
11914
|
Name | Type | Description
|
|
11907
11915
|
-----|------|-------------
|
|
11908
|
-
**secret**🔹 | <code>string</code> | A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope.
|
|
11909
11916
|
**allowedUsernames**?🔹 | <code>Array<string></code> | Only pull requests authored by these Github usernames will be auto-approved.<br/>__*Default*__: ['github-bot']
|
|
11910
11917
|
**label**?🔹 | <code>string</code> | Only pull requests with this label will be auto-approved.<br/>__*Default*__: 'auto-approve'
|
|
11911
11918
|
**runsOn**?🔹 | <code>Array<string></code> | Github Runner selection labels.<br/>__*Default*__: ["ubuntu-latest"]
|
|
11919
|
+
**secret**?🔹 | <code>string</code> | A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope.<br/>__*Default*__: "GITHUB_TOKEN"
|
|
11912
11920
|
|
|
11913
11921
|
|
|
11914
11922
|
|
|
@@ -11992,6 +12000,7 @@ Name | Type | Description
|
|
|
11992
12000
|
-----|------|-------------
|
|
11993
12001
|
**mergify**?🔹 | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
|
|
11994
12002
|
**mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for Mergify.<br/>__*Default*__: default options
|
|
12003
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
11995
12004
|
**pullRequestLint**?🔹 | <code>boolean</code> | Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.<br/>__*Default*__: true
|
|
11996
12005
|
**pullRequestLintOptions**?🔹 | <code>[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)</code> | Options for configuring a pull request linter.<br/>__*Default*__: see defaults in `PullRequestLintOptions`
|
|
11997
12006
|
**workflows**?🔹 | <code>boolean</code> | Enables GitHub workflows.<br/>__*Default*__: true
|
|
@@ -12022,6 +12031,7 @@ Name | Type | Description
|
|
|
12022
12031
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
12023
12032
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12024
12033
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12034
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
12025
12035
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
12026
12036
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
12027
12037
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -12262,6 +12272,7 @@ Name | Type | Description
|
|
|
12262
12272
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
12263
12273
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12264
12274
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12275
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
12265
12276
|
**projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
|
|
12266
12277
|
**projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
|
|
12267
12278
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
@@ -12310,6 +12321,7 @@ Name | Type | Description
|
|
|
12310
12321
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
12311
12322
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12312
12323
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12324
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
12313
12325
|
**projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
|
|
12314
12326
|
**projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
|
|
12315
12327
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
@@ -12745,7 +12757,6 @@ Name | Type | Description
|
|
|
12745
12757
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
12746
12758
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
12747
12759
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
12748
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
12749
12760
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
12750
12761
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
12751
12762
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -12814,9 +12825,10 @@ Name | Type | Description
|
|
|
12814
12825
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12815
12826
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12816
12827
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
12828
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
12817
12829
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
12818
12830
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
12819
|
-
**projenUpgradeSecret
|
|
12831
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
12820
12832
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
12821
12833
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
12822
12834
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -12855,20 +12867,6 @@ Name | Type | Description
|
|
|
12855
12867
|
|
|
12856
12868
|
|
|
12857
12869
|
|
|
12858
|
-
## struct NodeWorkflowSteps 🔹 <a id="projen-javascript-nodeworkflowsteps"></a>
|
|
12859
|
-
|
|
12860
|
-
|
|
12861
|
-
|
|
12862
|
-
|
|
12863
|
-
|
|
12864
|
-
|
|
12865
|
-
Name | Type | Description
|
|
12866
|
-
-----|------|-------------
|
|
12867
|
-
**antitamper**🔹 | <code>Array<any></code> | <span></span>
|
|
12868
|
-
**install**🔹 | <code>Array<any></code> | <span></span>
|
|
12869
|
-
|
|
12870
|
-
|
|
12871
|
-
|
|
12872
12870
|
## struct NpmConfigOptions 🔹 <a id="projen-javascript-npmconfigoptions"></a>
|
|
12873
12871
|
|
|
12874
12872
|
|
|
@@ -13006,7 +13004,6 @@ Name | Type | Description
|
|
|
13006
13004
|
**container**?🔹 | <code>[github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)</code> | Job container options.<br/>__*Default*__: defaults
|
|
13007
13005
|
**gitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | The git identity to use for commits.<br/>__*Default*__: "github-actions
|
|
13008
13006
|
**labels**?🔹 | <code>Array<string></code> | Labels to apply on the PR.<br/>__*Default*__: no labels.
|
|
13009
|
-
**rebuild**?🔹 | <code>boolean</code> | Execute 'build' after the upgrade.<br/>__*Default*__: true
|
|
13010
13007
|
**runsOn**?🔹 | <code>Array<string></code> | Github Runner selection labels.<br/>__*Default*__: ["ubuntu-latest"]
|
|
13011
13008
|
**schedule**?🔹 | <code>[javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule)</code> | Schedule to run on.<br/>__*Default*__: UpgradeDependenciesSchedule.DAILY
|
|
13012
13009
|
**secret**?🔹 | <code>string</code> | Which secret to use when creating the PR.<br/>__*Default*__: default github token.
|
|
@@ -13279,6 +13276,7 @@ Name | Type | Description
|
|
|
13279
13276
|
**poetryOptions**?🔹 | <code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code> | Additional options to set for poetry if using poetry.<br/>__*Optional*__
|
|
13280
13277
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13281
13278
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13279
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
13282
13280
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
13283
13281
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13284
13282
|
**projenrcPython**?🔹 | <code>boolean</code> | Use projenrc in python.<br/>__*Default*__: true
|
|
@@ -13644,7 +13642,6 @@ Name | Type | Description
|
|
|
13644
13642
|
**branch**🔹 | <code>string</code> | The default branch name to release from.
|
|
13645
13643
|
**task**🔹 | <code>[Task](#projen-task)</code> | The task to execute in order to create the release artifacts.
|
|
13646
13644
|
**versionFile**🔹 | <code>string</code> | A name of a .json file to set the `version` field in after a bump.
|
|
13647
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13648
13645
|
**githubRelease**?🔹 | <code>boolean</code> | Create a GitHub release for each release.<br/>__*Default*__: true
|
|
13649
13646
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `jsii-release` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
13650
13647
|
**majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
|
|
@@ -13677,7 +13674,6 @@ Project options for release.
|
|
|
13677
13674
|
|
|
13678
13675
|
Name | Type | Description
|
|
13679
13676
|
-----|------|-------------
|
|
13680
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13681
13677
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `jsii-release` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
13682
13678
|
**majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
|
|
13683
13679
|
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
@@ -13739,7 +13735,6 @@ Name | Type | Description
|
|
|
13739
13735
|
**defaultReleaseBranch**⚠️ | <code>string</code> | The name of the main release branch.
|
|
13740
13736
|
**name**⚠️ | <code>string</code> | This is the name of your project.
|
|
13741
13737
|
**allowLibraryDependencies**?⚠️ | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
13742
|
-
**antitamper**?⚠️ | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13743
13738
|
**artifactsDirectory**?⚠️ | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
13744
13739
|
**authorEmail**?⚠️ | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
13745
13740
|
**authorName**?⚠️ | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -13815,6 +13810,7 @@ Name | Type | Description
|
|
|
13815
13810
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13816
13811
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13817
13812
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
13813
|
+
**projenTokenSecret**?⚠️ | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
13818
13814
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13819
13815
|
**projenUpgradeSchedule**?⚠️ | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
13820
13816
|
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
@@ -13877,7 +13873,6 @@ Name | Type | Description
|
|
|
13877
13873
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
13878
13874
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
13879
13875
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
13880
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13881
13876
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
13882
13877
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
13883
13878
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -13953,9 +13948,10 @@ Name | Type | Description
|
|
|
13953
13948
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13954
13949
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13955
13950
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
13951
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
13956
13952
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13957
13953
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
13958
|
-
**projenUpgradeSecret
|
|
13954
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
13959
13955
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
13960
13956
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
13961
13957
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -14119,7 +14115,6 @@ Name | Type | Description
|
|
|
14119
14115
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
14120
14116
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14121
14117
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14122
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14123
14118
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14124
14119
|
**assetsdir**?🔹 | <code>string</code> | Assets directory.<br/>__*Default*__: "public"
|
|
14125
14120
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
@@ -14189,9 +14184,10 @@ Name | Type | Description
|
|
|
14189
14184
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14190
14185
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14191
14186
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14187
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
14192
14188
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14193
14189
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
14194
|
-
**projenUpgradeSecret
|
|
14190
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
14195
14191
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
14196
14192
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
14197
14193
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -14245,7 +14241,6 @@ Name | Type | Description
|
|
|
14245
14241
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
14246
14242
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14247
14243
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14248
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14249
14244
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14250
14245
|
**assetsdir**?🔹 | <code>string</code> | Assets directory.<br/>__*Default*__: "public"
|
|
14251
14246
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
@@ -14322,9 +14317,10 @@ Name | Type | Description
|
|
|
14322
14317
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14323
14318
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14324
14319
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14320
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
14325
14321
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14326
14322
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
14327
|
-
**projenUpgradeSecret
|
|
14323
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
14328
14324
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
14329
14325
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
14330
14326
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -14414,7 +14410,6 @@ Name | Type | Description
|
|
|
14414
14410
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
14415
14411
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14416
14412
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14417
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14418
14413
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14419
14414
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
14420
14415
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -14483,9 +14478,10 @@ Name | Type | Description
|
|
|
14483
14478
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14484
14479
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14485
14480
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14481
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
14486
14482
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14487
14483
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
14488
|
-
**projenUpgradeSecret
|
|
14484
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
14489
14485
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
14490
14486
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
14491
14487
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -14568,7 +14564,6 @@ Name | Type | Description
|
|
|
14568
14564
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
14569
14565
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14570
14566
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14571
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14572
14567
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14573
14568
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
14574
14569
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -14644,9 +14639,10 @@ Name | Type | Description
|
|
|
14644
14639
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14645
14640
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14646
14641
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14642
|
+
**projenTokenSecret**?🔹 | <code>string</code> | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.<br/>__*Default*__: "PROJEN_GITHUB_TOKEN"
|
|
14647
14643
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14648
14644
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
14649
|
-
**projenUpgradeSecret
|
|
14645
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
14650
14646
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
14651
14647
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
14652
14648
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|