projen 0.46.9 → 0.47.3
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 +384 -373
- package/API.md +116 -72
- package/changelog.md +2 -2
- package/lib/awscdk/auto-discover.js +1 -1
- package/lib/awscdk/awscdk-app-ts.js +1 -1
- package/lib/awscdk/awscdk-construct.js +2 -2
- package/lib/awscdk/awscdk-deps.js +1 -1
- package/lib/awscdk/cdk-config.js +1 -1
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/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 +120 -119
- 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 +0 -5
- package/lib/cdk/jsii-project.js +2 -19
- 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.d.ts +26 -7
- package/lib/github/auto-merge.js +33 -11
- package/lib/github/constants.d.ts +0 -5
- package/lib/github/constants.js +2 -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 +28 -31
- 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 +1 -1
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.d.ts +0 -8
- package/lib/release/release.js +10 -13
- 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 -1
- package/version.txt +1 -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*
|
|
@@ -296,6 +295,7 @@ Name|Description
|
|
|
296
295
|
[IDockerComposeVolumeConfig](#projen-idockercomposevolumeconfig)|Storage for volume configuration.
|
|
297
296
|
[IResolvable](#projen-iresolvable)|*No description*
|
|
298
297
|
[IResolver](#projen-iresolver)|API for resolving tokens when synthesizing file content.
|
|
298
|
+
[github.IAddConditionsLater](#projen-github-iaddconditionslater)|*No description*
|
|
299
299
|
[github.IJobProvider](#projen-github-ijobprovider)|*No description*
|
|
300
300
|
[python.IPackageProvider](#projen-python-ipackageprovider)|*No description*
|
|
301
301
|
[python.IPythonDeps](#projen-python-ipythondeps)|*No description*
|
|
@@ -2906,6 +2906,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2906
2906
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
2907
2907
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
2908
2908
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
2909
|
+
* **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
2910
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
2910
2911
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
2911
2912
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -2943,7 +2944,6 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2943
2944
|
* **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
2945
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
2945
2946
|
* **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
2947
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
2948
2948
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
2949
2949
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -3199,6 +3199,7 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
|
|
|
3199
3199
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3200
3200
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3201
3201
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3202
|
+
* **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
3203
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3203
3204
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
3204
3205
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -3298,6 +3299,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3298
3299
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3299
3300
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3300
3301
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3302
|
+
* **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
3303
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3302
3304
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
3303
3305
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -3335,7 +3337,6 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3335
3337
|
* **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
3338
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
3337
3339
|
* **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
3340
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3340
3341
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3341
3342
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -3567,6 +3568,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3567
3568
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3568
3569
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3569
3570
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3571
|
+
* **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"
|
|
3570
3572
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3571
3573
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
3572
3574
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -3604,7 +3606,6 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3604
3606
|
* **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*__
|
|
3605
3607
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
3606
3608
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
3607
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
3608
3609
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3609
3610
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3610
3611
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -3825,7 +3826,6 @@ new build.BuildWorkflow(project: Project, options: BuildWorkflowOptions)
|
|
|
3825
3826
|
* **options** (<code>[build.BuildWorkflowOptions](#projen-build-buildworkflowoptions)</code>) *No description*
|
|
3826
3827
|
* **artifactsDirectory** (<code>string</code>) A name of a directory that includes build artifacts.
|
|
3827
3828
|
* **buildTask** (<code>[Task](#projen-task)</code>) The task to execute in order to build the project.
|
|
3828
|
-
* **antitamper** (<code>boolean</code>) Enable anti-tamper check. __*Default*__: true
|
|
3829
3829
|
* **containerImage** (<code>string</code>) The container image to use for builds. __*Default*__: the default workflow container
|
|
3830
3830
|
* **env** (<code>Map<string, string></code>) Build environment variables. __*Default*__: {}
|
|
3831
3831
|
* **gitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) Git identity to use for the workflow. __*Default*__: default identity
|
|
@@ -3849,6 +3849,10 @@ Name | Type | Description
|
|
|
3849
3849
|
|
|
3850
3850
|
Adds another job to the build workflow which is executed after the build job succeeded.
|
|
3851
3851
|
|
|
3852
|
+
Jobs are executed _only_ if the build did NOT self mutate. If the build
|
|
3853
|
+
self-mutate, the branch will either be updated or the build will fail (in
|
|
3854
|
+
forks), so there is no point in executing the post-build job.
|
|
3855
|
+
|
|
3852
3856
|
```ts
|
|
3853
3857
|
addPostBuildJob(id: string, job: Job): void
|
|
3854
3858
|
```
|
|
@@ -3936,6 +3940,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3936
3940
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3937
3941
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3938
3942
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3943
|
+
* **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"
|
|
3939
3944
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3940
3945
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
3941
3946
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -3973,7 +3978,6 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3973
3978
|
* **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*__
|
|
3974
3979
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
3975
3980
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
3976
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
3977
3981
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3978
3982
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3979
3983
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4119,6 +4123,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4119
4123
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4120
4124
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4121
4125
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4126
|
+
* **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"
|
|
4122
4127
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4123
4128
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
4124
4129
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -4156,7 +4161,6 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4156
4161
|
* **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*__
|
|
4157
4162
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4158
4163
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4159
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4160
4164
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4161
4165
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4162
4166
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4288,6 +4292,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4288
4292
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4289
4293
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4290
4294
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4295
|
+
* **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"
|
|
4291
4296
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4292
4297
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
4293
4298
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -4325,7 +4330,6 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4325
4330
|
* **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*__
|
|
4326
4331
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4327
4332
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4328
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4329
4333
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4330
4334
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4331
4335
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4459,6 +4463,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4459
4463
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4460
4464
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4461
4465
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4466
|
+
* **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"
|
|
4462
4467
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4463
4468
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
4464
4469
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -4496,7 +4501,6 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4496
4501
|
* **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*__
|
|
4497
4502
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4498
4503
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4499
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4500
4504
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4501
4505
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4502
4506
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4639,6 +4643,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4639
4643
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4640
4644
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4641
4645
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4646
|
+
* **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"
|
|
4642
4647
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4643
4648
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
4644
4649
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -4676,7 +4681,6 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4676
4681
|
* **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*__
|
|
4677
4682
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4678
4683
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4679
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4680
4684
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4681
4685
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4682
4686
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -4781,15 +4785,15 @@ __Extends__: [Component](#projen-component)
|
|
|
4781
4785
|
|
|
4782
4786
|
|
|
4783
4787
|
```ts
|
|
4784
|
-
new github.AutoApprove(github: GitHub, options
|
|
4788
|
+
new github.AutoApprove(github: GitHub, options?: AutoApproveOptions)
|
|
4785
4789
|
```
|
|
4786
4790
|
|
|
4787
4791
|
* **github** (<code>[github.GitHub](#projen-github-github)</code>) *No description*
|
|
4788
4792
|
* **options** (<code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code>) *No description*
|
|
4789
|
-
* **secret** (<code>string</code>) A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope.
|
|
4790
4793
|
* **allowedUsernames** (<code>Array<string></code>) Only pull requests authored by these Github usernames will be auto-approved. __*Default*__: ['github-bot']
|
|
4791
4794
|
* **label** (<code>string</code>) Only pull requests with this label will be auto-approved. __*Default*__: 'auto-approve'
|
|
4792
4795
|
* **runsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4796
|
+
* **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"
|
|
4793
4797
|
|
|
4794
4798
|
|
|
4795
4799
|
|
|
@@ -4822,14 +4826,42 @@ __Extends__: [Component](#projen-component)
|
|
|
4822
4826
|
|
|
4823
4827
|
|
|
4824
4828
|
```ts
|
|
4825
|
-
new github.AutoMerge(github: GitHub, options
|
|
4829
|
+
new github.AutoMerge(github: GitHub, options?: AutoMergeOptions)
|
|
4826
4830
|
```
|
|
4827
4831
|
|
|
4828
4832
|
* **github** (<code>[github.GitHub](#projen-github-github)</code>) *No description*
|
|
4829
4833
|
* **options** (<code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code>) *No description*
|
|
4830
4834
|
* **approvedReviews** (<code>number</code>) Number of approved code reviews. __*Default*__: 1
|
|
4831
4835
|
* **blockingLabels** (<code>Array<string></code>) List of labels that will prevent auto-merging. __*Default*__: ['do-not-merge']
|
|
4832
|
-
|
|
4836
|
+
|
|
4837
|
+
|
|
4838
|
+
### Methods
|
|
4839
|
+
|
|
4840
|
+
|
|
4841
|
+
#### addConditions(...conditions)🔹 <a id="projen-github-automerge-addconditions"></a>
|
|
4842
|
+
|
|
4843
|
+
Adds conditions to the auto merge rule.
|
|
4844
|
+
|
|
4845
|
+
```ts
|
|
4846
|
+
addConditions(...conditions: string[]): void
|
|
4847
|
+
```
|
|
4848
|
+
|
|
4849
|
+
* **conditions** (<code>string</code>) The conditions to add (mergify syntax).
|
|
4850
|
+
|
|
4851
|
+
|
|
4852
|
+
|
|
4853
|
+
|
|
4854
|
+
#### addConditionsLater(later)🔹 <a id="projen-github-automerge-addconditionslater"></a>
|
|
4855
|
+
|
|
4856
|
+
Adds conditions that will be rendered only during synthesis.
|
|
4857
|
+
|
|
4858
|
+
```ts
|
|
4859
|
+
addConditionsLater(later: IAddConditionsLater): void
|
|
4860
|
+
```
|
|
4861
|
+
|
|
4862
|
+
* **later** (<code>[github.IAddConditionsLater](#projen-github-iaddconditionslater)</code>) The later.
|
|
4863
|
+
|
|
4864
|
+
|
|
4833
4865
|
|
|
4834
4866
|
|
|
4835
4867
|
|
|
@@ -4914,6 +4946,7 @@ new github.GitHub(project: Project, options?: GitHubOptions)
|
|
|
4914
4946
|
* **options** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) *No description*
|
|
4915
4947
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4916
4948
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for Mergify. __*Default*__: default options
|
|
4949
|
+
* **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"
|
|
4917
4950
|
* **pullRequestLint** (<code>boolean</code>) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits. __*Default*__: true
|
|
4918
4951
|
* **pullRequestLintOptions** (<code>[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)</code>) Options for configuring a pull request linter. __*Default*__: see defaults in `PullRequestLintOptions`
|
|
4919
4952
|
* **workflows** (<code>boolean</code>) Enables GitHub workflows. __*Default*__: true
|
|
@@ -4925,6 +4958,7 @@ new github.GitHub(project: Project, options?: GitHubOptions)
|
|
|
4925
4958
|
|
|
4926
4959
|
Name | Type | Description
|
|
4927
4960
|
-----|------|-------------
|
|
4961
|
+
**projenTokenSecret**🔹 | <code>string</code> | The name of a secret with a GitHub Personal Access Token to be used by projen workflows.
|
|
4928
4962
|
**workflows**🔹 | <code>Array<[github.GithubWorkflow](#projen-github-githubworkflow)></code> | All workflows.
|
|
4929
4963
|
**workflowsEnabled**🔹 | <code>boolean</code> | Are workflows enabled?
|
|
4930
4964
|
**mergify**?🔹 | <code>[github.Mergify](#projen-github-mergify)</code> | The `Mergify` configured on this repository.<br/>__*Optional*__
|
|
@@ -5042,6 +5076,7 @@ new github.GitHubProject(options: GitHubProjectOptions)
|
|
|
5042
5076
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5043
5077
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
5044
5078
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
5079
|
+
* **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"
|
|
5045
5080
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
5046
5081
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
5047
5082
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -5116,6 +5151,7 @@ new github.GithubWorkflow(github: GitHub, name: string, options?: GithubWorkflow
|
|
|
5116
5151
|
Name | Type | Description
|
|
5117
5152
|
-----|------|-------------
|
|
5118
5153
|
**name**🔹 | <code>string</code> | The name of the workflow.
|
|
5154
|
+
**projenTokenSecret**🔹 | <code>string</code> | The name of a secret that includes a PAT that can be used by workflows.
|
|
5119
5155
|
**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
|
|
5120
5156
|
**file**?🔹 | <code>[YamlFile](#projen-yamlfile)</code> | The workflow YAML file.<br/>__*Optional*__
|
|
5121
5157
|
|
|
@@ -5425,6 +5461,7 @@ new java.JavaProject(options: JavaProjectOptions)
|
|
|
5425
5461
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5426
5462
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
5427
5463
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
5464
|
+
* **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"
|
|
5428
5465
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
5429
5466
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
5430
5467
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -6398,6 +6435,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6398
6435
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
6399
6436
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
6400
6437
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
6438
|
+
* **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"
|
|
6401
6439
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
6402
6440
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
6403
6441
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -6435,7 +6473,6 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6435
6473
|
* **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*__
|
|
6436
6474
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
6437
6475
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
6438
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
6439
6476
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
6440
6477
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
6441
6478
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -6500,7 +6537,6 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6500
6537
|
Name | Type | Description
|
|
6501
6538
|
-----|------|-------------
|
|
6502
6539
|
**allowLibraryDependencies**⚠️ | <code>boolean</code> | <span></span>
|
|
6503
|
-
**antitamper**🔹 | <code>boolean</code> | Indicates if workflows have anti-tamper checks.
|
|
6504
6540
|
**artifactsDirectory**🔹 | <code>string</code> | The build output directory.
|
|
6505
6541
|
**artifactsJavascriptDirectory**🔹 | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`).
|
|
6506
6542
|
**bundler**🔹 | <code>[javascript.Bundler](#projen-javascript-bundler)</code> | <span></span>
|
|
@@ -7295,6 +7331,7 @@ new python.PythonProject(options: PythonProjectOptions)
|
|
|
7295
7331
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
7296
7332
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
7297
7333
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
7334
|
+
* **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"
|
|
7298
7335
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
7299
7336
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
7300
7337
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -7795,7 +7832,6 @@ new release.Release(project: GitHubProject, options: ReleaseOptions)
|
|
|
7795
7832
|
|
|
7796
7833
|
* **project** (<code>[github.GitHubProject](#projen-github-githubproject)</code>) *No description*
|
|
7797
7834
|
* **options** (<code>[release.ReleaseOptions](#projen-release-releaseoptions)</code>) *No description*
|
|
7798
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
7799
7835
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
7800
7836
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
7801
7837
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8030,6 +8066,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
8030
8066
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8031
8067
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8032
8068
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8069
|
+
* **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"
|
|
8033
8070
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8034
8071
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8035
8072
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8067,7 +8104,6 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
8067
8104
|
* **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*__
|
|
8068
8105
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8069
8106
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8070
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8071
8107
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8072
8108
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8073
8109
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8178,6 +8214,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8178
8214
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8179
8215
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8180
8216
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8217
|
+
* **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"
|
|
8181
8218
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8182
8219
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8183
8220
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8215,7 +8252,6 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8215
8252
|
* **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*__
|
|
8216
8253
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8217
8254
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8218
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8219
8255
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8220
8256
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8221
8257
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8326,6 +8362,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8326
8362
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8327
8363
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8328
8364
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8365
|
+
* **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"
|
|
8329
8366
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8330
8367
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8331
8368
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8363,7 +8400,6 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8363
8400
|
* **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*__
|
|
8364
8401
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8365
8402
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8366
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8367
8403
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8368
8404
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8369
8405
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8719,6 +8755,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8719
8755
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8720
8756
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8721
8757
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8758
|
+
* **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"
|
|
8722
8759
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8723
8760
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8724
8761
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8756,7 +8793,6 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8756
8793
|
* **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*__
|
|
8757
8794
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8758
8795
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8759
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8760
8796
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8761
8797
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8762
8798
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -8865,6 +8901,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8865
8901
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8866
8902
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8867
8903
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8904
|
+
* **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"
|
|
8868
8905
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8869
8906
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
8870
8907
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -8902,7 +8939,6 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8902
8939
|
* **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*__
|
|
8903
8940
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8904
8941
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8905
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8906
8942
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8907
8943
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8908
8944
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -9083,6 +9119,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
9083
9119
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
9084
9120
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
9085
9121
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
9122
|
+
* **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"
|
|
9086
9123
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
9087
9124
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
9088
9125
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -9120,7 +9157,6 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
9120
9157
|
* **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*__
|
|
9121
9158
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
9122
9159
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
9123
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
9124
9160
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
9125
9161
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
9126
9162
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -9270,6 +9306,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9270
9306
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
9271
9307
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
9272
9308
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
9309
|
+
* **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"
|
|
9273
9310
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
9274
9311
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: true
|
|
9275
9312
|
* **staleOptions** (<code>[github.StaleOptions](#projen-github-staleoptions)</code>) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
|
|
@@ -9307,7 +9344,6 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9307
9344
|
* **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*__
|
|
9308
9345
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
9309
9346
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
9310
|
-
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
9311
9347
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
9312
9348
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
9313
9349
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
@@ -10353,7 +10389,6 @@ Name | Type | Description
|
|
|
10353
10389
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
10354
10390
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
10355
10391
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10356
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10357
10392
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10358
10393
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
10359
10394
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -10443,9 +10478,10 @@ Name | Type | Description
|
|
|
10443
10478
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10444
10479
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10445
10480
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
10481
|
+
**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"
|
|
10446
10482
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
10447
10483
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
10448
|
-
**projenUpgradeSecret
|
|
10484
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
10449
10485
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
10450
10486
|
**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
|
|
10451
10487
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -10582,6 +10618,7 @@ Name | Type | Description
|
|
|
10582
10618
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
10583
10619
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10584
10620
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10621
|
+
**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"
|
|
10585
10622
|
**projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
|
|
10586
10623
|
**projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
|
|
10587
10624
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
@@ -10613,7 +10650,6 @@ Name | Type | Description
|
|
|
10613
10650
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
10614
10651
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
10615
10652
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10616
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10617
10653
|
**appEntrypoint**?🔹 | <code>string</code> | The CDK app's entrypoint (relative to the source directory, which is "src" by default).<br/>__*Default*__: "main.ts"
|
|
10618
10654
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10619
10655
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
@@ -10703,9 +10739,10 @@ Name | Type | Description
|
|
|
10703
10739
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10704
10740
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10705
10741
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
10742
|
+
**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"
|
|
10706
10743
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
10707
10744
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
10708
|
-
**projenUpgradeSecret
|
|
10745
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
10709
10746
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
10710
10747
|
**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
|
|
10711
10748
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -10811,7 +10848,6 @@ Name | Type | Description
|
|
|
10811
10848
|
**name**⚠️ | <code>string</code> | This is the name of your project.
|
|
10812
10849
|
**repositoryUrl**⚠️ | <code>string</code> | Git repository URL.
|
|
10813
10850
|
**allowLibraryDependencies**?⚠️ | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10814
|
-
**antitamper**?⚠️ | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10815
10851
|
**artifactsDirectory**?⚠️ | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10816
10852
|
**authorEmail**?⚠️ | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
10817
10853
|
**authorName**?⚠️ | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -10901,6 +10937,7 @@ Name | Type | Description
|
|
|
10901
10937
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
10902
10938
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
10903
10939
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
10940
|
+
**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"
|
|
10904
10941
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
10905
10942
|
**projenUpgradeSchedule**?⚠️ | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
10906
10943
|
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
@@ -11032,7 +11069,6 @@ Name | Type | Description
|
|
|
11032
11069
|
-----|------|-------------
|
|
11033
11070
|
**artifactsDirectory**🔹 | <code>string</code> | A name of a directory that includes build artifacts.
|
|
11034
11071
|
**buildTask**🔹 | <code>[Task](#projen-task)</code> | The task to execute in order to build the project.
|
|
11035
|
-
**antitamper**?🔹 | <code>boolean</code> | Enable anti-tamper check.<br/>__*Default*__: true
|
|
11036
11072
|
**containerImage**?🔹 | <code>string</code> | The container image to use for builds.<br/>__*Default*__: the default workflow container
|
|
11037
11073
|
**env**?🔹 | <code>Map<string, string></code> | Build environment variables.<br/>__*Default*__: {}
|
|
11038
11074
|
**gitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | Git identity to use for the workflow.<br/>__*Default*__: default identity
|
|
@@ -11071,7 +11107,6 @@ Name | Type | Description
|
|
|
11071
11107
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11072
11108
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11073
11109
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11074
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11075
11110
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11076
11111
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11077
11112
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -11152,9 +11187,10 @@ Name | Type | Description
|
|
|
11152
11187
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11153
11188
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11154
11189
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11190
|
+
**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"
|
|
11155
11191
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11156
11192
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11157
|
-
**projenUpgradeSecret
|
|
11193
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11158
11194
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11159
11195
|
**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
|
|
11160
11196
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11286,7 +11322,6 @@ Name | Type | Description
|
|
|
11286
11322
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11287
11323
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11288
11324
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11289
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11290
11325
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11291
11326
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11292
11327
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -11366,9 +11401,10 @@ Name | Type | Description
|
|
|
11366
11401
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11367
11402
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11368
11403
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11404
|
+
**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"
|
|
11369
11405
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11370
11406
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11371
|
-
**projenUpgradeSecret
|
|
11407
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11372
11408
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11373
11409
|
**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
|
|
11374
11410
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11454,7 +11490,6 @@ Name | Type | Description
|
|
|
11454
11490
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
11455
11491
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11456
11492
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11457
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11458
11493
|
**appEntrypoint**?🔹 | <code>string</code> | The CDK8s app's entrypoint (relative to the source directory, which is "src" by default).<br/>__*Default*__: "main.ts"
|
|
11459
11494
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11460
11495
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
@@ -11537,9 +11572,10 @@ Name | Type | Description
|
|
|
11537
11572
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11538
11573
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11539
11574
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11575
|
+
**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"
|
|
11540
11576
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11541
11577
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11542
|
-
**projenUpgradeSecret
|
|
11578
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11543
11579
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11544
11580
|
**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
|
|
11545
11581
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11603,7 +11639,6 @@ Name | Type | Description
|
|
|
11603
11639
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11604
11640
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11605
11641
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11606
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11607
11642
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11608
11643
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11609
11644
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -11688,9 +11723,10 @@ Name | Type | Description
|
|
|
11688
11723
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11689
11724
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11690
11725
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11726
|
+
**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"
|
|
11691
11727
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11692
11728
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11693
|
-
**projenUpgradeSecret
|
|
11729
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11694
11730
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11695
11731
|
**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
|
|
11696
11732
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11760,7 +11796,6 @@ Name | Type | Description
|
|
|
11760
11796
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
11761
11797
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11762
11798
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11763
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11764
11799
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11765
11800
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11766
11801
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -11841,9 +11876,10 @@ Name | Type | Description
|
|
|
11841
11876
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11842
11877
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11843
11878
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11879
|
+
**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"
|
|
11844
11880
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11845
11881
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11846
|
-
**projenUpgradeSecret
|
|
11882
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11847
11883
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11848
11884
|
**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
|
|
11849
11885
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11906,10 +11942,10 @@ Options for 'AutoApprove'.
|
|
|
11906
11942
|
|
|
11907
11943
|
Name | Type | Description
|
|
11908
11944
|
-----|------|-------------
|
|
11909
|
-
**secret**🔹 | <code>string</code> | A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope.
|
|
11910
11945
|
**allowedUsernames**?🔹 | <code>Array<string></code> | Only pull requests authored by these Github usernames will be auto-approved.<br/>__*Default*__: ['github-bot']
|
|
11911
11946
|
**label**?🔹 | <code>string</code> | Only pull requests with this label will be auto-approved.<br/>__*Default*__: 'auto-approve'
|
|
11912
11947
|
**runsOn**?🔹 | <code>Array<string></code> | Github Runner selection labels.<br/>__*Default*__: ["ubuntu-latest"]
|
|
11948
|
+
**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"
|
|
11913
11949
|
|
|
11914
11950
|
|
|
11915
11951
|
|
|
@@ -11924,7 +11960,6 @@ Name | Type | Description
|
|
|
11924
11960
|
-----|------|-------------
|
|
11925
11961
|
**approvedReviews**?🔹 | <code>number</code> | Number of approved code reviews.<br/>__*Default*__: 1
|
|
11926
11962
|
**blockingLabels**?🔹 | <code>Array<string></code> | List of labels that will prevent auto-merging.<br/>__*Default*__: ['do-not-merge']
|
|
11927
|
-
**buildJob**?🔹 | <code>string</code> | The GitHub job ID of the build workflow.<br/>__*Optional*__
|
|
11928
11963
|
|
|
11929
11964
|
|
|
11930
11965
|
|
|
@@ -11993,6 +12028,7 @@ Name | Type | Description
|
|
|
11993
12028
|
-----|------|-------------
|
|
11994
12029
|
**mergify**?🔹 | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
|
|
11995
12030
|
**mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for Mergify.<br/>__*Default*__: default options
|
|
12031
|
+
**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"
|
|
11996
12032
|
**pullRequestLint**?🔹 | <code>boolean</code> | Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.<br/>__*Default*__: true
|
|
11997
12033
|
**pullRequestLintOptions**?🔹 | <code>[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)</code> | Options for configuring a pull request linter.<br/>__*Default*__: see defaults in `PullRequestLintOptions`
|
|
11998
12034
|
**workflows**?🔹 | <code>boolean</code> | Enables GitHub workflows.<br/>__*Default*__: true
|
|
@@ -12023,6 +12059,7 @@ Name | Type | Description
|
|
|
12023
12059
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
12024
12060
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12025
12061
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12062
|
+
**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"
|
|
12026
12063
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
12027
12064
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
12028
12065
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -12060,6 +12097,27 @@ Name | Type | Description
|
|
|
12060
12097
|
|
|
12061
12098
|
|
|
12062
12099
|
|
|
12100
|
+
## interface IAddConditionsLater 🔹 <a id="projen-github-iaddconditionslater"></a>
|
|
12101
|
+
|
|
12102
|
+
|
|
12103
|
+
|
|
12104
|
+
### Methods
|
|
12105
|
+
|
|
12106
|
+
|
|
12107
|
+
#### render()🔹 <a id="projen-github-iaddconditionslater-render"></a>
|
|
12108
|
+
|
|
12109
|
+
|
|
12110
|
+
|
|
12111
|
+
```ts
|
|
12112
|
+
render(): Array<string>
|
|
12113
|
+
```
|
|
12114
|
+
|
|
12115
|
+
|
|
12116
|
+
__Returns__:
|
|
12117
|
+
* <code>Array<string></code>
|
|
12118
|
+
|
|
12119
|
+
|
|
12120
|
+
|
|
12063
12121
|
## interface IJobProvider 🔹 <a id="projen-github-ijobprovider"></a>
|
|
12064
12122
|
|
|
12065
12123
|
|
|
@@ -12263,6 +12321,7 @@ Name | Type | Description
|
|
|
12263
12321
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
12264
12322
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12265
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"
|
|
12266
12325
|
**projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
|
|
12267
12326
|
**projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
|
|
12268
12327
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
@@ -12311,6 +12370,7 @@ Name | Type | Description
|
|
|
12311
12370
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
12312
12371
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12313
12372
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12373
|
+
**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"
|
|
12314
12374
|
**projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
|
|
12315
12375
|
**projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
|
|
12316
12376
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
@@ -12746,7 +12806,6 @@ Name | Type | Description
|
|
|
12746
12806
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
12747
12807
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
12748
12808
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
12749
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
12750
12809
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
12751
12810
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
12752
12811
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -12815,9 +12874,10 @@ Name | Type | Description
|
|
|
12815
12874
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12816
12875
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12817
12876
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
12877
|
+
**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"
|
|
12818
12878
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
12819
12879
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
12820
|
-
**projenUpgradeSecret
|
|
12880
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
12821
12881
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
12822
12882
|
**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
|
|
12823
12883
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -12856,20 +12916,6 @@ Name | Type | Description
|
|
|
12856
12916
|
|
|
12857
12917
|
|
|
12858
12918
|
|
|
12859
|
-
## struct NodeWorkflowSteps 🔹 <a id="projen-javascript-nodeworkflowsteps"></a>
|
|
12860
|
-
|
|
12861
|
-
|
|
12862
|
-
|
|
12863
|
-
|
|
12864
|
-
|
|
12865
|
-
|
|
12866
|
-
Name | Type | Description
|
|
12867
|
-
-----|------|-------------
|
|
12868
|
-
**antitamper**🔹 | <code>Array<any></code> | <span></span>
|
|
12869
|
-
**install**🔹 | <code>Array<any></code> | <span></span>
|
|
12870
|
-
|
|
12871
|
-
|
|
12872
|
-
|
|
12873
12919
|
## struct NpmConfigOptions 🔹 <a id="projen-javascript-npmconfigoptions"></a>
|
|
12874
12920
|
|
|
12875
12921
|
|
|
@@ -13007,7 +13053,6 @@ Name | Type | Description
|
|
|
13007
13053
|
**container**?🔹 | <code>[github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)</code> | Job container options.<br/>__*Default*__: defaults
|
|
13008
13054
|
**gitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | The git identity to use for commits.<br/>__*Default*__: "github-actions
|
|
13009
13055
|
**labels**?🔹 | <code>Array<string></code> | Labels to apply on the PR.<br/>__*Default*__: no labels.
|
|
13010
|
-
**rebuild**?🔹 | <code>boolean</code> | Execute 'build' after the upgrade.<br/>__*Default*__: true
|
|
13011
13056
|
**runsOn**?🔹 | <code>Array<string></code> | Github Runner selection labels.<br/>__*Default*__: ["ubuntu-latest"]
|
|
13012
13057
|
**schedule**?🔹 | <code>[javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule)</code> | Schedule to run on.<br/>__*Default*__: UpgradeDependenciesSchedule.DAILY
|
|
13013
13058
|
**secret**?🔹 | <code>string</code> | Which secret to use when creating the PR.<br/>__*Default*__: default github token.
|
|
@@ -13280,6 +13325,7 @@ Name | Type | Description
|
|
|
13280
13325
|
**poetryOptions**?🔹 | <code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code> | Additional options to set for poetry if using poetry.<br/>__*Optional*__
|
|
13281
13326
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13282
13327
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13328
|
+
**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"
|
|
13283
13329
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
13284
13330
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13285
13331
|
**projenrcPython**?🔹 | <code>boolean</code> | Use projenrc in python.<br/>__*Default*__: true
|
|
@@ -13645,7 +13691,6 @@ Name | Type | Description
|
|
|
13645
13691
|
**branch**🔹 | <code>string</code> | The default branch name to release from.
|
|
13646
13692
|
**task**🔹 | <code>[Task](#projen-task)</code> | The task to execute in order to create the release artifacts.
|
|
13647
13693
|
**versionFile**🔹 | <code>string</code> | A name of a .json file to set the `version` field in after a bump.
|
|
13648
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13649
13694
|
**githubRelease**?🔹 | <code>boolean</code> | Create a GitHub release for each release.<br/>__*Default*__: true
|
|
13650
13695
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `jsii-release` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
13651
13696
|
**majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
|
|
@@ -13678,7 +13723,6 @@ Project options for release.
|
|
|
13678
13723
|
|
|
13679
13724
|
Name | Type | Description
|
|
13680
13725
|
-----|------|-------------
|
|
13681
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13682
13726
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `jsii-release` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
13683
13727
|
**majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
|
|
13684
13728
|
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
@@ -13740,7 +13784,6 @@ Name | Type | Description
|
|
|
13740
13784
|
**defaultReleaseBranch**⚠️ | <code>string</code> | The name of the main release branch.
|
|
13741
13785
|
**name**⚠️ | <code>string</code> | This is the name of your project.
|
|
13742
13786
|
**allowLibraryDependencies**?⚠️ | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
13743
|
-
**antitamper**?⚠️ | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13744
13787
|
**artifactsDirectory**?⚠️ | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
13745
13788
|
**authorEmail**?⚠️ | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
13746
13789
|
**authorName**?⚠️ | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -13816,6 +13859,7 @@ Name | Type | Description
|
|
|
13816
13859
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13817
13860
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13818
13861
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
13862
|
+
**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"
|
|
13819
13863
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13820
13864
|
**projenUpgradeSchedule**?⚠️ | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
13821
13865
|
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
@@ -13878,7 +13922,6 @@ Name | Type | Description
|
|
|
13878
13922
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
13879
13923
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
13880
13924
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
13881
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13882
13925
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
13883
13926
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
13884
13927
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -13954,9 +13997,10 @@ Name | Type | Description
|
|
|
13954
13997
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13955
13998
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13956
13999
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14000
|
+
**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"
|
|
13957
14001
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13958
14002
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
13959
|
-
**projenUpgradeSecret
|
|
14003
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
13960
14004
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
13961
14005
|
**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
|
|
13962
14006
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -14120,7 +14164,6 @@ Name | Type | Description
|
|
|
14120
14164
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
14121
14165
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14122
14166
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14123
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14124
14167
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14125
14168
|
**assetsdir**?🔹 | <code>string</code> | Assets directory.<br/>__*Default*__: "public"
|
|
14126
14169
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
@@ -14190,9 +14233,10 @@ Name | Type | Description
|
|
|
14190
14233
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14191
14234
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14192
14235
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14236
|
+
**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"
|
|
14193
14237
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14194
14238
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
14195
|
-
**projenUpgradeSecret
|
|
14239
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
14196
14240
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
14197
14241
|
**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
|
|
14198
14242
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -14246,7 +14290,6 @@ Name | Type | Description
|
|
|
14246
14290
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
14247
14291
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14248
14292
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14249
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14250
14293
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14251
14294
|
**assetsdir**?🔹 | <code>string</code> | Assets directory.<br/>__*Default*__: "public"
|
|
14252
14295
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
@@ -14323,9 +14366,10 @@ Name | Type | Description
|
|
|
14323
14366
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14324
14367
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14325
14368
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14369
|
+
**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"
|
|
14326
14370
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14327
14371
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
14328
|
-
**projenUpgradeSecret
|
|
14372
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
14329
14373
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
14330
14374
|
**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
|
|
14331
14375
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -14415,7 +14459,6 @@ Name | Type | Description
|
|
|
14415
14459
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
14416
14460
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14417
14461
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14418
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14419
14462
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14420
14463
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
14421
14464
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -14484,9 +14527,10 @@ Name | Type | Description
|
|
|
14484
14527
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14485
14528
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14486
14529
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14530
|
+
**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"
|
|
14487
14531
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14488
14532
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
14489
|
-
**projenUpgradeSecret
|
|
14533
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
14490
14534
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
14491
14535
|
**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
|
|
14492
14536
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -14569,7 +14613,6 @@ Name | Type | Description
|
|
|
14569
14613
|
**defaultReleaseBranch**🔹 | <code>string</code> | The name of the main release branch.
|
|
14570
14614
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14571
14615
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14572
|
-
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14573
14616
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14574
14617
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
14575
14618
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -14645,9 +14688,10 @@ Name | Type | Description
|
|
|
14645
14688
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14646
14689
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14647
14690
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14691
|
+
**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"
|
|
14648
14692
|
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14649
14693
|
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
14650
|
-
**projenUpgradeSecret
|
|
14694
|
+
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
14651
14695
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
14652
14696
|
**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
|
|
14653
14697
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|