projen 0.53.16 → 0.54.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +442 -319
- package/changelog.md +1 -1
- package/docs/api/API.md +185 -181
- package/docs/github.md +40 -2
- package/docs/node.md +51 -0
- package/docs/tasks.md +3 -0
- package/lib/awscdk/auto-discover.js +4 -4
- package/lib/awscdk/awscdk-app-java.js +1 -1
- package/lib/awscdk/awscdk-app-py.js +1 -1
- package/lib/awscdk/awscdk-app-ts.js +1 -1
- package/lib/awscdk/awscdk-construct.js +2 -2
- package/lib/awscdk/awscdk-deps-java.js +1 -1
- package/lib/awscdk/awscdk-deps-js.js +1 -1
- package/lib/awscdk/awscdk-deps.js +1 -1
- package/lib/awscdk/cdk-config.js +1 -1
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/lambda-extension.js +1 -1
- package/lib/awscdk/lambda-function.js +2 -2
- package/lib/build/build-workflow.js +4 -3
- package/lib/cdk/auto-discover-base.js +2 -2
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/integration-test-base.js +1 -1
- package/lib/cdk/jsii-docgen.js +1 -1
- package/lib/cdk/jsii-project.js +1 -1
- package/lib/cdk8s/auto-discover.js +2 -2
- package/lib/cdk8s/cdk8s-app-ts.js +1 -1
- package/lib/cdk8s/cdk8s-construct.js +1 -1
- package/lib/cdk8s/integration-test.js +1 -1
- package/lib/cdktf/cdktf-construct.js +1 -1
- 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.js +1 -1
- package/lib/github/auto-merge.js +1 -1
- package/lib/github/dependabot.js +1 -1
- package/lib/github/github-credentials.d.ts +51 -0
- package/lib/github/github-credentials.js +75 -0
- package/lib/github/github-project.d.ts +13 -1
- package/lib/github/github-project.js +9 -6
- package/lib/github/github.d.ts +10 -3
- package/lib/github/github.js +22 -6
- package/lib/github/index.d.ts +1 -0
- package/lib/github/index.js +2 -1
- package/lib/github/mergify.js +1 -1
- package/lib/github/pr-template.js +1 -1
- package/lib/github/pull-request-lint.js +1 -1
- package/lib/github/stale.js +1 -1
- package/lib/github/task-workflow.js +1 -1
- package/lib/github/workflows.d.ts +3 -2
- package/lib/github/workflows.js +3 -3
- package/lib/gitlab/configuration.js +1 -1
- package/lib/gitlab/gitlab-configuration.js +1 -1
- package/lib/gitlab/nested-configuration.js +1 -1
- package/lib/gitpod.js +1 -1
- package/lib/ignore-file.js +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 +1 -1
- package/lib/javascript/node-package.js +1 -1
- package/lib/javascript/node-project.d.ts +1 -43
- package/lib/javascript/node-project.js +11 -46
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/prettier.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 +7 -20
- package/lib/javascript/upgrade-dependencies.js +21 -26
- 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-sample.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.js +1 -1
- package/lib/run-task.js +1813 -1
- 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/docs/api/API.md
CHANGED
|
@@ -73,6 +73,7 @@ Name|Description
|
|
|
73
73
|
[github.Dependabot](#projen-github-dependabot)|Defines dependabot configuration for node projects.
|
|
74
74
|
[github.GitHub](#projen-github-github)|*No description*
|
|
75
75
|
[github.GitHubProject](#projen-github-githubproject)|GitHub-based project.
|
|
76
|
+
[github.GithubCredentials](#projen-github-githubcredentials)|Represents a method of providing GitHub API access for projen workflows.
|
|
76
77
|
[github.GithubWorkflow](#projen-github-githubworkflow)|Workflow for GitHub.
|
|
77
78
|
[github.Mergify](#projen-github-mergify)|*No description*
|
|
78
79
|
[github.PullRequestLint](#projen-github-pullrequestlint)|Configure validations to run on GitHub pull requests.
|
|
@@ -230,6 +231,8 @@ Name|Description
|
|
|
230
231
|
[github.GitHubOptions](#projen-github-githuboptions)|*No description*
|
|
231
232
|
[github.GitHubProjectOptions](#projen-github-githubprojectoptions)|Options for `GitHubProject`.
|
|
232
233
|
[github.GitIdentity](#projen-github-gitidentity)|Represents the git identity.
|
|
234
|
+
[github.GithubCredentialsAppOptions](#projen-github-githubcredentialsappoptions)|Options for `GithubCredentials.fromApp`.
|
|
235
|
+
[github.GithubCredentialsPersonalAccessTokenOptions](#projen-github-githubcredentialspersonalaccesstokenoptions)|Options for `GithubCredentials.fromPersonalAccessToken`.
|
|
233
236
|
[github.GithubWorkflowOptions](#projen-github-githubworkflowoptions)|Options for `GithubWorkflow`.
|
|
234
237
|
[github.MergifyConditionalOperator](#projen-github-mergifyconditionaloperator)|The Mergify conditional operators that can be used are: `or` and `and`.
|
|
235
238
|
[github.MergifyOptions](#projen-github-mergifyoptions)|*No description*
|
|
@@ -3036,6 +3039,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
3036
3039
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3037
3040
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3038
3041
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3042
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
3039
3043
|
* **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"
|
|
3040
3044
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3041
3045
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -3095,7 +3099,6 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
3095
3099
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
3096
3100
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
3097
3101
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
3098
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3099
3102
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3100
3103
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3101
3104
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -3107,7 +3110,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
3107
3110
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
3108
3111
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
3109
3112
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
3110
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
3113
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
3111
3114
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
3112
3115
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
3113
3116
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -3120,9 +3123,6 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
3120
3123
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3121
3124
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
3122
3125
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
3123
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3124
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
3125
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
3126
3126
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
3127
3127
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
3128
3128
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -3442,6 +3442,7 @@ new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
|
|
|
3442
3442
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3443
3443
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3444
3444
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3445
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
3445
3446
|
* **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"
|
|
3446
3447
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3447
3448
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -3548,6 +3549,7 @@ new awscdk.AwsCdkPythonApp(options: AwsCdkPythonAppOptions)
|
|
|
3548
3549
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3549
3550
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3550
3551
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3552
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
3551
3553
|
* **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"
|
|
3552
3554
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3553
3555
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -3644,6 +3646,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3644
3646
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3645
3647
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3646
3648
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3649
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
3647
3650
|
* **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"
|
|
3648
3651
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3649
3652
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -3703,7 +3706,6 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3703
3706
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
3704
3707
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
3705
3708
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
3706
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3707
3709
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3708
3710
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3709
3711
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -3715,7 +3717,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3715
3717
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
3716
3718
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
3717
3719
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
3718
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
3720
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
3719
3721
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
3720
3722
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
3721
3723
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -3728,9 +3730,6 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3728
3730
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3729
3731
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
3730
3732
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
3731
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3732
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
3733
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
3734
3733
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
3735
3734
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
3736
3735
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -3918,6 +3917,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3918
3917
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
3919
3918
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
3920
3919
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
3920
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
3921
3921
|
* **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"
|
|
3922
3922
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
3923
3923
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -3977,7 +3977,6 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3977
3977
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
3978
3978
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
3979
3979
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
3980
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3981
3980
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3982
3981
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
3983
3982
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -3989,7 +3988,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3989
3988
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
3990
3989
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
3991
3990
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
3992
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
3991
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
3993
3992
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
3994
3993
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
3995
3994
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -4002,9 +4001,6 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
4002
4001
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4003
4002
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
4004
4003
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
4005
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4006
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
4007
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
4008
4004
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
4009
4005
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
4010
4006
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -4490,6 +4486,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4490
4486
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4491
4487
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4492
4488
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4489
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
4493
4490
|
* **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"
|
|
4494
4491
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4495
4492
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -4549,7 +4546,6 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4549
4546
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4550
4547
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
4551
4548
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
4552
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4553
4549
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4554
4550
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4555
4551
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -4561,7 +4557,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4561
4557
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
4562
4558
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
4563
4559
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
4564
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
4560
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
4565
4561
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
4566
4562
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
4567
4563
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -4574,9 +4570,6 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
4574
4570
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4575
4571
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
4576
4572
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
4577
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4578
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
4579
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
4580
4573
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
4581
4574
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
4582
4575
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -4743,6 +4736,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4743
4736
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4744
4737
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4745
4738
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4739
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
4746
4740
|
* **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"
|
|
4747
4741
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4748
4742
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -4802,7 +4796,6 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4802
4796
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4803
4797
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
4804
4798
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
4805
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4806
4799
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4807
4800
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
4808
4801
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -4814,7 +4807,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4814
4807
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
4815
4808
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
4816
4809
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
4817
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
4810
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
4818
4811
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
4819
4812
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
4820
4813
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -4827,9 +4820,6 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4827
4820
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4828
4821
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
4829
4822
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
4830
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4831
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
4832
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
4833
4823
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
4834
4824
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
4835
4825
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -4942,6 +4932,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4942
4932
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
4943
4933
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
4944
4934
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
4935
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
4945
4936
|
* **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"
|
|
4946
4937
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
4947
4938
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -5001,7 +4992,6 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
5001
4992
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
5002
4993
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
5003
4994
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
5004
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
5005
4995
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
5006
4996
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
5007
4997
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -5013,7 +5003,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
5013
5003
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
5014
5004
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
5015
5005
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
5016
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
5006
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
5017
5007
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
5018
5008
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
5019
5009
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -5026,9 +5016,6 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
5026
5016
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
5027
5017
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
5028
5018
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
5029
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
5030
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
5031
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
5032
5019
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
5033
5020
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
5034
5021
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -5119,6 +5106,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
5119
5106
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5120
5107
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
5121
5108
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
5109
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
5122
5110
|
* **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"
|
|
5123
5111
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
5124
5112
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -5178,7 +5166,6 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
5178
5166
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
5179
5167
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
5180
5168
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
5181
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
5182
5169
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
5183
5170
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
5184
5171
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -5190,7 +5177,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
5190
5177
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
5191
5178
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
5192
5179
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
5193
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
5180
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
5194
5181
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
5195
5182
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
5196
5183
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -5203,9 +5190,6 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
5203
5190
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
5204
5191
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
5205
5192
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
5206
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
5207
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
5208
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
5209
5193
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
5210
5194
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
5211
5195
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -5355,6 +5339,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
5355
5339
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5356
5340
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
5357
5341
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
5342
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
5358
5343
|
* **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"
|
|
5359
5344
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
5360
5345
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -5414,7 +5399,6 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
5414
5399
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
5415
5400
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
5416
5401
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
5417
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
5418
5402
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
5419
5403
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
5420
5404
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -5426,7 +5410,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
5426
5410
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
5427
5411
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
5428
5412
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
5429
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
5413
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
5430
5414
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
5431
5415
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
5432
5416
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -5439,9 +5423,6 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
5439
5423
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
5440
5424
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
5441
5425
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
5442
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
5443
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
5444
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
5445
5426
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
5446
5427
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
5447
5428
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -5663,6 +5644,7 @@ new github.GitHub(project: Project, options?: GitHubOptions)
|
|
|
5663
5644
|
* **options** (<code>[github.GitHubOptions](#projen-github-githuboptions)</code>) *No description*
|
|
5664
5645
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5665
5646
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for Mergify. __*Default*__: default options
|
|
5647
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
5666
5648
|
* **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"
|
|
5667
5649
|
* **pullRequestLint** (<code>boolean</code>) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits. __*Default*__: true
|
|
5668
5650
|
* **pullRequestLintOptions** (<code>[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)</code>) Options for configuring a pull request linter. __*Default*__: see defaults in `PullRequestLintOptions`
|
|
@@ -5675,7 +5657,7 @@ new github.GitHub(project: Project, options?: GitHubOptions)
|
|
|
5675
5657
|
|
|
5676
5658
|
Name | Type | Description
|
|
5677
5659
|
-----|------|-------------
|
|
5678
|
-
**
|
|
5660
|
+
**projenCredentials**🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | GitHub API authentication method used by projen workflows.
|
|
5679
5661
|
**workflows**🔹 | <code>Array<[github.GithubWorkflow](#projen-github-githubworkflow)></code> | All workflows.
|
|
5680
5662
|
**workflowsEnabled**🔹 | <code>boolean</code> | Are workflows enabled?
|
|
5681
5663
|
**mergify**?🔹 | <code>[github.Mergify](#projen-github-mergify)</code> | The `Mergify` configured on this repository.<br/>__*Optional*__
|
|
@@ -5793,6 +5775,7 @@ new github.GitHubProject(options: GitHubProjectOptions)
|
|
|
5793
5775
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
5794
5776
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
5795
5777
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
5778
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
5796
5779
|
* **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"
|
|
5797
5780
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
5798
5781
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -5835,6 +5818,63 @@ annotateGenerated(glob: string): void
|
|
|
5835
5818
|
|
|
5836
5819
|
|
|
5837
5820
|
|
|
5821
|
+
## class GithubCredentials 🔹 <a id="projen-github-githubcredentials"></a>
|
|
5822
|
+
|
|
5823
|
+
Represents a method of providing GitHub API access for projen workflows.
|
|
5824
|
+
|
|
5825
|
+
__Submodule__: github
|
|
5826
|
+
|
|
5827
|
+
|
|
5828
|
+
|
|
5829
|
+
### Properties
|
|
5830
|
+
|
|
5831
|
+
|
|
5832
|
+
Name | Type | Description
|
|
5833
|
+
-----|------|-------------
|
|
5834
|
+
**setupSteps**🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Setup steps to obtain GitHub credentials.
|
|
5835
|
+
**tokenRef**🔹 | <code>string</code> | The value to use in a workflow when a GitHub token is expected.
|
|
5836
|
+
|
|
5837
|
+
### Methods
|
|
5838
|
+
|
|
5839
|
+
|
|
5840
|
+
#### *static* fromApp(options?)🔹 <a id="projen-github-githubcredentials-fromapp"></a>
|
|
5841
|
+
|
|
5842
|
+
Provide API access through a GitHub App.
|
|
5843
|
+
|
|
5844
|
+
The GitHub App must be installed on the GitHub repo, its App ID and a
|
|
5845
|
+
private key must be added as secrets to the repo. The name of the secrets
|
|
5846
|
+
can be specified here.
|
|
5847
|
+
|
|
5848
|
+
```ts
|
|
5849
|
+
static fromApp(options?: GithubCredentialsAppOptions): GithubCredentials
|
|
5850
|
+
```
|
|
5851
|
+
|
|
5852
|
+
* **options** (<code>[github.GithubCredentialsAppOptions](#projen-github-githubcredentialsappoptions)</code>) *No description*
|
|
5853
|
+
* **appIdSecret** (<code>string</code>) *No description* __*Optional*__
|
|
5854
|
+
* **privateKeySecret** (<code>string</code>) *No description* __*Optional*__
|
|
5855
|
+
|
|
5856
|
+
__Returns__:
|
|
5857
|
+
* <code>[github.GithubCredentials](#projen-github-githubcredentials)</code>
|
|
5858
|
+
|
|
5859
|
+
#### *static* fromPersonalAccessToken(options?)🔹 <a id="projen-github-githubcredentials-frompersonalaccesstoken"></a>
|
|
5860
|
+
|
|
5861
|
+
Provide API access through a GitHub personal access token.
|
|
5862
|
+
|
|
5863
|
+
The token must be added as a secret to the GitHub repo, and the name of the
|
|
5864
|
+
secret can be specified here.
|
|
5865
|
+
|
|
5866
|
+
```ts
|
|
5867
|
+
static fromPersonalAccessToken(options?: GithubCredentialsPersonalAccessTokenOptions): GithubCredentials
|
|
5868
|
+
```
|
|
5869
|
+
|
|
5870
|
+
* **options** (<code>[github.GithubCredentialsPersonalAccessTokenOptions](#projen-github-githubcredentialspersonalaccesstokenoptions)</code>) *No description*
|
|
5871
|
+
* **secret** (<code>string</code>) *No description* __*Optional*__
|
|
5872
|
+
|
|
5873
|
+
__Returns__:
|
|
5874
|
+
* <code>[github.GithubCredentials](#projen-github-githubcredentials)</code>
|
|
5875
|
+
|
|
5876
|
+
|
|
5877
|
+
|
|
5838
5878
|
## class GithubWorkflow 🔹 <a id="projen-github-githubworkflow"></a>
|
|
5839
5879
|
|
|
5840
5880
|
Workflow for GitHub.
|
|
@@ -5868,7 +5908,7 @@ new github.GithubWorkflow(github: GitHub, name: string, options?: GithubWorkflow
|
|
|
5868
5908
|
Name | Type | Description
|
|
5869
5909
|
-----|------|-------------
|
|
5870
5910
|
**name**🔹 | <code>string</code> | The name of the workflow.
|
|
5871
|
-
**
|
|
5911
|
+
**projenCredentials**🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | GitHub API authentication method used by projen workflows.
|
|
5872
5912
|
**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
|
|
5873
5913
|
**file**?🔹 | <code>[YamlFile](#projen-yamlfile)</code> | The workflow YAML file.<br/>__*Optional*__
|
|
5874
5914
|
|
|
@@ -6426,6 +6466,7 @@ new java.JavaProject(options: JavaProjectOptions)
|
|
|
6426
6466
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
6427
6467
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
6428
6468
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
6469
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
6429
6470
|
* **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"
|
|
6430
6471
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
6431
6472
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -7415,6 +7456,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
7415
7456
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
7416
7457
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
7417
7458
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
7459
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
7418
7460
|
* **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"
|
|
7419
7461
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
7420
7462
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -7474,7 +7516,6 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
7474
7516
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
7475
7517
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
7476
7518
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
7477
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
7478
7519
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
7479
7520
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
7480
7521
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -7486,7 +7527,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
7486
7527
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
7487
7528
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
7488
7529
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
7489
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
7530
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
7490
7531
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
7491
7532
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
7492
7533
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -7499,9 +7540,6 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
7499
7540
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
7500
7541
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
7501
7542
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
7502
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
7503
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
7504
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
7505
7543
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
7506
7544
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
7507
7545
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -8014,7 +8052,6 @@ new javascript.UpgradeDependencies(project: NodeProject, options?: UpgradeDepend
|
|
|
8014
8052
|
* **project** (<code>[javascript.NodeProject](#projen-javascript-nodeproject)</code>) *No description*
|
|
8015
8053
|
* **options** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) *No description*
|
|
8016
8054
|
* **exclude** (<code>Array<string></code>) List of package names to exclude during the upgrade. __*Default*__: Nothing is excluded.
|
|
8017
|
-
* **ignoreProjen** (<code>boolean</code>) Whether or not to ignore projen upgrades. __*Default*__: true
|
|
8018
8055
|
* **include** (<code>Array<string></code>) List of package names to include during the upgrade. __*Default*__: Everything is included.
|
|
8019
8056
|
* **pullRequestTitle** (<code>string</code>) Title of the pull request to use (should be all lower-case). __*Default*__: "upgrade dependencies"
|
|
8020
8057
|
* **signoff** (<code>boolean</code>) Add Signed-off-by line by the committer at the end of the commit log message. __*Default*__: true
|
|
@@ -8029,7 +8066,6 @@ new javascript.UpgradeDependencies(project: NodeProject, options?: UpgradeDepend
|
|
|
8029
8066
|
|
|
8030
8067
|
Name | Type | Description
|
|
8031
8068
|
-----|------|-------------
|
|
8032
|
-
**ignoresProjen**🔹 | <code>boolean</code> | Whether or not projen is also upgraded in this workflow,.
|
|
8033
8069
|
**postUpgradeTask**🔹 | <code>[Task](#projen-task)</code> | A task run after the upgrade task.
|
|
8034
8070
|
**upgradeTask**🔹 | <code>[Task](#projen-task)</code> | The upgrade task.
|
|
8035
8071
|
**workflows**🔹 | <code>Array<[github.GithubWorkflow](#projen-github-githubworkflow)></code> | The workflows that execute the upgrades.
|
|
@@ -8442,6 +8478,7 @@ new python.PythonProject(options: PythonProjectOptions)
|
|
|
8442
8478
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
8443
8479
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
8444
8480
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
8481
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
8445
8482
|
* **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"
|
|
8446
8483
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
8447
8484
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -9214,6 +9251,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
9214
9251
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
9215
9252
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
9216
9253
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
9254
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
9217
9255
|
* **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"
|
|
9218
9256
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
9219
9257
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -9273,7 +9311,6 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
9273
9311
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
9274
9312
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
9275
9313
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
9276
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9277
9314
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9278
9315
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9279
9316
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -9285,7 +9322,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
9285
9322
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
9286
9323
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
9287
9324
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
9288
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
9325
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
9289
9326
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
9290
9327
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
9291
9328
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -9298,9 +9335,6 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
9298
9335
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9299
9336
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
9300
9337
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
9301
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9302
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
9303
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
9304
9338
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
9305
9339
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
9306
9340
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -9365,6 +9399,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
9365
9399
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
9366
9400
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
9367
9401
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
9402
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
9368
9403
|
* **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"
|
|
9369
9404
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
9370
9405
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -9424,7 +9459,6 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
9424
9459
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
9425
9460
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
9426
9461
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
9427
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9428
9462
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9429
9463
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9430
9464
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -9436,7 +9470,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
9436
9470
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
9437
9471
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
9438
9472
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
9439
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
9473
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
9440
9474
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
9441
9475
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
9442
9476
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -9449,9 +9483,6 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
9449
9483
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9450
9484
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
9451
9485
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
9452
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9453
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
9454
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
9455
9486
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
9456
9487
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
9457
9488
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -9516,6 +9547,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
9516
9547
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
9517
9548
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
9518
9549
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
9550
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
9519
9551
|
* **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"
|
|
9520
9552
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
9521
9553
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -9575,7 +9607,6 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
9575
9607
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
9576
9608
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
9577
9609
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
9578
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9579
9610
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9580
9611
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9581
9612
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -9587,7 +9618,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
9587
9618
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
9588
9619
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
9589
9620
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
9590
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
9621
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
9591
9622
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
9592
9623
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
9593
9624
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -9600,9 +9631,6 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
9600
9631
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9601
9632
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
9602
9633
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
9603
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9604
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
9605
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
9606
9634
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
9607
9635
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
9608
9636
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -9912,6 +9940,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
9912
9940
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
9913
9941
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
9914
9942
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
9943
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
9915
9944
|
* **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"
|
|
9916
9945
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
9917
9946
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -9971,7 +10000,6 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
9971
10000
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
9972
10001
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
9973
10002
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
9974
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9975
10003
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9976
10004
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
9977
10005
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -9983,7 +10011,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
9983
10011
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
9984
10012
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
9985
10013
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
9986
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
10014
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
9987
10015
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
9988
10016
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
9989
10017
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -9996,9 +10024,6 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
9996
10024
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9997
10025
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
9998
10026
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
9999
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
10000
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
10001
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
10002
10027
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
10003
10028
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
10004
10029
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -10061,6 +10086,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
10061
10086
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
10062
10087
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
10063
10088
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
10089
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
10064
10090
|
* **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"
|
|
10065
10091
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
10066
10092
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -10120,7 +10146,6 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
10120
10146
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
10121
10147
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
10122
10148
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
10123
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
10124
10149
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
10125
10150
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
10126
10151
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -10132,7 +10157,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
10132
10157
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
10133
10158
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
10134
10159
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
10135
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
10160
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
10136
10161
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
10137
10162
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
10138
10163
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -10145,9 +10170,6 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
10145
10170
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
10146
10171
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
10147
10172
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
10148
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
10149
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
10150
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
10151
10173
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
10152
10174
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
10153
10175
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -10282,6 +10304,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
10282
10304
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
10283
10305
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
10284
10306
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
10307
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
10285
10308
|
* **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"
|
|
10286
10309
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
10287
10310
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -10341,7 +10364,6 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
10341
10364
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
10342
10365
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
10343
10366
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
10344
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
10345
10367
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
10346
10368
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
10347
10369
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -10353,7 +10375,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
10353
10375
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
10354
10376
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
10355
10377
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
10356
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
10378
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
10357
10379
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
10358
10380
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
10359
10381
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -10366,9 +10388,6 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
10366
10388
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
10367
10389
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
10368
10390
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
10369
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
10370
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
10371
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
10372
10391
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
10373
10392
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
10374
10393
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -10473,6 +10492,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
10473
10492
|
* **mergify** (<code>boolean</code>) Whether mergify should be enabled on this repository or not. __*Default*__: true
|
|
10474
10493
|
* **mergifyOptions** (<code>[github.MergifyOptions](#projen-github-mergifyoptions)</code>) Options for mergify. __*Default*__: default options
|
|
10475
10494
|
* **projectType** (<code>[ProjectType](#projen-projecttype)</code>) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
|
|
10495
|
+
* **projenCredentials** (<code>[github.GithubCredentials](#projen-github-githubcredentials)</code>) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
10476
10496
|
* **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"
|
|
10477
10497
|
* **readme** (<code>[SampleReadmeProps](#projen-samplereadmeprops)</code>) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
10478
10498
|
* **stale** (<code>boolean</code>) Auto-close of stale issues and pull request. __*Default*__: false
|
|
@@ -10532,7 +10552,6 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
10532
10552
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
10533
10553
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
10534
10554
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
10535
|
-
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
10536
10555
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
10537
10556
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
10538
10557
|
* **buildWorkflowTriggers** (<code>[github.workflows.Triggers](#projen-github-workflows-triggers)</code>) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
|
|
@@ -10544,7 +10563,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
10544
10563
|
* **dependabot** (<code>boolean</code>) Use dependabot to handle dependency upgrades. __*Default*__: false
|
|
10545
10564
|
* **dependabotOptions** (<code>[github.DependabotOptions](#projen-github-dependabotoptions)</code>) Options for dependabot. __*Default*__: default options
|
|
10546
10565
|
* **depsUpgrade** (<code>boolean</code>) Use github workflows to handle dependency upgrades. __*Default*__: true
|
|
10547
|
-
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for
|
|
10566
|
+
* **depsUpgradeOptions** (<code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code>) Options for `UpgradeDependencies`. __*Default*__: default options
|
|
10548
10567
|
* **gitignore** (<code>Array<string></code>) Additional entries to .gitignore. __*Optional*__
|
|
10549
10568
|
* **jest** (<code>boolean</code>) Setup jest unit tests. __*Default*__: true
|
|
10550
10569
|
* **jestOptions** (<code>[javascript.JestOptions](#projen-javascript-jestoptions)</code>) Jest options. __*Default*__: default options
|
|
@@ -10557,9 +10576,6 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
10557
10576
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
10558
10577
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
10559
10578
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
10560
|
-
* **projenUpgradeAutoMerge** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
10561
|
-
* **projenUpgradeSchedule** (<code>Array<string></code>) Customize the projenUpgrade schedule in cron expression. __*Default*__: [ "0 6 * * *" ]
|
|
10562
|
-
* **projenUpgradeSecret** (<code>string</code>) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). __*Default*__: no automatic projen upgrade pull requests
|
|
10563
10579
|
* **projenVersion** (<code>string</code>) Version of projen to install. __*Default*__: Defaults to the latest version.
|
|
10564
10580
|
* **pullRequestTemplate** (<code>boolean</code>) Include a GitHub pull request template. __*Default*__: true
|
|
10565
10581
|
* **pullRequestTemplateContents** (<code>Array<string></code>) The contents of the pull request template. __*Default*__: default content
|
|
@@ -11592,7 +11608,6 @@ Name | Type | Description
|
|
|
11592
11608
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
11593
11609
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
11594
11610
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
11595
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11596
11611
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
11597
11612
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
11598
11613
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -11623,7 +11638,7 @@ Name | Type | Description
|
|
|
11623
11638
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
11624
11639
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
11625
11640
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
11626
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
11641
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
11627
11642
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
11628
11643
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
11629
11644
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -11680,11 +11695,9 @@ Name | Type | Description
|
|
|
11680
11695
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
11681
11696
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11682
11697
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11698
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
11683
11699
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
11684
|
-
**projenTokenSecret
|
|
11685
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11686
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
11687
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
11700
|
+
**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"
|
|
11688
11701
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
11689
11702
|
**projenrcJs**?🔹 | <code>boolean</code> | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.<br/>__*Default*__: true if projenrcJson is false
|
|
11690
11703
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -11827,7 +11840,8 @@ Name | Type | Description
|
|
|
11827
11840
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
11828
11841
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11829
11842
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11830
|
-
**
|
|
11843
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
11844
|
+
**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"
|
|
11831
11845
|
**projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
|
|
11832
11846
|
**projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
|
|
11833
11847
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
@@ -11914,7 +11928,8 @@ Name | Type | Description
|
|
|
11914
11928
|
**poetryOptions**?🔹 | <code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code> | Additional options to set for poetry if using poetry.<br/>__*Optional*__
|
|
11915
11929
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
11916
11930
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
11917
|
-
**
|
|
11931
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
11932
|
+
**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"
|
|
11918
11933
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
11919
11934
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
11920
11935
|
**projenrcPython**?🔹 | <code>boolean</code> | Use projenrc in python.<br/>__*Default*__: true
|
|
@@ -11957,7 +11972,6 @@ Name | Type | Description
|
|
|
11957
11972
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
11958
11973
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
11959
11974
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
11960
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
11961
11975
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
11962
11976
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
11963
11977
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -11988,7 +12002,7 @@ Name | Type | Description
|
|
|
11988
12002
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
11989
12003
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
11990
12004
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
11991
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
12005
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
11992
12006
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
11993
12007
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
11994
12008
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -12043,11 +12057,9 @@ Name | Type | Description
|
|
|
12043
12057
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
12044
12058
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12045
12059
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12060
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
12046
12061
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
12047
|
-
**projenTokenSecret
|
|
12048
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
12049
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
12050
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
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"
|
|
12051
12063
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
12052
12064
|
**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
|
|
12053
12065
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -12159,7 +12171,6 @@ Name | Type | Description
|
|
|
12159
12171
|
**authorOrganization**?⚠️ | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
12160
12172
|
**authorUrl**?⚠️ | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
12161
12173
|
**autoApproveOptions**?⚠️ | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
12162
|
-
**autoApproveProjenUpgrades**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
12163
12174
|
**autoApproveUpgrades**?⚠️ | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
12164
12175
|
**autoDetectBin**?⚠️ | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
12165
12176
|
**autoMergeOptions**?⚠️ | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -12190,7 +12201,7 @@ Name | Type | Description
|
|
|
12190
12201
|
**dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
12191
12202
|
**deps**?⚠️ | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
12192
12203
|
**depsUpgrade**?⚠️ | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
12193
|
-
**depsUpgradeOptions**?⚠️ | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
12204
|
+
**depsUpgradeOptions**?⚠️ | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
12194
12205
|
**description**?⚠️ | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
12195
12206
|
**devContainer**?⚠️ | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
12196
12207
|
**devDeps**?⚠️ | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -12247,11 +12258,9 @@ Name | Type | Description
|
|
|
12247
12258
|
**prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
12248
12259
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12249
12260
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12261
|
+
**projenCredentials**?⚠️ | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
12250
12262
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
12251
12263
|
**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"
|
|
12252
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
12253
|
-
**projenUpgradeSchedule**?⚠️ | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
12254
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
12255
12264
|
**projenVersion**?⚠️ | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
12256
12265
|
**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
|
|
12257
12266
|
**projenrcJsOptions**?⚠️ | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -12557,7 +12566,6 @@ Name | Type | Description
|
|
|
12557
12566
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
12558
12567
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
12559
12568
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
12560
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
12561
12569
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
12562
12570
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
12563
12571
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -12581,7 +12589,7 @@ Name | Type | Description
|
|
|
12581
12589
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
12582
12590
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
12583
12591
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
12584
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
12592
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
12585
12593
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
12586
12594
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
12587
12595
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -12634,11 +12642,9 @@ Name | Type | Description
|
|
|
12634
12642
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
12635
12643
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12636
12644
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12645
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
12637
12646
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
12638
|
-
**projenTokenSecret
|
|
12639
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
12640
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
12641
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
12647
|
+
**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"
|
|
12642
12648
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
12643
12649
|
**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
|
|
12644
12650
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -12817,7 +12823,6 @@ Name | Type | Description
|
|
|
12817
12823
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
12818
12824
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
12819
12825
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
12820
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
12821
12826
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
12822
12827
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
12823
12828
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -12840,7 +12845,7 @@ Name | Type | Description
|
|
|
12840
12845
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
12841
12846
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
12842
12847
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
12843
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
12848
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
12844
12849
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
12845
12850
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
12846
12851
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -12893,11 +12898,9 @@ Name | Type | Description
|
|
|
12893
12898
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
12894
12899
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
12895
12900
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
12901
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
12896
12902
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
12897
|
-
**projenTokenSecret
|
|
12898
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
12899
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
12900
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
12903
|
+
**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"
|
|
12901
12904
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
12902
12905
|
**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
|
|
12903
12906
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -13005,7 +13008,6 @@ Name | Type | Description
|
|
|
13005
13008
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
13006
13009
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
13007
13010
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
13008
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13009
13011
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
13010
13012
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
13011
13013
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -13033,7 +13035,7 @@ Name | Type | Description
|
|
|
13033
13035
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
13034
13036
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
13035
13037
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
13036
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
13038
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
13037
13039
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
13038
13040
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
13039
13041
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -13085,11 +13087,9 @@ Name | Type | Description
|
|
|
13085
13087
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
13086
13088
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13087
13089
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13090
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
13088
13091
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
13089
|
-
**projenTokenSecret
|
|
13090
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13091
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
13092
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
13092
|
+
**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"
|
|
13093
13093
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
13094
13094
|
**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
|
|
13095
13095
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -13159,7 +13159,6 @@ Name | Type | Description
|
|
|
13159
13159
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
13160
13160
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
13161
13161
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
13162
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13163
13162
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
13164
13163
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
13165
13164
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -13187,7 +13186,7 @@ Name | Type | Description
|
|
|
13187
13186
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
13188
13187
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
13189
13188
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
13190
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
13189
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
13191
13190
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
13192
13191
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
13193
13192
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -13241,11 +13240,9 @@ Name | Type | Description
|
|
|
13241
13240
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
13242
13241
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13243
13242
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13243
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
13244
13244
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
13245
|
-
**projenTokenSecret
|
|
13246
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13247
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
13248
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
13245
|
+
**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"
|
|
13249
13246
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
13250
13247
|
**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
|
|
13251
13248
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -13350,7 +13347,6 @@ Name | Type | Description
|
|
|
13350
13347
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
13351
13348
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
13352
13349
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
13353
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13354
13350
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
13355
13351
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
13356
13352
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -13375,7 +13371,7 @@ Name | Type | Description
|
|
|
13375
13371
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
13376
13372
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
13377
13373
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
13378
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
13374
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
13379
13375
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
13380
13376
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
13381
13377
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -13428,11 +13424,9 @@ Name | Type | Description
|
|
|
13428
13424
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
13429
13425
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13430
13426
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13427
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
13431
13428
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
13432
|
-
**projenTokenSecret
|
|
13433
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
13434
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
13435
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
13429
|
+
**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"
|
|
13436
13430
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
13437
13431
|
**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
|
|
13438
13432
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -13581,7 +13575,8 @@ Name | Type | Description
|
|
|
13581
13575
|
-----|------|-------------
|
|
13582
13576
|
**mergify**?🔹 | <code>boolean</code> | Whether mergify should be enabled on this repository or not.<br/>__*Default*__: true
|
|
13583
13577
|
**mergifyOptions**?🔹 | <code>[github.MergifyOptions](#projen-github-mergifyoptions)</code> | Options for Mergify.<br/>__*Default*__: default options
|
|
13584
|
-
**
|
|
13578
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
13579
|
+
**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"
|
|
13585
13580
|
**pullRequestLint**?🔹 | <code>boolean</code> | Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.<br/>__*Default*__: true
|
|
13586
13581
|
**pullRequestLintOptions**?🔹 | <code>[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)</code> | Options for configuring a pull request linter.<br/>__*Default*__: see defaults in `PullRequestLintOptions`
|
|
13587
13582
|
**workflows**?🔹 | <code>boolean</code> | Enables GitHub workflows.<br/>__*Default*__: true
|
|
@@ -13612,7 +13607,8 @@ Name | Type | Description
|
|
|
13612
13607
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
13613
13608
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
13614
13609
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
13615
|
-
**
|
|
13610
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
13611
|
+
**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"
|
|
13616
13612
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
13617
13613
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13618
13614
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -13636,6 +13632,33 @@ Name | Type | Description
|
|
|
13636
13632
|
|
|
13637
13633
|
|
|
13638
13634
|
|
|
13635
|
+
## struct GithubCredentialsAppOptions 🔹 <a id="projen-github-githubcredentialsappoptions"></a>
|
|
13636
|
+
|
|
13637
|
+
|
|
13638
|
+
Options for `GithubCredentials.fromApp`.
|
|
13639
|
+
|
|
13640
|
+
|
|
13641
|
+
|
|
13642
|
+
Name | Type | Description
|
|
13643
|
+
-----|------|-------------
|
|
13644
|
+
**appIdSecret**?🔹 | <code>string</code> | __*Optional*__
|
|
13645
|
+
**privateKeySecret**?🔹 | <code>string</code> | __*Optional*__
|
|
13646
|
+
|
|
13647
|
+
|
|
13648
|
+
|
|
13649
|
+
## struct GithubCredentialsPersonalAccessTokenOptions 🔹 <a id="projen-github-githubcredentialspersonalaccesstokenoptions"></a>
|
|
13650
|
+
|
|
13651
|
+
|
|
13652
|
+
Options for `GithubCredentials.fromPersonalAccessToken`.
|
|
13653
|
+
|
|
13654
|
+
|
|
13655
|
+
|
|
13656
|
+
Name | Type | Description
|
|
13657
|
+
-----|------|-------------
|
|
13658
|
+
**secret**?🔹 | <code>string</code> | __*Optional*__
|
|
13659
|
+
|
|
13660
|
+
|
|
13661
|
+
|
|
13639
13662
|
## struct GithubWorkflowOptions 🔹 <a id="projen-github-githubworkflowoptions"></a>
|
|
13640
13663
|
|
|
13641
13664
|
|
|
@@ -14415,7 +14438,8 @@ Name | Type | Description
|
|
|
14415
14438
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
14416
14439
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14417
14440
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14418
|
-
**
|
|
14441
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
14442
|
+
**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"
|
|
14419
14443
|
**projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
|
|
14420
14444
|
**projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
|
|
14421
14445
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
@@ -14464,7 +14488,8 @@ Name | Type | Description
|
|
|
14464
14488
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
14465
14489
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14466
14490
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
14467
|
-
**
|
|
14491
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
14492
|
+
**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"
|
|
14468
14493
|
**projenrcJava**?🔹 | <code>boolean</code> | Use projenrc in java.<br/>__*Default*__: true
|
|
14469
14494
|
**projenrcJavaOptions**?🔹 | <code>[java.ProjenrcOptions](#projen-java-projenrcoptions)</code> | Options related to projenrc in java.<br/>__*Default*__: default options
|
|
14470
14495
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
@@ -14910,7 +14935,6 @@ Name | Type | Description
|
|
|
14910
14935
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
14911
14936
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
14912
14937
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
14913
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14914
14938
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
14915
14939
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
14916
14940
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -14931,7 +14955,7 @@ Name | Type | Description
|
|
|
14931
14955
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
14932
14956
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
14933
14957
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
14934
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
14958
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
14935
14959
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
14936
14960
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
14937
14961
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -14974,11 +14998,9 @@ Name | Type | Description
|
|
|
14974
14998
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
14975
14999
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
14976
15000
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
15001
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
14977
15002
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
14978
|
-
**projenTokenSecret
|
|
14979
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
14980
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
14981
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
15003
|
+
**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"
|
|
14982
15004
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
14983
15005
|
**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
|
|
14984
15006
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -15211,7 +15233,6 @@ Options for `UpgradeDependencies`.
|
|
|
15211
15233
|
Name | Type | Description
|
|
15212
15234
|
-----|------|-------------
|
|
15213
15235
|
**exclude**?🔹 | <code>Array<string></code> | List of package names to exclude during the upgrade.<br/>__*Default*__: Nothing is excluded.
|
|
15214
|
-
**ignoreProjen**?🔹 | <code>boolean</code> | Whether or not to ignore projen upgrades.<br/>__*Default*__: true
|
|
15215
15236
|
**include**?🔹 | <code>Array<string></code> | List of package names to include during the upgrade.<br/>__*Default*__: Everything is included.
|
|
15216
15237
|
**pullRequestTitle**?🔹 | <code>string</code> | Title of the pull request to use (should be all lower-case).<br/>__*Default*__: "upgrade dependencies"
|
|
15217
15238
|
**signoff**?🔹 | <code>boolean</code> | Add Signed-off-by line by the committer at the end of the commit log message.<br/>__*Default*__: true
|
|
@@ -15235,9 +15256,9 @@ Name | Type | Description
|
|
|
15235
15256
|
**container**?🔹 | <code>[github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)</code> | Job container options.<br/>__*Default*__: defaults
|
|
15236
15257
|
**gitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | The git identity to use for commits.<br/>__*Default*__: "github-actions
|
|
15237
15258
|
**labels**?🔹 | <code>Array<string></code> | Labels to apply on the PR.<br/>__*Default*__: no labels.
|
|
15259
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method for authenticating with GitHub for creating the PR.<br/>__*Default*__: personal access token named PROJEN_GITHUB_TOKEN
|
|
15238
15260
|
**runsOn**?🔹 | <code>Array<string></code> | Github Runner selection labels.<br/>__*Default*__: ["ubuntu-latest"]
|
|
15239
15261
|
**schedule**?🔹 | <code>[javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule)</code> | Schedule to run on.<br/>__*Default*__: UpgradeDependenciesSchedule.DAILY
|
|
15240
|
-
**secret**?🔹 | <code>string</code> | Which secret to use when creating the PR.<br/>__*Default*__: default github token.
|
|
15241
15262
|
|
|
15242
15263
|
|
|
15243
15264
|
|
|
@@ -15507,7 +15528,8 @@ Name | Type | Description
|
|
|
15507
15528
|
**poetryOptions**?🔹 | <code>[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)</code> | Additional options to set for poetry if using poetry.<br/>__*Optional*__
|
|
15508
15529
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
15509
15530
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
15510
|
-
**
|
|
15531
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
15532
|
+
**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"
|
|
15511
15533
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
15512
15534
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
15513
15535
|
**projenrcPython**?🔹 | <code>boolean</code> | Use projenrc in python.<br/>__*Default*__: true
|
|
@@ -15973,7 +15995,6 @@ Name | Type | Description
|
|
|
15973
15995
|
**authorOrganization**?⚠️ | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
15974
15996
|
**authorUrl**?⚠️ | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
15975
15997
|
**autoApproveOptions**?⚠️ | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
15976
|
-
**autoApproveProjenUpgrades**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
15977
15998
|
**autoApproveUpgrades**?⚠️ | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
15978
15999
|
**autoDetectBin**?⚠️ | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
15979
16000
|
**autoMergeOptions**?⚠️ | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -15994,7 +16015,7 @@ Name | Type | Description
|
|
|
15994
16015
|
**dependabotOptions**?⚠️ | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
15995
16016
|
**deps**?⚠️ | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
15996
16017
|
**depsUpgrade**?⚠️ | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
15997
|
-
**depsUpgradeOptions**?⚠️ | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
16018
|
+
**depsUpgradeOptions**?⚠️ | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
15998
16019
|
**description**?⚠️ | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
15999
16020
|
**devContainer**?⚠️ | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
16000
16021
|
**devDeps**?⚠️ | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -16044,11 +16065,9 @@ Name | Type | Description
|
|
|
16044
16065
|
**prettierOptions**?⚠️ | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
16045
16066
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
16046
16067
|
**projenCommand**?⚠️ | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
16068
|
+
**projenCredentials**?⚠️ | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
16047
16069
|
**projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
16048
16070
|
**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"
|
|
16049
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16050
|
-
**projenUpgradeSchedule**?⚠️ | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
16051
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
16052
16071
|
**projenVersion**?⚠️ | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
16053
16072
|
**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
|
|
16054
16073
|
**projenrcJsOptions**?⚠️ | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -16114,7 +16133,6 @@ Name | Type | Description
|
|
|
16114
16133
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
16115
16134
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
16116
16135
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
16117
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16118
16136
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
16119
16137
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
16120
16138
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -16135,7 +16153,7 @@ Name | Type | Description
|
|
|
16135
16153
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
16136
16154
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
16137
16155
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
16138
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
16156
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
16139
16157
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
16140
16158
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
16141
16159
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -16185,11 +16203,9 @@ Name | Type | Description
|
|
|
16185
16203
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
16186
16204
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
16187
16205
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
16206
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
16188
16207
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
16189
|
-
**projenTokenSecret
|
|
16190
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16191
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
16192
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
16208
|
+
**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"
|
|
16193
16209
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
16194
16210
|
**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
|
|
16195
16211
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -16360,7 +16376,6 @@ Name | Type | Description
|
|
|
16360
16376
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
16361
16377
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
16362
16378
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
16363
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16364
16379
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
16365
16380
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
16366
16381
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -16381,7 +16396,7 @@ Name | Type | Description
|
|
|
16381
16396
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
16382
16397
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
16383
16398
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
16384
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
16399
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
16385
16400
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
16386
16401
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
16387
16402
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -16424,11 +16439,9 @@ Name | Type | Description
|
|
|
16424
16439
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
16425
16440
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
16426
16441
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
16442
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
16427
16443
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
16428
|
-
**projenTokenSecret
|
|
16429
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16430
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
16431
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
16444
|
+
**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"
|
|
16432
16445
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
16433
16446
|
**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
|
|
16434
16447
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -16489,7 +16502,6 @@ Name | Type | Description
|
|
|
16489
16502
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
16490
16503
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
16491
16504
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
16492
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16493
16505
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
16494
16506
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
16495
16507
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -16510,7 +16522,7 @@ Name | Type | Description
|
|
|
16510
16522
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
16511
16523
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
16512
16524
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
16513
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
16525
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
16514
16526
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
16515
16527
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
16516
16528
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -16560,11 +16572,9 @@ Name | Type | Description
|
|
|
16560
16572
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
16561
16573
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
16562
16574
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
16575
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
16563
16576
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
16564
|
-
**projenTokenSecret
|
|
16565
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16566
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
16567
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
16577
|
+
**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"
|
|
16568
16578
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
16569
16579
|
**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
|
|
16570
16580
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -16660,7 +16670,6 @@ Name | Type | Description
|
|
|
16660
16670
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
16661
16671
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
16662
16672
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
16663
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16664
16673
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
16665
16674
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
16666
16675
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -16681,7 +16690,7 @@ Name | Type | Description
|
|
|
16681
16690
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
16682
16691
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
16683
16692
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
16684
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
16693
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
16685
16694
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
16686
16695
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
16687
16696
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -16724,11 +16733,9 @@ Name | Type | Description
|
|
|
16724
16733
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
16725
16734
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
16726
16735
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
16736
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
16727
16737
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
16728
|
-
**projenTokenSecret
|
|
16729
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16730
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
16731
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
16738
|
+
**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"
|
|
16732
16739
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
16733
16740
|
**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
|
|
16734
16741
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
@@ -16818,7 +16825,6 @@ Name | Type | Description
|
|
|
16818
16825
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
16819
16826
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
16820
16827
|
**autoApproveOptions**?🔹 | <code>[github.AutoApproveOptions](#projen-github-autoapproveoptions)</code> | Enable and configure the 'auto approve' workflow.<br/>__*Default*__: auto approve is disabled
|
|
16821
|
-
**autoApproveProjenUpgrades**?🔹 | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16822
16828
|
**autoApproveUpgrades**?🔹 | <code>boolean</code> | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: true
|
|
16823
16829
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
16824
16830
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
@@ -16839,7 +16845,7 @@ Name | Type | Description
|
|
|
16839
16845
|
**dependabotOptions**?🔹 | <code>[github.DependabotOptions](#projen-github-dependabotoptions)</code> | Options for dependabot.<br/>__*Default*__: default options
|
|
16840
16846
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
16841
16847
|
**depsUpgrade**?🔹 | <code>boolean</code> | Use github workflows to handle dependency upgrades.<br/>__*Default*__: true
|
|
16842
|
-
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for
|
|
16848
|
+
**depsUpgradeOptions**?🔹 | <code>[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)</code> | Options for `UpgradeDependencies`.<br/>__*Default*__: default options
|
|
16843
16849
|
**description**?🔹 | <code>string</code> | The description is just a string that helps people understand the purpose of the package.<br/>__*Optional*__
|
|
16844
16850
|
**devContainer**?🔹 | <code>boolean</code> | Add a VSCode development environment (used for GitHub Codespaces).<br/>__*Default*__: false
|
|
16845
16851
|
**devDeps**?🔹 | <code>Array<string></code> | Build dependencies for this module.<br/>__*Default*__: []
|
|
@@ -16889,11 +16895,9 @@ Name | Type | Description
|
|
|
16889
16895
|
**prettierOptions**?🔹 | <code>[javascript.PrettierOptions](#projen-javascript-prettieroptions)</code> | Prettier options.<br/>__*Default*__: default options
|
|
16890
16896
|
**projectType**?⚠️ | <code>[ProjectType](#projen-projecttype)</code> | Which type of project this is (library/app).<br/>__*Default*__: ProjectType.UNKNOWN
|
|
16891
16897
|
**projenCommand**?🔹 | <code>string</code> | The shell command to use in order to run the projen CLI.<br/>__*Default*__: "npx projen"
|
|
16898
|
+
**projenCredentials**?🔹 | <code>[github.GithubCredentials](#projen-github-githubcredentials)</code> | Choose a method of providing GitHub API access for projen workflows.<br/>__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
|
|
16892
16899
|
**projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
|
|
16893
|
-
**projenTokenSecret
|
|
16894
|
-
**projenUpgradeAutoMerge**?⚠️ | <code>boolean</code> | Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).<br/>__*Default*__: false
|
|
16895
|
-
**projenUpgradeSchedule**?🔹 | <code>Array<string></code> | Customize the projenUpgrade schedule in cron expression.<br/>__*Default*__: [ "0 6 * * *" ]
|
|
16896
|
-
**projenUpgradeSecret**?⚠️ | <code>string</code> | Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).<br/>__*Default*__: no automatic projen upgrade pull requests
|
|
16900
|
+
**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"
|
|
16897
16901
|
**projenVersion**?🔹 | <code>string</code> | Version of projen to install.<br/>__*Default*__: Defaults to the latest version.
|
|
16898
16902
|
**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
|
|
16899
16903
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|