projen 0.39.1 → 0.40.0
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 +341 -316
- package/API.md +109 -67
- package/lib/awscdk/auto-discover.js +1 -1
- package/lib/awscdk/awscdk-app-ts.js +2 -10
- package/lib/awscdk/awscdk-construct.js +2 -2
- package/lib/awscdk/cdk-config.js +1 -1
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/java-app.js +1 -1
- package/lib/awscdk/lambda-function.js +2 -2
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/jsii-docgen.js +1 -1
- package/lib/cdk/jsii-project.js +2 -3
- package/lib/cdk8s/cdk8s-app-ts.js +1 -1
- package/lib/cdk8s/cdk8s-construct.js +1 -1
- package/lib/cdktf/cdktf-construct.js +1 -1
- package/lib/component.js +1 -1
- package/lib/dependencies.js +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-project.js +1 -1
- package/lib/github/github.js +1 -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 +0 -11
- package/lib/github/workflows.js +3 -25
- package/lib/gitpod.js +1 -1
- package/lib/ignore-file.js +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +2 -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.d.ts +0 -24
- package/lib/javascript/node-package.js +4 -8
- package/lib/javascript/node-project.d.ts +0 -8
- package/lib/javascript/node-project.js +2 -5
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/projenrc.js +1 -1
- package/lib/javascript/typescript-config.js +1 -1
- package/lib/javascript/upgrade-dependencies.js +2 -2
- package/lib/json.js +1 -1
- package/lib/license.js +1 -1
- package/lib/logger.js +1 -1
- package/lib/makefile.js +1 -1
- package/lib/object-file.js +1 -1
- package/lib/project-build.js +1 -1
- package/lib/project.js +1 -1
- package/lib/projects.js +1 -1
- package/lib/projenrc-json.js +1 -1
- package/lib/python/pip.js +1 -1
- package/lib/python/poetry.js +2 -2
- package/lib/python/projenrc.js +1 -1
- package/lib/python/pytest.js +1 -1
- package/lib/python/python-project.js +1 -1
- package/lib/python/python-sample.js +1 -1
- package/lib/python/requirements-file.js +1 -1
- package/lib/python/setuppy.js +1 -1
- package/lib/python/setuptools.js +1 -1
- package/lib/python/venv.js +1 -1
- package/lib/readme.js +1 -1
- package/lib/release/publisher.d.ts +23 -9
- package/lib/release/publisher.js +212 -172
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.d.ts +44 -0
- package/lib/release/release.js +44 -25
- 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.d.ts +10 -6
- package/lib/testing.js +16 -8
- 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/util/synth.d.ts +2 -21
- package/lib/util/synth.js +2 -128
- 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 +3 -7
package/API.md
CHANGED
|
@@ -31,6 +31,7 @@ Name|Description
|
|
|
31
31
|
[Task](#projen-task)|A task that can be performed on the project.
|
|
32
32
|
[TaskRuntime](#projen-taskruntime)|The runtime component of the tasks engine.
|
|
33
33
|
[Tasks](#projen-tasks)|Defines project tasks.
|
|
34
|
+
[Testing](#projen-testing)|A Testing static class with a .synth helper for getting a snapshots of construct outputs. Useful for snapshot testing with Jest.
|
|
34
35
|
[TextFile](#projen-textfile)|A text file.
|
|
35
36
|
[TomlFile](#projen-tomlfile)|Represents a TOML file.
|
|
36
37
|
[Version](#projen-version)|*No description*
|
|
@@ -2579,6 +2580,29 @@ __Returns__:
|
|
|
2579
2580
|
|
|
2580
2581
|
|
|
2581
2582
|
|
|
2583
|
+
## class Testing 🔹 <a id="projen-testing"></a>
|
|
2584
|
+
|
|
2585
|
+
A Testing static class with a .synth helper for getting a snapshots of construct outputs. Useful for snapshot testing with Jest.
|
|
2586
|
+
|
|
2587
|
+
|
|
2588
|
+
### Methods
|
|
2589
|
+
|
|
2590
|
+
|
|
2591
|
+
#### *static* synth(project)🔹 <a id="projen-testing-synth"></a>
|
|
2592
|
+
|
|
2593
|
+
Produces a simple JS object that represents the contents of the projects with field names being file paths.
|
|
2594
|
+
|
|
2595
|
+
```ts
|
|
2596
|
+
static synth(project: Project): Map<string, any>
|
|
2597
|
+
```
|
|
2598
|
+
|
|
2599
|
+
* **project** (<code>[Project](#projen-project)</code>) the project to produce a snapshot for.
|
|
2600
|
+
|
|
2601
|
+
__Returns__:
|
|
2602
|
+
* <code>Map<string, any></code>
|
|
2603
|
+
|
|
2604
|
+
|
|
2605
|
+
|
|
2582
2606
|
## class TextFile 🔹 <a id="projen-textfile"></a>
|
|
2583
2607
|
|
|
2584
2608
|
A text file.
|
|
@@ -2899,7 +2923,6 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2899
2923
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
2900
2924
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
2901
2925
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
2902
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
2903
2926
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
2904
2927
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
2905
2928
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -2915,8 +2938,10 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2915
2938
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
2916
2939
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
2917
2940
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
2941
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
2918
2942
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
2919
2943
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
2944
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
2920
2945
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
2921
2946
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
2922
2947
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -3212,7 +3237,6 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3212
3237
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
3213
3238
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
3214
3239
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
3215
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
3216
3240
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
3217
3241
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
3218
3242
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -3228,8 +3252,10 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3228
3252
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
3229
3253
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3230
3254
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3255
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
3231
3256
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
3232
3257
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
3258
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
3233
3259
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
3234
3260
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
3235
3261
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -3467,7 +3493,6 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3467
3493
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
3468
3494
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
3469
3495
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
3470
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
3471
3496
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
3472
3497
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
3473
3498
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -3483,8 +3508,10 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3483
3508
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
3484
3509
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3485
3510
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3511
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
3486
3512
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
3487
3513
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
3514
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
3488
3515
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
3489
3516
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
3490
3517
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -3734,7 +3761,6 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3734
3761
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
3735
3762
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
3736
3763
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
3737
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
3738
3764
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
3739
3765
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
3740
3766
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -3750,8 +3776,10 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3750
3776
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
3751
3777
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3752
3778
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3779
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
3753
3780
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
3754
3781
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
3782
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
3755
3783
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
3756
3784
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
3757
3785
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -3913,7 +3941,6 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
3913
3941
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
3914
3942
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
3915
3943
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
3916
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
3917
3944
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
3918
3945
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
3919
3946
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -3929,8 +3956,10 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
3929
3956
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
3930
3957
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3931
3958
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3959
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
3932
3960
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
3933
3961
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
3962
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
3934
3963
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
3935
3964
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
3936
3965
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -4078,7 +4107,6 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4078
4107
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
4079
4108
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
4080
4109
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
4081
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
4082
4110
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
4083
4111
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
4084
4112
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -4094,8 +4122,10 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4094
4122
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
4095
4123
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4096
4124
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4125
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
4097
4126
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
4098
4127
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
4128
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
4099
4129
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
4100
4130
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
4101
4131
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -4245,7 +4275,6 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4245
4275
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
4246
4276
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
4247
4277
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
4248
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
4249
4278
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
4250
4279
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
4251
4280
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -4261,8 +4290,10 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4261
4290
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
4262
4291
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4263
4292
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4293
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
4264
4294
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
4265
4295
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
4296
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
4266
4297
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
4267
4298
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
4268
4299
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -4421,7 +4452,6 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4421
4452
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
4422
4453
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
4423
4454
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
4424
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
4425
4455
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
4426
4456
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
4427
4457
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -4437,8 +4467,10 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4437
4467
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
4438
4468
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4439
4469
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4470
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
4440
4471
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
4441
4472
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
4473
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
4442
4474
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
4443
4475
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
4444
4476
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -4876,22 +4908,6 @@ addJobs(jobs: Map<string, Job>): void
|
|
|
4876
4908
|
|
|
4877
4909
|
|
|
4878
4910
|
|
|
4879
|
-
#### addJobsLater(provider)🔹 <a id="projen-github-githubworkflow-addjobslater"></a>
|
|
4880
|
-
|
|
4881
|
-
Add jobs from a dynamic source.
|
|
4882
|
-
|
|
4883
|
-
Useful if a component creates jobs that
|
|
4884
|
-
may not be all available until project synthesis time.
|
|
4885
|
-
|
|
4886
|
-
```ts
|
|
4887
|
-
addJobsLater(provider: IJobProvider): void
|
|
4888
|
-
```
|
|
4889
|
-
|
|
4890
|
-
* **provider** (<code>[github.IJobProvider](#projen-github-ijobprovider)</code>) Source of jobs.
|
|
4891
|
-
|
|
4892
|
-
|
|
4893
|
-
|
|
4894
|
-
|
|
4895
4911
|
#### on(events)🔹 <a id="projen-github-githubworkflow-on"></a>
|
|
4896
4912
|
|
|
4897
4913
|
Add events to triggers the workflow.
|
|
@@ -5837,7 +5853,6 @@ new javascript.NodePackage(project: Project, options?: NodePackageOptions)
|
|
|
5837
5853
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
5838
5854
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
5839
5855
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
5840
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
5841
5856
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
5842
5857
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
5843
5858
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -5864,7 +5879,6 @@ Name | Type | Description
|
|
|
5864
5879
|
**lockFile**🔹 | <code>string</code> | The name of the lock file.
|
|
5865
5880
|
**manifest**⚠️ | <code>any</code> | <span></span>
|
|
5866
5881
|
**npmAccess**🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | npm package access level.
|
|
5867
|
-
**npmDistTag**🔹 | <code>string</code> | npm distribution tag.
|
|
5868
5882
|
**npmRegistry**🔹 | <code>string</code> | The npm registry host (e.g. `registry.npmjs.org`).
|
|
5869
5883
|
**npmRegistryUrl**🔹 | <code>string</code> | npm registry (e.g. `https://registry.npmjs.org`). Use `npmRegistryHost` to get just the host name.
|
|
5870
5884
|
**packageManager**🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The package manager to use.
|
|
@@ -6146,7 +6160,6 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6146
6160
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
6147
6161
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
6148
6162
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
6149
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
6150
6163
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
6151
6164
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
6152
6165
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -6162,8 +6175,10 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6162
6175
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
6163
6176
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
6164
6177
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
6178
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
6165
6179
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
6166
6180
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
6181
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
6167
6182
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
6168
6183
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
6169
6184
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -6224,8 +6239,6 @@ Name | Type | Description
|
|
|
6224
6239
|
**entrypoint**⚠️ | <code>string</code> | <span></span>
|
|
6225
6240
|
**installWorkflowSteps**🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | <span></span>
|
|
6226
6241
|
**manifest**⚠️ | <code>any</code> | <span></span>
|
|
6227
|
-
**npmDistTag**⚠️ | <code>string</code> | <span></span>
|
|
6228
|
-
**npmRegistry**⚠️ | <code>string</code> | <span></span>
|
|
6229
6242
|
**package**🔹 | <code>[javascript.NodePackage](#projen-javascript-nodepackage)</code> | API for managing the node package.
|
|
6230
6243
|
**packageManager**⚠️ | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The package manager to use.
|
|
6231
6244
|
**runScriptCommand**🔹 | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).
|
|
@@ -7291,7 +7304,6 @@ Implements GitHub jobs for publishing modules to package managers.
|
|
|
7291
7304
|
|
|
7292
7305
|
Under the hood, it uses https://github.com/aws/jsii-release
|
|
7293
7306
|
|
|
7294
|
-
__Implements__: [github.IJobProvider](#projen-github-ijobprovider)
|
|
7295
7307
|
__Submodule__: release
|
|
7296
7308
|
|
|
7297
7309
|
__Extends__: [Component](#projen-component)
|
|
@@ -7313,6 +7325,7 @@ new release.Publisher(project: Project, options: PublisherOptions)
|
|
|
7313
7325
|
* **failureIssue** (<code>boolean</code>) Create an issue when a publish task fails. __*Default*__: false
|
|
7314
7326
|
* **failureIssueLabel** (<code>string</code>) The label to apply to the issue marking failed publish tasks. __*Default*__: "failed-release"
|
|
7315
7327
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement for `jsii-release`. __*Default*__: "latest"
|
|
7328
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
7316
7329
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
7317
7330
|
|
|
7318
7331
|
|
|
@@ -7454,18 +7467,6 @@ publishToPyPi(options?: PyPiPublishOptions): void
|
|
|
7454
7467
|
|
|
7455
7468
|
|
|
7456
7469
|
|
|
7457
|
-
#### renderJobs()🔹 <a id="projen-release-publisher-renderjobs"></a>
|
|
7458
|
-
|
|
7459
|
-
Renders a set of workflow jobs for all the publishers.
|
|
7460
|
-
|
|
7461
|
-
```ts
|
|
7462
|
-
renderJobs(): Map<string, Job>
|
|
7463
|
-
```
|
|
7464
|
-
|
|
7465
|
-
|
|
7466
|
-
__Returns__:
|
|
7467
|
-
* <code>Map<string, [github.workflows.Job](#projen-github-workflows-job)></code>
|
|
7468
|
-
|
|
7469
7470
|
|
|
7470
7471
|
|
|
7471
7472
|
## class Release 🔹 <a id="projen-release-release"></a>
|
|
@@ -7493,8 +7494,10 @@ new release.Release(project: GitHubProject, options: ReleaseOptions)
|
|
|
7493
7494
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
7494
7495
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
7495
7496
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
7497
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
7496
7498
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
7497
7499
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
7500
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
7498
7501
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
7499
7502
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
7500
7503
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -7540,6 +7543,7 @@ addBranch(branch: string, options: BranchOptions): void
|
|
|
7540
7543
|
* **branch** (<code>string</code>) The branch to monitor (e.g. `main`, `v2.x`).
|
|
7541
7544
|
* **options** (<code>[release.BranchOptions](#projen-release-branchoptions)</code>) Branch definition.
|
|
7542
7545
|
* **majorVersion** (<code>number</code>) The major versions released from this branch.
|
|
7546
|
+
* **npmDistTag** (<code>string</code>) The npm distribution tag to use for this branch. __*Default*__: "latest"
|
|
7543
7547
|
* **prerelease** (<code>string</code>) Bump the version as a pre-release tag. __*Default*__: normal releases
|
|
7544
7548
|
* **tagPrefix** (<code>string</code>) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: no prefix
|
|
7545
7549
|
* **workflowName** (<code>string</code>) The name of the release workflow. __*Default*__: "release-BRANCH"
|
|
@@ -7560,6 +7564,18 @@ addJobs(jobs: Map<string, Job>): void
|
|
|
7560
7564
|
|
|
7561
7565
|
|
|
7562
7566
|
|
|
7567
|
+
#### preSynthesize()🔹 <a id="projen-release-release-presynthesize"></a>
|
|
7568
|
+
|
|
7569
|
+
Called before synthesis.
|
|
7570
|
+
|
|
7571
|
+
```ts
|
|
7572
|
+
preSynthesize(): void
|
|
7573
|
+
```
|
|
7574
|
+
|
|
7575
|
+
|
|
7576
|
+
|
|
7577
|
+
|
|
7578
|
+
|
|
7563
7579
|
|
|
7564
7580
|
|
|
7565
7581
|
## class ReleaseTrigger 🔹 <a id="projen-release-releasetrigger"></a>
|
|
@@ -7731,7 +7747,6 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
7731
7747
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
7732
7748
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
7733
7749
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
7734
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
7735
7750
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
7736
7751
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
7737
7752
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -7747,8 +7762,10 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
7747
7762
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
7748
7763
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
7749
7764
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
7765
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
7750
7766
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
7751
7767
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
7768
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
7752
7769
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
7753
7770
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
7754
7771
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -7875,7 +7892,6 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
7875
7892
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
7876
7893
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
7877
7894
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
7878
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
7879
7895
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
7880
7896
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
7881
7897
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -7891,8 +7907,10 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
7891
7907
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
7892
7908
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
7893
7909
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
7910
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
7894
7911
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
7895
7912
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
7913
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
7896
7914
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
7897
7915
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
7898
7916
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -8019,7 +8037,6 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8019
8037
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
8020
8038
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
8021
8039
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
8022
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
8023
8040
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
8024
8041
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
8025
8042
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -8035,8 +8052,10 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8035
8052
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
8036
8053
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8037
8054
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8055
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8038
8056
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8039
8057
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8058
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8040
8059
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
8041
8060
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
8042
8061
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -8408,7 +8427,6 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8408
8427
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
8409
8428
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
8410
8429
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
8411
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
8412
8430
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
8413
8431
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
8414
8432
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -8424,8 +8442,10 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8424
8442
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
8425
8443
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8426
8444
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8445
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8427
8446
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8428
8447
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8448
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8429
8449
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
8430
8450
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
8431
8451
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -8549,7 +8569,6 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8549
8569
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
8550
8570
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
8551
8571
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
8552
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
8553
8572
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
8554
8573
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
8555
8574
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -8565,8 +8584,10 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8565
8584
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
8566
8585
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8567
8586
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8587
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8568
8588
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8569
8589
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8590
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8570
8591
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
8571
8592
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
8572
8593
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -8763,7 +8784,6 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
8763
8784
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
8764
8785
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
8765
8786
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
8766
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
8767
8787
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
8768
8788
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
8769
8789
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -8779,8 +8799,10 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
8779
8799
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
8780
8800
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8781
8801
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8802
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8782
8803
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8783
8804
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8805
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8784
8806
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
8785
8807
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
8786
8808
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -8945,7 +8967,6 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
8945
8967
|
* **maxNodeVersion** (<code>string</code>) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
|
|
8946
8968
|
* **minNodeVersion** (<code>string</code>) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
|
|
8947
8969
|
* **npmAccess** (<code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code>) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
8948
|
-
* **npmDistTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
8949
8970
|
* **npmRegistry** (<code>string</code>) The host name of the npm registry to publish to. __*Optional*__
|
|
8950
8971
|
* **npmRegistryUrl** (<code>string</code>) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
|
|
8951
8972
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
|
|
@@ -8961,8 +8982,10 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
8961
8982
|
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
8962
8983
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8963
8984
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8985
|
+
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8964
8986
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8965
8987
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8988
|
+
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8966
8989
|
* **releaseBranches** (<code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code>) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
8967
8990
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
8968
8991
|
* **releaseFailureIssue** (<code>boolean</code>) Create a github issue on every failed publishing task. __*Default*__: false
|
|
@@ -10069,7 +10092,7 @@ Name | Type | Description
|
|
|
10069
10092
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
10070
10093
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
10071
10094
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
10072
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
10095
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
10073
10096
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
10074
10097
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
10075
10098
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -10097,6 +10120,7 @@ Name | Type | Description
|
|
|
10097
10120
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
10098
10121
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
10099
10122
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
10123
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
10100
10124
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
10101
10125
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
10102
10126
|
**publishToNuget**?🔹 | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | Publish to NuGet.<br/>__*Default*__: no publishing
|
|
@@ -10277,7 +10301,7 @@ Name | Type | Description
|
|
|
10277
10301
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
10278
10302
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
10279
10303
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
10280
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
10304
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
10281
10305
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
10282
10306
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
10283
10307
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -10305,6 +10329,7 @@ Name | Type | Description
|
|
|
10305
10329
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
10306
10330
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
10307
10331
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
10332
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
10308
10333
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
10309
10334
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
10310
10335
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -10469,7 +10494,7 @@ Name | Type | Description
|
|
|
10469
10494
|
**minNodeVersion**?⚠️ | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
10470
10495
|
**mutableBuild**?⚠️ | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
10471
10496
|
**npmAccess**?⚠️ | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
10472
|
-
**npmDistTag**?⚠️ | <code>string</code> |
|
|
10497
|
+
**npmDistTag**?⚠️ | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
10473
10498
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
10474
10499
|
**npmRegistryUrl**?⚠️ | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
10475
10500
|
**npmTokenSecret**?⚠️ | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -10497,6 +10522,7 @@ Name | Type | Description
|
|
|
10497
10522
|
**projenrcJsonOptions**?⚠️ | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
10498
10523
|
**projenrcTs**?⚠️ | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
10499
10524
|
**projenrcTsOptions**?⚠️ | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
10525
|
+
**publishTasks**?⚠️ | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
10500
10526
|
**publishToGo**?⚠️ | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
10501
10527
|
**publishToMaven**?⚠️ | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
10502
10528
|
**publishToNuget**?⚠️ | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | Publish to NuGet.<br/>__*Default*__: no publishing
|
|
@@ -10693,7 +10719,7 @@ Name | Type | Description
|
|
|
10693
10719
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
10694
10720
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
10695
10721
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
10696
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
10722
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
10697
10723
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
10698
10724
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
10699
10725
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -10721,6 +10747,7 @@ Name | Type | Description
|
|
|
10721
10747
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
10722
10748
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
10723
10749
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
10750
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
10724
10751
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
10725
10752
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
10726
10753
|
**publishToNuget**?🔹 | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | Publish to NuGet.<br/>__*Default*__: no publishing
|
|
@@ -10897,7 +10924,7 @@ Name | Type | Description
|
|
|
10897
10924
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
10898
10925
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
10899
10926
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
10900
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
10927
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
10901
10928
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
10902
10929
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
10903
10930
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -10925,6 +10952,7 @@ Name | Type | Description
|
|
|
10925
10952
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
10926
10953
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
10927
10954
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
10955
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
10928
10956
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
10929
10957
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
10930
10958
|
**publishToNuget**?🔹 | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | Publish to NuGet.<br/>__*Default*__: no publishing
|
|
@@ -11062,7 +11090,7 @@ Name | Type | Description
|
|
|
11062
11090
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
11063
11091
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
11064
11092
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
11065
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
11093
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
11066
11094
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
11067
11095
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
11068
11096
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -11090,6 +11118,7 @@ Name | Type | Description
|
|
|
11090
11118
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
11091
11119
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
11092
11120
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
11121
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
11093
11122
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
11094
11123
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
11095
11124
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -11209,7 +11238,7 @@ Name | Type | Description
|
|
|
11209
11238
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
11210
11239
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
11211
11240
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
11212
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
11241
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
11213
11242
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
11214
11243
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
11215
11244
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -11237,6 +11266,7 @@ Name | Type | Description
|
|
|
11237
11266
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
11238
11267
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
11239
11268
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
11269
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
11240
11270
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
11241
11271
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
11242
11272
|
**publishToNuget**?🔹 | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | Publish to NuGet.<br/>__*Default*__: no publishing
|
|
@@ -11358,7 +11388,7 @@ Name | Type | Description
|
|
|
11358
11388
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
11359
11389
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
11360
11390
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
11361
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
11391
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
11362
11392
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
11363
11393
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
11364
11394
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -11386,6 +11416,7 @@ Name | Type | Description
|
|
|
11386
11416
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
11387
11417
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
11388
11418
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
11419
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
11389
11420
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
11390
11421
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
11391
11422
|
**publishToNuget**?🔹 | <code>[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)</code> | Publish to NuGet.<br/>__*Default*__: no publishing
|
|
@@ -11595,7 +11626,6 @@ Name | Type | Description
|
|
|
11595
11626
|
|
|
11596
11627
|
## interface IJobProvider 🔹 <a id="projen-github-ijobprovider"></a>
|
|
11597
11628
|
|
|
11598
|
-
__Implemented by__: [release.Publisher](#projen-release-publisher)
|
|
11599
11629
|
|
|
11600
11630
|
|
|
11601
11631
|
### Methods
|
|
@@ -12251,7 +12281,6 @@ Name | Type | Description
|
|
|
12251
12281
|
**maxNodeVersion**?🔹 | <code>string</code> | Minimum node.js version to require via `engines` (inclusive).<br/>__*Default*__: no max
|
|
12252
12282
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
12253
12283
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
12254
|
-
**npmDistTag**?🔹 | <code>string</code> | Tags can be used to provide an alias instead of version numbers.<br/>__*Default*__: "latest"
|
|
12255
12284
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
12256
12285
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
12257
12286
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -12327,7 +12356,7 @@ Name | Type | Description
|
|
|
12327
12356
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
12328
12357
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
12329
12358
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
12330
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
12359
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
12331
12360
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
12332
12361
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
12333
12362
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -12352,6 +12381,7 @@ Name | Type | Description
|
|
|
12352
12381
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
12353
12382
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
12354
12383
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
12384
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
12355
12385
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
12356
12386
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
12357
12387
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -12888,6 +12918,7 @@ Options for a release branch.
|
|
|
12888
12918
|
Name | Type | Description
|
|
12889
12919
|
-----|------|-------------
|
|
12890
12920
|
**majorVersion**🔹 | <code>number</code> | The major versions released from this branch.
|
|
12921
|
+
**npmDistTag**?🔹 | <code>string</code> | The npm distribution tag to use for this branch.<br/>__*Default*__: "latest"
|
|
12891
12922
|
**prerelease**?🔹 | <code>string</code> | Bump the version as a pre-release tag.<br/>__*Default*__: normal releases
|
|
12892
12923
|
**tagPrefix**?🔹 | <code>string</code> | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.<br/>__*Default*__: no prefix
|
|
12893
12924
|
**workflowName**?🔹 | <code>string</code> | The name of the release workflow.<br/>__*Default*__: "release-BRANCH"
|
|
@@ -13069,7 +13100,7 @@ Options for npm release.
|
|
|
13069
13100
|
Name | Type | Description
|
|
13070
13101
|
-----|------|-------------
|
|
13071
13102
|
**codeArtifactOptions**?🔹 | <code>[release.CodeArtifactOptions](#projen-release-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
13072
|
-
**distTag
|
|
13103
|
+
**distTag**?⚠️ | <code>string</code> | Tags can be used to provide an alias instead of version numbers.<br/>__*Default*__: "latest"
|
|
13073
13104
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN" or "GITHUB_TOKEN" if `registry` is set to `npm.pkg.github.com`.
|
|
13074
13105
|
**registry**?🔹 | <code>string</code> | The domain name of the npm package registry.<br/>__*Default*__: "registry.npmjs.org"
|
|
13075
13106
|
|
|
@@ -13103,6 +13134,7 @@ Name | Type | Description
|
|
|
13103
13134
|
**failureIssue**?🔹 | <code>boolean</code> | Create an issue when a publish task fails.<br/>__*Default*__: false
|
|
13104
13135
|
**failureIssueLabel**?🔹 | <code>string</code> | The label to apply to the issue marking failed publish tasks.<br/>__*Default*__: "failed-release"
|
|
13105
13136
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement for `jsii-release`.<br/>__*Default*__: "latest"
|
|
13137
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13106
13138
|
**workflowRunsOn**?🔹 | <code>Array<string></code> | Github Runner selection labels.<br/>__*Default*__: ["ubuntu-latest"]
|
|
13107
13139
|
|
|
13108
13140
|
|
|
@@ -13139,8 +13171,10 @@ Name | Type | Description
|
|
|
13139
13171
|
**githubRelease**?🔹 | <code>boolean</code> | Create a GitHub release for each release.<br/>__*Default*__: true
|
|
13140
13172
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `jsii-release` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
13141
13173
|
**majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
|
|
13174
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
13142
13175
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
13143
13176
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
13177
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13144
13178
|
**releaseBranches**?🔹 | <code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code> | Defines additional release branches.<br/>__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
13145
13179
|
**releaseEveryCommit**?⚠️ | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`.<br/>__*Default*__: true
|
|
13146
13180
|
**releaseFailureIssue**?🔹 | <code>boolean</code> | Create a github issue on every failed publishing task.<br/>__*Default*__: false
|
|
@@ -13169,8 +13203,10 @@ Name | Type | Description
|
|
|
13169
13203
|
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts to be published to npm.<br/>__*Default*__: "dist"
|
|
13170
13204
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `jsii-release` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
13171
13205
|
**majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
|
|
13206
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
13172
13207
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
13173
13208
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
13209
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13174
13210
|
**releaseBranches**?🔹 | <code>Map<string, [release.BranchOptions](#projen-release-branchoptions)></code> | Defines additional release branches.<br/>__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
|
|
13175
13211
|
**releaseEveryCommit**?⚠️ | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`.<br/>__*Default*__: true
|
|
13176
13212
|
**releaseFailureIssue**?🔹 | <code>boolean</code> | Create a github issue on every failed publishing task.<br/>__*Default*__: false
|
|
@@ -13281,7 +13317,7 @@ Name | Type | Description
|
|
|
13281
13317
|
**minNodeVersion**?⚠️ | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
13282
13318
|
**mutableBuild**?⚠️ | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
13283
13319
|
**npmAccess**?⚠️ | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
13284
|
-
**npmDistTag**?⚠️ | <code>string</code> |
|
|
13320
|
+
**npmDistTag**?⚠️ | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
13285
13321
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
13286
13322
|
**npmRegistryUrl**?⚠️ | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
13287
13323
|
**npmTokenSecret**?⚠️ | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -13309,6 +13345,7 @@ Name | Type | Description
|
|
|
13309
13345
|
**projenrcJsonOptions**?⚠️ | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13310
13346
|
**projenrcTs**?⚠️ | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
13311
13347
|
**projenrcTsOptions**?⚠️ | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
13348
|
+
**publishTasks**?⚠️ | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13312
13349
|
**pullRequestTemplate**?⚠️ | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
13313
13350
|
**pullRequestTemplateContents**?⚠️ | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
13314
13351
|
**readme**?⚠️ | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -13415,7 +13452,7 @@ Name | Type | Description
|
|
|
13415
13452
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
13416
13453
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
13417
13454
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
13418
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
13455
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
13419
13456
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
13420
13457
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
13421
13458
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -13443,6 +13480,7 @@ Name | Type | Description
|
|
|
13443
13480
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13444
13481
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
13445
13482
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
13483
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13446
13484
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
13447
13485
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
13448
13486
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -13647,7 +13685,7 @@ Name | Type | Description
|
|
|
13647
13685
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
13648
13686
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
13649
13687
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
13650
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
13688
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
13651
13689
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
13652
13690
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
13653
13691
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -13672,6 +13710,7 @@ Name | Type | Description
|
|
|
13672
13710
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
13673
13711
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
13674
13712
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13713
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13675
13714
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
13676
13715
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
13677
13716
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -13775,7 +13814,7 @@ Name | Type | Description
|
|
|
13775
13814
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
13776
13815
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
13777
13816
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
13778
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
13817
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
13779
13818
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
13780
13819
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
13781
13820
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -13803,6 +13842,7 @@ Name | Type | Description
|
|
|
13803
13842
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13804
13843
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
13805
13844
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
13845
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13806
13846
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
13807
13847
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
13808
13848
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -13932,7 +13972,7 @@ Name | Type | Description
|
|
|
13932
13972
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
13933
13973
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
13934
13974
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
13935
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
13975
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
13936
13976
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
13937
13977
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
13938
13978
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -13957,6 +13997,7 @@ Name | Type | Description
|
|
|
13957
13997
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
13958
13998
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
13959
13999
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
14000
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13960
14001
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
13961
14002
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
13962
14003
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|
|
@@ -14088,7 +14129,7 @@ Name | Type | Description
|
|
|
14088
14129
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum Node.js version to require via package.json `engines` (inclusive).<br/>__*Default*__: no "engines" specified
|
|
14089
14130
|
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
14090
14131
|
**npmAccess**?🔹 | <code>[javascript.NpmAccess](#projen-javascript-npmaccess)</code> | Access level of the npm package.<br/>__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
|
|
14091
|
-
**npmDistTag**?🔹 | <code>string</code> |
|
|
14132
|
+
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
14092
14133
|
**npmRegistry**?⚠️ | <code>string</code> | The host name of the npm registry to publish to.<br/>__*Optional*__
|
|
14093
14134
|
**npmRegistryUrl**?🔹 | <code>string</code> | The base URL of the npm package registry.<br/>__*Default*__: "https://registry.npmjs.org"
|
|
14094
14135
|
**npmTokenSecret**?🔹 | <code>string</code> | GitHub secret which contains the NPM token to use when publishing packages.<br/>__*Default*__: "NPM_TOKEN"
|
|
@@ -14116,6 +14157,7 @@ Name | Type | Description
|
|
|
14116
14157
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
14117
14158
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
14118
14159
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
14160
|
+
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
14119
14161
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
14120
14162
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
14121
14163
|
**readme**?🔹 | <code>[SampleReadmeProps](#projen-samplereadmeprops)</code> | The README setup.<br/>__*Default*__: { filename: 'README.md', contents: '# replace this' }
|