projen 0.45.4 → 0.46.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +1388 -570
- package/API.md +414 -61
- package/README.md +1 -0
- package/dist/changelog.md +7 -0
- package/dist/releasetag.txt +1 -0
- package/dist/version.txt +1 -0
- package/docs/build.md +55 -0
- package/docs/mutable-builds.md +0 -27
- package/docs/publisher.md +35 -1
- package/lib/awscdk/auto-discover.js +1 -1
- package/lib/awscdk/awscdk-app-ts.js +1 -1
- package/lib/awscdk/awscdk-construct.js +2 -2
- package/lib/awscdk/awscdk-deps.js +1 -1
- package/lib/awscdk/cdk-config.js +1 -1
- package/lib/awscdk/cdk-tasks.js +1 -1
- package/lib/awscdk/integration-test.js +1 -1
- package/lib/awscdk/java-app.js +1 -1
- package/lib/awscdk/lambda-function.js +2 -2
- package/lib/build/build-workflow.d.ts +125 -0
- package/lib/build/build-workflow.js +217 -0
- package/lib/build/index.d.ts +1 -0
- package/lib/build/index.js +14 -0
- package/lib/cdk/construct-lib.js +1 -1
- package/lib/cdk/consts.d.ts +14 -0
- package/lib/cdk/consts.js +37 -0
- package/lib/cdk/jsii-docgen.js +1 -1
- package/lib/cdk/jsii-project.d.ts +13 -0
- package/lib/cdk/jsii-project.js +107 -44
- 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/constants.js +2 -1
- package/lib/github/dependabot.js +1 -1
- package/lib/github/github-project.js +1 -1
- package/lib/github/github.d.ts +6 -0
- package/lib/github/github.js +11 -2
- 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.d.ts +4 -0
- package/lib/github/task-workflow.js +6 -5
- package/lib/github/workflows-model.d.ts +62 -0
- package/lib/github/workflows-model.js +1 -1
- package/lib/github/workflows.d.ts +8 -0
- package/lib/github/workflows.js +39 -3
- 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 +12 -0
- package/lib/javascript/node-package.js +6 -2
- package/lib/javascript/node-project.d.ts +46 -7
- package/lib/javascript/node-project.js +64 -129
- package/lib/javascript/npm-config.js +1 -1
- package/lib/javascript/projenrc.js +1 -1
- package/lib/javascript/typescript-config.js +1 -1
- package/lib/javascript/upgrade-dependencies.d.ts +15 -0
- package/lib/javascript/upgrade-dependencies.js +18 -6
- 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 +39 -7
- package/lib/release/publisher.js +51 -43
- package/lib/release/release-trigger.js +1 -1
- package/lib/release/release.d.ts +20 -8
- package/lib/release/release.js +3 -2
- package/lib/sample-file.js +2 -2
- package/lib/semver.js +1 -1
- package/lib/source-code.js +1 -1
- package/lib/task-runtime.js +1 -1
- package/lib/task.js +1 -1
- package/lib/tasks.js +1 -1
- package/lib/testing.js +1 -1
- package/lib/textfile.js +1 -1
- package/lib/toml.js +1 -1
- package/lib/typescript/projenrc.js +1 -1
- package/lib/typescript/typescript-typedoc.js +1 -1
- package/lib/typescript/typescript.d.ts +0 -7
- package/lib/typescript/typescript.js +23 -28
- 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 +6 -6
- package/lib/web/tailwind.js +1 -1
- package/lib/xmlfile.js +1 -1
- package/lib/yaml.js +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/README.md +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/assert.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/async_hooks.d.ts +7 -3
- package/node_modules/xmlbuilder2/node_modules/@types/node/buffer.d.ts +9 -9
- package/node_modules/xmlbuilder2/node_modules/@types/node/child_process.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/cluster.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/console.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/crypto.d.ts +2 -2
- package/node_modules/xmlbuilder2/node_modules/@types/node/dgram.d.ts +2 -2
- package/node_modules/xmlbuilder2/node_modules/@types/node/diagnostics_channel.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/dns/promises.d.ts +12 -10
- package/node_modules/xmlbuilder2/node_modules/@types/node/dns.d.ts +17 -12
- package/node_modules/xmlbuilder2/node_modules/@types/node/domain.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/events.d.ts +2 -2
- package/node_modules/xmlbuilder2/node_modules/@types/node/fs/promises.d.ts +5 -5
- package/node_modules/xmlbuilder2/node_modules/@types/node/fs.d.ts +62 -11
- package/node_modules/xmlbuilder2/node_modules/@types/node/http.d.ts +20 -3
- package/node_modules/xmlbuilder2/node_modules/@types/node/http2.d.ts +3 -3
- package/node_modules/xmlbuilder2/node_modules/@types/node/https.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/index.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/inspector.d.ts +4 -5
- package/node_modules/xmlbuilder2/node_modules/@types/node/net.d.ts +11 -11
- package/node_modules/xmlbuilder2/node_modules/@types/node/os.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/package.json +2 -2
- package/node_modules/xmlbuilder2/node_modules/@types/node/path.d.ts +9 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/perf_hooks.d.ts +6 -4
- package/node_modules/xmlbuilder2/node_modules/@types/node/punycode.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/querystring.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/readline.d.ts +121 -14
- package/node_modules/xmlbuilder2/node_modules/@types/node/repl.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/stream/web.d.ts +3 -65
- package/node_modules/xmlbuilder2/node_modules/@types/node/stream.d.ts +2 -2
- package/node_modules/xmlbuilder2/node_modules/@types/node/string_decoder.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/timers.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/tls.d.ts +3 -2
- package/node_modules/xmlbuilder2/node_modules/@types/node/trace_events.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/tty.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/url.d.ts +58 -18
- package/node_modules/xmlbuilder2/node_modules/@types/node/util.d.ts +3 -3
- package/node_modules/xmlbuilder2/node_modules/@types/node/v8.d.ts +3 -3
- package/node_modules/xmlbuilder2/node_modules/@types/node/vm.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/wasi.d.ts +1 -1
- package/node_modules/xmlbuilder2/node_modules/@types/node/worker_threads.d.ts +4 -4
- package/node_modules/xmlbuilder2/node_modules/@types/node/zlib.d.ts +1 -1
- package/package.json +11 -7
- package/docs/project.md +0 -30
package/API.md
CHANGED
|
@@ -48,6 +48,7 @@ Name|Description
|
|
|
48
48
|
[awscdk.IntegrationTest](#projen-awscdk-integrationtest)|Cloud integration tests.
|
|
49
49
|
[awscdk.LambdaFunction](#projen-awscdk-lambdafunction)|Generates a pre-bundled AWS Lambda function construct from handler code.
|
|
50
50
|
[awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)|The runtime for the AWS Lambda function.
|
|
51
|
+
[build.BuildWorkflow](#projen-build-buildworkflow)|*No description*
|
|
51
52
|
[cdk.ConstructLibrary](#projen-cdk-constructlibrary)|A multi-language library for CDK constructs.
|
|
52
53
|
[cdk.JsiiDocgen](#projen-cdk-jsiidocgen)|Creates an API.md file based on the jsii manifest: - Adds a `docgen` script to package.json - Runs `jsii-docgen` after compilation - Enforces that API.md is checked in.
|
|
53
54
|
[cdk.JsiiProject](#projen-cdk-jsiiproject)|Multi-language jsii library project.
|
|
@@ -175,6 +176,7 @@ Name|Description
|
|
|
175
176
|
[awscdk.IntegrationTestOptions](#projen-awscdk-integrationtestoptions)|Options for `IntegrationTest`.
|
|
176
177
|
[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)|Common options for `LambdaFunction`.
|
|
177
178
|
[awscdk.LambdaFunctionOptions](#projen-awscdk-lambdafunctionoptions)|Options for `Function`.
|
|
179
|
+
[build.BuildWorkflowOptions](#projen-build-buildworkflowoptions)|*No description*
|
|
178
180
|
[cdk.Catalog](#projen-cdk-catalog)|*No description*
|
|
179
181
|
[cdk.ConstructLibraryOptions](#projen-cdk-constructlibraryoptions)|*No description*
|
|
180
182
|
[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)|*No description*
|
|
@@ -247,6 +249,7 @@ Name|Description
|
|
|
247
249
|
[python.VenvOptions](#projen-python-venvoptions)|Options for venv.
|
|
248
250
|
[release.BranchOptions](#projen-release-branchoptions)|Options for a release branch.
|
|
249
251
|
[release.CodeArtifactOptions](#projen-release-codeartifactoptions)|*No description*
|
|
252
|
+
[release.CommonPublishOptions](#projen-release-commonpublishoptions)|Common publishing options.
|
|
250
253
|
[release.GitHubReleasesPublishOptions](#projen-release-githubreleasespublishoptions)|Publishing options for GitHub releases.
|
|
251
254
|
[release.GitPublishOptions](#projen-release-gitpublishoptions)|Publishing options for Git releases.
|
|
252
255
|
[release.GoPublishOptions](#projen-release-gopublishoptions)|*No description*
|
|
@@ -2914,6 +2917,8 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2914
2917
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
2915
2918
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
2916
2919
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
2920
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
2921
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
2917
2922
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
2918
2923
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
2919
2924
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -2939,12 +2944,12 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2939
2944
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
2940
2945
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
2941
2946
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
2942
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
2943
2947
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
2944
2948
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
2945
2949
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
2946
2950
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
2947
2951
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
2952
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
2948
2953
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
2949
2954
|
* **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.
|
|
2950
2955
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -2959,6 +2964,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2959
2964
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
2960
2965
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
2961
2966
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
2967
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
2962
2968
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
2963
2969
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
2964
2970
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -2977,6 +2983,7 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2977
2983
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
2978
2984
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
2979
2985
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
2986
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
2980
2987
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
2981
2988
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
2982
2989
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -2999,7 +3006,6 @@ new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
|
|
|
2999
3006
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
3000
3007
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
3001
3008
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
3002
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
3003
3009
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
3004
3010
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
3005
3011
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -3303,6 +3309,8 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3303
3309
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
3304
3310
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
3305
3311
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
3312
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
3313
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
3306
3314
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
3307
3315
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
3308
3316
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -3328,12 +3336,12 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3328
3336
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
3329
3337
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
3330
3338
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
3331
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
3332
3339
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3333
3340
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3334
3341
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
3335
3342
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
3336
3343
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
3344
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
3337
3345
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
3338
3346
|
* **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.
|
|
3339
3347
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -3348,6 +3356,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3348
3356
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
3349
3357
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
3350
3358
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
3359
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
3351
3360
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3352
3361
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3353
3362
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -3366,6 +3375,7 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3366
3375
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
3367
3376
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
3368
3377
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
3378
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
3369
3379
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3370
3380
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
3371
3381
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -3388,7 +3398,6 @@ new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
|
|
|
3388
3398
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
3389
3399
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
3390
3400
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
3391
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
3392
3401
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
3393
3402
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
3394
3403
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -3568,6 +3577,8 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3568
3577
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
3569
3578
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
3570
3579
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
3580
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
3581
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
3571
3582
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
3572
3583
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
3573
3584
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -3593,12 +3604,12 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3593
3604
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
3594
3605
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
3595
3606
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
3596
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
3597
3607
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3598
3608
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3599
3609
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
3600
3610
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
3601
3611
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
3612
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
3602
3613
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
3603
3614
|
* **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.
|
|
3604
3615
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -3613,6 +3624,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3613
3624
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
3614
3625
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
3615
3626
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
3627
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
3616
3628
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3617
3629
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3618
3630
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -3631,6 +3643,7 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3631
3643
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
3632
3644
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
3633
3645
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
3646
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
3634
3647
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3635
3648
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
3636
3649
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -3653,7 +3666,6 @@ new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
|
|
|
3653
3666
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
3654
3667
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
3655
3668
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
3656
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
3657
3669
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
3658
3670
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
3659
3671
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -3791,6 +3803,102 @@ Name | Type | Description
|
|
|
3791
3803
|
|
|
3792
3804
|
|
|
3793
3805
|
|
|
3806
|
+
## class BuildWorkflow 🔹 <a id="projen-build-buildworkflow"></a>
|
|
3807
|
+
|
|
3808
|
+
|
|
3809
|
+
|
|
3810
|
+
__Submodule__: build
|
|
3811
|
+
|
|
3812
|
+
__Extends__: [Component](#projen-component)
|
|
3813
|
+
|
|
3814
|
+
### Initializer
|
|
3815
|
+
|
|
3816
|
+
|
|
3817
|
+
|
|
3818
|
+
|
|
3819
|
+
```ts
|
|
3820
|
+
new build.BuildWorkflow(project: Project, options: BuildWorkflowOptions)
|
|
3821
|
+
```
|
|
3822
|
+
|
|
3823
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
3824
|
+
* **options** (<code>[build.BuildWorkflowOptions](#projen-build-buildworkflowoptions)</code>) *No description*
|
|
3825
|
+
* **artifactsDirectory** (<code>string</code>) A name of a directory that includes build artifacts.
|
|
3826
|
+
* **buildTask** (<code>[Task](#projen-task)</code>) The task to execute in order to build the project.
|
|
3827
|
+
* **antitamper** (<code>boolean</code>) Enable anti-tamper check. __*Default*__: true
|
|
3828
|
+
* **containerImage** (<code>string</code>) The container image to use for builds. __*Default*__: the default workflow container
|
|
3829
|
+
* **env** (<code>Map<string, string></code>) Build environment variables. __*Default*__: {}
|
|
3830
|
+
* **gitIdentity** (<code>[github.GitIdentity](#projen-github-gitidentity)</code>) Git identity to use for the workflow. __*Default*__: default identity
|
|
3831
|
+
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
3832
|
+
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build. __*Default*__: []
|
|
3833
|
+
* **preBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute before the build. __*Default*__: []
|
|
3834
|
+
|
|
3835
|
+
|
|
3836
|
+
|
|
3837
|
+
### Properties
|
|
3838
|
+
|
|
3839
|
+
|
|
3840
|
+
Name | Type | Description
|
|
3841
|
+
-----|------|-------------
|
|
3842
|
+
**buildJobIds**🔹 | <code>Array<string></code> | Returns a list of job IDs that are part of the build.
|
|
3843
|
+
|
|
3844
|
+
### Methods
|
|
3845
|
+
|
|
3846
|
+
|
|
3847
|
+
#### addPostBuildJob(id, job)🔹 <a id="projen-build-buildworkflow-addpostbuildjob"></a>
|
|
3848
|
+
|
|
3849
|
+
Adds another job to the build workflow which is executed after the build job succeeded.
|
|
3850
|
+
|
|
3851
|
+
```ts
|
|
3852
|
+
addPostBuildJob(id: string, job: Job): void
|
|
3853
|
+
```
|
|
3854
|
+
|
|
3855
|
+
* **id** (<code>string</code>) The id of the new job.
|
|
3856
|
+
* **job** (<code>[github.workflows.Job](#projen-github-workflows-job)</code>) The job specification.
|
|
3857
|
+
* **permissions** (<code>[github.workflows.JobPermissions](#projen-github-workflows-jobpermissions)</code>) You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.
|
|
3858
|
+
* **runsOn** (<code>Array<string></code>) The type of machine to run the job on.
|
|
3859
|
+
* **steps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) A job contains a sequence of tasks called steps.
|
|
3860
|
+
* **concurrency** (<code>any</code>) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. __*Optional*__
|
|
3861
|
+
* **container** (<code>[github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)</code>) A container to run any steps in a job that don't already specify a container. __*Optional*__
|
|
3862
|
+
* **continueOnError** (<code>boolean</code>) Prevents a workflow run from failing when a job fails. __*Optional*__
|
|
3863
|
+
* **defaults** (<code>[github.workflows.JobDefaults](#projen-github-workflows-jobdefaults)</code>) A map of default settings that will apply to all steps in the job. __*Optional*__
|
|
3864
|
+
* **env** (<code>Map<string, string></code>) A map of environment variables that are available to all steps in the job. __*Optional*__
|
|
3865
|
+
* **environment** (<code>any</code>) The environment that the job references. __*Optional*__
|
|
3866
|
+
* **if** (<code>string</code>) You can use the if conditional to prevent a job from running unless a condition is met. __*Optional*__
|
|
3867
|
+
* **name** (<code>string</code>) The name of the job displayed on GitHub. __*Optional*__
|
|
3868
|
+
* **needs** (<code>Array<string></code>) Identifies any jobs that must complete successfully before this job will run. __*Optional*__
|
|
3869
|
+
* **outputs** (<code>Map<string, [github.workflows.JobStepOutput](#projen-github-workflows-jobstepoutput)></code>) A map of outputs for a job. __*Optional*__
|
|
3870
|
+
* **services** (<code>Map<string, [github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)></code>) Used to host service containers for a job in a workflow. __*Optional*__
|
|
3871
|
+
* **strategy** (<code>[github.workflows.JobStrategy](#projen-github-workflows-jobstrategy)</code>) A strategy creates a build matrix for your jobs. __*Optional*__
|
|
3872
|
+
* **timeoutMinutes** (<code>number</code>) The maximum number of minutes to let a job run before GitHub automatically cancels it. __*Default*__: 360
|
|
3873
|
+
* **tools** (<code>[github.workflows.Tools](#projen-github-workflows-tools)</code>) Tools required for this job. __*Optional*__
|
|
3874
|
+
|
|
3875
|
+
|
|
3876
|
+
|
|
3877
|
+
|
|
3878
|
+
#### addPostBuildSteps(...steps)🔹 <a id="projen-build-buildworkflow-addpostbuildsteps"></a>
|
|
3879
|
+
|
|
3880
|
+
Adds steps that are executed after the build.
|
|
3881
|
+
|
|
3882
|
+
```ts
|
|
3883
|
+
addPostBuildSteps(...steps: JobStep[]): void
|
|
3884
|
+
```
|
|
3885
|
+
|
|
3886
|
+
* **steps** (<code>[github.workflows.JobStep](#projen-github-workflows-jobstep)</code>) The job steps.
|
|
3887
|
+
* **continueOnError** (<code>boolean</code>) Prevents a job from failing when a step fails. __*Optional*__
|
|
3888
|
+
* **env** (<code>Map<string, string></code>) Sets environment variables for steps to use in the runner environment. __*Optional*__
|
|
3889
|
+
* **id** (<code>string</code>) A unique identifier for the step. __*Optional*__
|
|
3890
|
+
* **if** (<code>string</code>) You can use the if conditional to prevent a job from running unless a condition is met. __*Optional*__
|
|
3891
|
+
* **name** (<code>string</code>) A name for your step to display on GitHub. __*Optional*__
|
|
3892
|
+
* **run** (<code>string</code>) Runs command-line programs using the operating system's shell. __*Optional*__
|
|
3893
|
+
* **timeoutMinutes** (<code>number</code>) The maximum number of minutes to run the step before killing the process. __*Optional*__
|
|
3894
|
+
* **uses** (<code>string</code>) Selects an action to run as part of a step in your job. __*Optional*__
|
|
3895
|
+
* **with** (<code>Map<string, any></code>) A map of the input parameters defined by the action. __*Optional*__
|
|
3896
|
+
|
|
3897
|
+
|
|
3898
|
+
|
|
3899
|
+
|
|
3900
|
+
|
|
3901
|
+
|
|
3794
3902
|
## class ConstructLibrary 🔹 <a id="projen-cdk-constructlibrary"></a>
|
|
3795
3903
|
|
|
3796
3904
|
A multi-language library for CDK constructs.
|
|
@@ -3838,6 +3946,8 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3838
3946
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
3839
3947
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
3840
3948
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
3949
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
3950
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
3841
3951
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
3842
3952
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
3843
3953
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -3863,12 +3973,12 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3863
3973
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
3864
3974
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
3865
3975
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
3866
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
3867
3976
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
3868
3977
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
3869
3978
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
3870
3979
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
3871
3980
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
3981
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
3872
3982
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
3873
3983
|
* **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.
|
|
3874
3984
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -3883,6 +3993,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3883
3993
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
3884
3994
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
3885
3995
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
3996
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
3886
3997
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
3887
3998
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
3888
3999
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -3901,6 +4012,7 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3901
4012
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
3902
4013
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
3903
4014
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4015
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
3904
4016
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
3905
4017
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
3906
4018
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -3923,7 +4035,6 @@ new cdk.ConstructLibrary(options: ConstructLibraryOptions)
|
|
|
3923
4035
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
3924
4036
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
3925
4037
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
3926
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
3927
4038
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
3928
4039
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
3929
4040
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -4018,6 +4129,8 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4018
4129
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
4019
4130
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
4020
4131
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
4132
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
4133
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
4021
4134
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
4022
4135
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
4023
4136
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -4043,12 +4156,12 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4043
4156
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4044
4157
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4045
4158
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4046
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
4047
4159
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4048
4160
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4049
4161
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
4050
4162
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
4051
4163
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
4164
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
4052
4165
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
4053
4166
|
* **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.
|
|
4054
4167
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -4063,6 +4176,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4063
4176
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
4064
4177
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4065
4178
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
4179
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
4066
4180
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4067
4181
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4068
4182
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -4081,6 +4195,7 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4081
4195
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
4082
4196
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
4083
4197
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4198
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4084
4199
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4085
4200
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
4086
4201
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4103,7 +4218,6 @@ new cdk.JsiiProject(options: JsiiProjectOptions)
|
|
|
4103
4218
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
4104
4219
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
4105
4220
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
4106
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
4107
4221
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
4108
4222
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
4109
4223
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -4184,6 +4298,8 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4184
4298
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
4185
4299
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
4186
4300
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
4301
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
4302
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
4187
4303
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
4188
4304
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
4189
4305
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -4209,12 +4325,12 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4209
4325
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4210
4326
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4211
4327
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4212
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
4213
4328
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4214
4329
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4215
4330
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
4216
4331
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
4217
4332
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
4333
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
4218
4334
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
4219
4335
|
* **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.
|
|
4220
4336
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -4229,6 +4345,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4229
4345
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
4230
4346
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4231
4347
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
4348
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
4232
4349
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4233
4350
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4234
4351
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -4247,6 +4364,7 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4247
4364
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
4248
4365
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
4249
4366
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4367
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4250
4368
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4251
4369
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
4252
4370
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4269,7 +4387,6 @@ new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
|
|
|
4269
4387
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
4270
4388
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
4271
4389
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
4272
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
4273
4390
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
4274
4391
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
4275
4392
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -4352,6 +4469,8 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4352
4469
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
4353
4470
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
4354
4471
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
4472
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
4473
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
4355
4474
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
4356
4475
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
4357
4476
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -4377,12 +4496,12 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4377
4496
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4378
4497
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4379
4498
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4380
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
4381
4499
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4382
4500
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4383
4501
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
4384
4502
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
4385
4503
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
4504
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
4386
4505
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
4387
4506
|
* **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.
|
|
4388
4507
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -4397,6 +4516,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4397
4516
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
4398
4517
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4399
4518
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
4519
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
4400
4520
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4401
4521
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4402
4522
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -4415,6 +4535,7 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4415
4535
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
4416
4536
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
4417
4537
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4538
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4418
4539
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4419
4540
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
4420
4541
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4437,7 +4558,6 @@ new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
|
|
|
4437
4558
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
4438
4559
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
4439
4560
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
4440
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
4441
4561
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
4442
4562
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
4443
4563
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -4529,6 +4649,8 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4529
4649
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
4530
4650
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
4531
4651
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
4652
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
4653
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
4532
4654
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
4533
4655
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
4534
4656
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -4554,12 +4676,12 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4554
4676
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
4555
4677
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
4556
4678
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
4557
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
4558
4679
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
4559
4680
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
4560
4681
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
4561
4682
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
4562
4683
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
4684
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
4563
4685
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
4564
4686
|
* **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.
|
|
4565
4687
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -4574,6 +4696,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4574
4696
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
4575
4697
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
4576
4698
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
4699
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
4577
4700
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
4578
4701
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
4579
4702
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -4592,6 +4715,7 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4592
4715
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
4593
4716
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
4594
4717
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
4718
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
4595
4719
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
4596
4720
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
4597
4721
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -4614,7 +4738,6 @@ new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
|
|
|
4614
4738
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
4615
4739
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
4616
4740
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
4617
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
4618
4741
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
4619
4742
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
4620
4743
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -4868,6 +4991,19 @@ tryFindWorkflow(name: string): GithubWorkflow
|
|
|
4868
4991
|
__Returns__:
|
|
4869
4992
|
* <code>[github.GithubWorkflow](#projen-github-githubworkflow)</code>
|
|
4870
4993
|
|
|
4994
|
+
#### *static* of(project)🔹 <a id="projen-github-github-of"></a>
|
|
4995
|
+
|
|
4996
|
+
Returns the `GitHub` component of a project or `undefined` if the project does not have a GitHub component.
|
|
4997
|
+
|
|
4998
|
+
```ts
|
|
4999
|
+
static of(project: Project): GitHub
|
|
5000
|
+
```
|
|
5001
|
+
|
|
5002
|
+
* **project** (<code>[Project](#projen-project)</code>) *No description*
|
|
5003
|
+
|
|
5004
|
+
__Returns__:
|
|
5005
|
+
* <code>[github.GitHub](#projen-github-github)</code>
|
|
5006
|
+
|
|
4871
5007
|
|
|
4872
5008
|
|
|
4873
5009
|
## class GitHubProject ⚠️ <a id="projen-github-githubproject"></a>
|
|
@@ -4985,6 +5121,37 @@ Name | Type | Description
|
|
|
4985
5121
|
### Methods
|
|
4986
5122
|
|
|
4987
5123
|
|
|
5124
|
+
#### addJob(id, job)🔹 <a id="projen-github-githubworkflow-addjob"></a>
|
|
5125
|
+
|
|
5126
|
+
Adds a single job to the workflow.
|
|
5127
|
+
|
|
5128
|
+
```ts
|
|
5129
|
+
addJob(id: string, job: Job): void
|
|
5130
|
+
```
|
|
5131
|
+
|
|
5132
|
+
* **id** (<code>string</code>) The job name (unique within the workflow).
|
|
5133
|
+
* **job** (<code>[github.workflows.Job](#projen-github-workflows-job)</code>) The job specification.
|
|
5134
|
+
* **permissions** (<code>[github.workflows.JobPermissions](#projen-github-workflows-jobpermissions)</code>) You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.
|
|
5135
|
+
* **runsOn** (<code>Array<string></code>) The type of machine to run the job on.
|
|
5136
|
+
* **steps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) A job contains a sequence of tasks called steps.
|
|
5137
|
+
* **concurrency** (<code>any</code>) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. __*Optional*__
|
|
5138
|
+
* **container** (<code>[github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)</code>) A container to run any steps in a job that don't already specify a container. __*Optional*__
|
|
5139
|
+
* **continueOnError** (<code>boolean</code>) Prevents a workflow run from failing when a job fails. __*Optional*__
|
|
5140
|
+
* **defaults** (<code>[github.workflows.JobDefaults](#projen-github-workflows-jobdefaults)</code>) A map of default settings that will apply to all steps in the job. __*Optional*__
|
|
5141
|
+
* **env** (<code>Map<string, string></code>) A map of environment variables that are available to all steps in the job. __*Optional*__
|
|
5142
|
+
* **environment** (<code>any</code>) The environment that the job references. __*Optional*__
|
|
5143
|
+
* **if** (<code>string</code>) You can use the if conditional to prevent a job from running unless a condition is met. __*Optional*__
|
|
5144
|
+
* **name** (<code>string</code>) The name of the job displayed on GitHub. __*Optional*__
|
|
5145
|
+
* **needs** (<code>Array<string></code>) Identifies any jobs that must complete successfully before this job will run. __*Optional*__
|
|
5146
|
+
* **outputs** (<code>Map<string, [github.workflows.JobStepOutput](#projen-github-workflows-jobstepoutput)></code>) A map of outputs for a job. __*Optional*__
|
|
5147
|
+
* **services** (<code>Map<string, [github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)></code>) Used to host service containers for a job in a workflow. __*Optional*__
|
|
5148
|
+
* **strategy** (<code>[github.workflows.JobStrategy](#projen-github-workflows-jobstrategy)</code>) A strategy creates a build matrix for your jobs. __*Optional*__
|
|
5149
|
+
* **timeoutMinutes** (<code>number</code>) The maximum number of minutes to let a job run before GitHub automatically cancels it. __*Default*__: 360
|
|
5150
|
+
* **tools** (<code>[github.workflows.Tools](#projen-github-workflows-tools)</code>) Tools required for this job. __*Optional*__
|
|
5151
|
+
|
|
5152
|
+
|
|
5153
|
+
|
|
5154
|
+
|
|
4988
5155
|
#### addJobs(jobs)🔹 <a id="projen-github-githubworkflow-addjobs"></a>
|
|
4989
5156
|
|
|
4990
5157
|
Add jobs to the workflow.
|
|
@@ -5218,6 +5385,7 @@ new github.TaskWorkflow(github: GitHub, options: TaskWorkflowOptions)
|
|
|
5218
5385
|
Name | Type | Description
|
|
5219
5386
|
-----|------|-------------
|
|
5220
5387
|
**jobId**🔹 | <code>string</code> | <span></span>
|
|
5388
|
+
**artifactsDirectory**?🔹 | <code>string</code> | __*Optional*__
|
|
5221
5389
|
|
|
5222
5390
|
|
|
5223
5391
|
|
|
@@ -5931,6 +6099,8 @@ new javascript.NodePackage(project: Project, options?: NodePackageOptions)
|
|
|
5931
6099
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
5932
6100
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
5933
6101
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
6102
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
6103
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
5934
6104
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
5935
6105
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
5936
6106
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -6238,6 +6408,8 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6238
6408
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
6239
6409
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
6240
6410
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
6411
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
6412
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
6241
6413
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
6242
6414
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
6243
6415
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -6263,12 +6435,12 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6263
6435
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
6264
6436
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
6265
6437
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
6266
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
6267
6438
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
6268
6439
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
6269
6440
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
6270
6441
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
6271
6442
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
6443
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
6272
6444
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
6273
6445
|
* **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.
|
|
6274
6446
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -6283,6 +6455,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6283
6455
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
6284
6456
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
6285
6457
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
6458
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
6286
6459
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
6287
6460
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
6288
6461
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -6301,6 +6474,7 @@ new javascript.NodeProject(options: NodeProjectOptions)
|
|
|
6301
6474
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
6302
6475
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
6303
6476
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
6477
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
6304
6478
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
6305
6479
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
6306
6480
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -6326,6 +6500,8 @@ Name | Type | Description
|
|
|
6326
6500
|
-----|------|-------------
|
|
6327
6501
|
**allowLibraryDependencies**⚠️ | <code>boolean</code> | <span></span>
|
|
6328
6502
|
**antitamper**🔹 | <code>boolean</code> | Indicates if workflows have anti-tamper checks.
|
|
6503
|
+
**artifactsDirectory**🔹 | <code>string</code> | The build output directory.
|
|
6504
|
+
**artifactsJavascriptDirectory**🔹 | <code>string</code> | The location of the npm tarball after build (`${artifactsDirectory}/js`).
|
|
6329
6505
|
**bundler**🔹 | <code>[javascript.Bundler](#projen-javascript-bundler)</code> | <span></span>
|
|
6330
6506
|
**entrypoint**⚠️ | <code>string</code> | <span></span>
|
|
6331
6507
|
**installWorkflowSteps**🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | <span></span>
|
|
@@ -6334,14 +6510,15 @@ Name | Type | Description
|
|
|
6334
6510
|
**packageManager**⚠️ | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The package manager to use.
|
|
6335
6511
|
**runScriptCommand**🔹 | <code>string</code> | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).
|
|
6336
6512
|
**autoMerge**?🔹 | <code>[github.AutoMerge](#projen-github-automerge)</code> | Automatic PR merges.<br/>__*Optional*__
|
|
6337
|
-
**buildWorkflow**?🔹 | <code>[
|
|
6338
|
-
**buildWorkflowJobId**?🔹 | <code>string</code> | __*Optional*__
|
|
6513
|
+
**buildWorkflow**?🔹 | <code>[build.BuildWorkflow](#projen-build-buildworkflow)</code> | The PR build GitHub workflow.<br/>__*Optional*__
|
|
6514
|
+
**buildWorkflowJobId**?🔹 | <code>string</code> | The job ID of the build workflow.<br/>__*Optional*__
|
|
6339
6515
|
**jest**?🔹 | <code>[javascript.Jest](#projen-javascript-jest)</code> | The Jest configuration (if enabled).<br/>__*Optional*__
|
|
6340
6516
|
**maxNodeVersion**?🔹 | <code>string</code> | Maximum node version required by this pacakge.<br/>__*Optional*__
|
|
6341
6517
|
**minNodeVersion**?🔹 | <code>string</code> | Minimum node.js version required by this package.<br/>__*Optional*__
|
|
6342
6518
|
**npmignore**?🔹 | <code>[IgnoreFile](#projen-ignorefile)</code> | The .npmignore file.<br/>__*Optional*__
|
|
6343
6519
|
**publisher**?⚠️ | <code>[release.Publisher](#projen-release-publisher)</code> | Package publisher.<br/>__*Optional*__
|
|
6344
6520
|
**release**?🔹 | <code>[release.Release](#projen-release-release)</code> | Release management.<br/>__*Optional*__
|
|
6521
|
+
**upgradeWorkflow**?🔹 | <code>[javascript.UpgradeDependencies](#projen-javascript-upgradedependencies)</code> | The upgrade workflow.<br/>__*Optional*__
|
|
6345
6522
|
|
|
6346
6523
|
### Methods
|
|
6347
6524
|
|
|
@@ -6727,10 +6904,33 @@ Name | Type | Description
|
|
|
6727
6904
|
-----|------|-------------
|
|
6728
6905
|
**ignoresProjen**🔹 | <code>boolean</code> | Whether or not projen is also upgraded in this workflow,.
|
|
6729
6906
|
**workflows**🔹 | <code>Array<[github.GithubWorkflow](#projen-github-githubworkflow)></code> | The workflows that execute the upgrades.
|
|
6907
|
+
**containerOptions**?🔹 | <code>[github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)</code> | Container definitions for the upgrade workflow.<br/>__*Optional*__
|
|
6730
6908
|
|
|
6731
6909
|
### Methods
|
|
6732
6910
|
|
|
6733
6911
|
|
|
6912
|
+
#### addPostBuildSteps(...steps)🔹 <a id="projen-javascript-upgradedependencies-addpostbuildsteps"></a>
|
|
6913
|
+
|
|
6914
|
+
Add steps to execute a successful build.
|
|
6915
|
+
|
|
6916
|
+
```ts
|
|
6917
|
+
addPostBuildSteps(...steps: JobStep[]): void
|
|
6918
|
+
```
|
|
6919
|
+
|
|
6920
|
+
* **steps** (<code>[github.workflows.JobStep](#projen-github-workflows-jobstep)</code>) worklfow steps.
|
|
6921
|
+
* **continueOnError** (<code>boolean</code>) Prevents a job from failing when a step fails. __*Optional*__
|
|
6922
|
+
* **env** (<code>Map<string, string></code>) Sets environment variables for steps to use in the runner environment. __*Optional*__
|
|
6923
|
+
* **id** (<code>string</code>) A unique identifier for the step. __*Optional*__
|
|
6924
|
+
* **if** (<code>string</code>) You can use the if conditional to prevent a job from running unless a condition is met. __*Optional*__
|
|
6925
|
+
* **name** (<code>string</code>) A name for your step to display on GitHub. __*Optional*__
|
|
6926
|
+
* **run** (<code>string</code>) Runs command-line programs using the operating system's shell. __*Optional*__
|
|
6927
|
+
* **timeoutMinutes** (<code>number</code>) The maximum number of minutes to run the step before killing the process. __*Optional*__
|
|
6928
|
+
* **uses** (<code>string</code>) Selects an action to run as part of a step in your job. __*Optional*__
|
|
6929
|
+
* **with** (<code>Map<string, any></code>) A map of the input parameters defined by the action. __*Optional*__
|
|
6930
|
+
|
|
6931
|
+
|
|
6932
|
+
|
|
6933
|
+
|
|
6734
6934
|
#### preSynthesize()🔹 <a id="projen-javascript-upgradedependencies-presynthesize"></a>
|
|
6735
6935
|
|
|
6736
6936
|
Called before synthesis.
|
|
@@ -7413,6 +7613,7 @@ new release.Publisher(project: Project, options: PublisherOptions)
|
|
|
7413
7613
|
* **artifactName** (<code>string</code>) The name of the artifact to download (e.g. `dist`).
|
|
7414
7614
|
* **buildJobId** (<code>string</code>) The job ID that produces the build artifacts.
|
|
7415
7615
|
* **condition** (<code>string</code>) A GitHub workflow expression used as a condition for publishers. __*Default*__: no condition
|
|
7616
|
+
* **dryRun** (<code>boolean</code>) Do not actually publish, only print the commands that would be executed instead. __*Optional*__
|
|
7416
7617
|
* **failureIssue** (<code>boolean</code>) Create an issue when a publish task fails. __*Default*__: false
|
|
7417
7618
|
* **failureIssueLabel** (<code>string</code>) The label to apply to the issue marking failed publish tasks. __*Default*__: "failed-release"
|
|
7418
7619
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement for `jsii-release`. __*Default*__: "latest"
|
|
@@ -7464,6 +7665,8 @@ publishToGitHubReleases(options: GitHubReleasesPublishOptions): void
|
|
|
7464
7665
|
```
|
|
7465
7666
|
|
|
7466
7667
|
* **options** (<code>[release.GitHubReleasesPublishOptions](#projen-release-githubreleasespublishoptions)</code>) Options.
|
|
7668
|
+
* **prePublishSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
|
|
7669
|
+
* **publishTools** (<code>[github.workflows.Tools](#projen-github-workflows-tools)</code>) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
|
|
7467
7670
|
* **changelogFile** (<code>string</code>) The location of an .md file (relative to `dist/`) that includes the changelog for the release.
|
|
7468
7671
|
* **releaseTagFile** (<code>string</code>) The location of a text file (relative to `dist/`) that contains the release tag.
|
|
7469
7672
|
* **versionFile** (<code>string</code>) The location of a text file (relative to `dist/`) that contains the version number.
|
|
@@ -7480,6 +7683,8 @@ publishToGo(options?: GoPublishOptions): void
|
|
|
7480
7683
|
```
|
|
7481
7684
|
|
|
7482
7685
|
* **options** (<code>[release.GoPublishOptions](#projen-release-gopublishoptions)</code>) Options.
|
|
7686
|
+
* **prePublishSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
|
|
7687
|
+
* **publishTools** (<code>[github.workflows.Tools](#projen-github-workflows-tools)</code>) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
|
|
7483
7688
|
* **gitBranch** (<code>string</code>) Branch to push to. __*Default*__: "main"
|
|
7484
7689
|
* **gitCommitMessage** (<code>string</code>) The commit message. __*Default*__: "chore(release): $VERSION"
|
|
7485
7690
|
* **githubRepo** (<code>string</code>) GitHub repository to push to. __*Default*__: derived from `moduleName`
|
|
@@ -7499,6 +7704,8 @@ publishToMaven(options?: MavenPublishOptions): void
|
|
|
7499
7704
|
```
|
|
7500
7705
|
|
|
7501
7706
|
* **options** (<code>[release.MavenPublishOptions](#projen-release-mavenpublishoptions)</code>) Options.
|
|
7707
|
+
* **prePublishSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
|
|
7708
|
+
* **publishTools** (<code>[github.workflows.Tools](#projen-github-workflows-tools)</code>) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
|
|
7502
7709
|
* **mavenEndpoint** (<code>string</code>) URL of Nexus repository. __*Default*__: "https://oss.sonatype.org"
|
|
7503
7710
|
* **mavenGpgPrivateKeyPassphrase** (<code>string</code>) GitHub secret name which contains the GPG private key or file that includes it. __*Default*__: "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages
|
|
7504
7711
|
* **mavenGpgPrivateKeySecret** (<code>string</code>) GitHub secret name which contains the GPG private key or file that includes it. __*Default*__: "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages
|
|
@@ -7520,6 +7727,8 @@ publishToNpm(options?: NpmPublishOptions): void
|
|
|
7520
7727
|
```
|
|
7521
7728
|
|
|
7522
7729
|
* **options** (<code>[release.NpmPublishOptions](#projen-release-npmpublishoptions)</code>) Options.
|
|
7730
|
+
* **prePublishSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
|
|
7731
|
+
* **publishTools** (<code>[github.workflows.Tools](#projen-github-workflows-tools)</code>) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
|
|
7523
7732
|
* **codeArtifactOptions** (<code>[release.CodeArtifactOptions](#projen-release-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
7524
7733
|
* **distTag** (<code>string</code>) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
|
|
7525
7734
|
* **npmTokenSecret** (<code>string</code>) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN" or "GITHUB_TOKEN" if `registry` is set to `npm.pkg.github.com`.
|
|
@@ -7537,6 +7746,8 @@ publishToNuget(options?: NugetPublishOptions): void
|
|
|
7537
7746
|
```
|
|
7538
7747
|
|
|
7539
7748
|
* **options** (<code>[release.NugetPublishOptions](#projen-release-nugetpublishoptions)</code>) Options.
|
|
7749
|
+
* **prePublishSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
|
|
7750
|
+
* **publishTools** (<code>[github.workflows.Tools](#projen-github-workflows-tools)</code>) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
|
|
7540
7751
|
* **nugetApiKeySecret** (<code>string</code>) GitHub secret which contains the API key for NuGet. __*Default*__: "NUGET_API_KEY"
|
|
7541
7752
|
|
|
7542
7753
|
|
|
@@ -7551,6 +7762,8 @@ publishToPyPi(options?: PyPiPublishOptions): void
|
|
|
7551
7762
|
```
|
|
7552
7763
|
|
|
7553
7764
|
* **options** (<code>[release.PyPiPublishOptions](#projen-release-pypipublishoptions)</code>) Options.
|
|
7765
|
+
* **prePublishSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
|
|
7766
|
+
* **publishTools** (<code>[github.workflows.Tools](#projen-github-workflows-tools)</code>) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
|
|
7554
7767
|
* **twinePasswordSecret** (<code>string</code>) The GitHub secret which contains PyPI password. __*Default*__: "TWINE_PASSWORD"
|
|
7555
7768
|
* **twineRegistryUrl** (<code>string</code>) The registry url to use when releasing packages. __*Default*__: twine default
|
|
7556
7769
|
* **twineUsernameSecret** (<code>string</code>) The GitHub secret which contains PyPI user name. __*Default*__: "TWINE_USERNAME"
|
|
@@ -7582,12 +7795,12 @@ new release.Release(project: GitHubProject, options: ReleaseOptions)
|
|
|
7582
7795
|
* **project** (<code>[github.GitHubProject](#projen-github-githubproject)</code>) *No description*
|
|
7583
7796
|
* **options** (<code>[release.ReleaseOptions](#projen-release-releaseoptions)</code>) *No description*
|
|
7584
7797
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
7585
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
7586
7798
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
7587
7799
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
7588
7800
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
7589
7801
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
7590
7802
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
7803
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
7591
7804
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
7592
7805
|
* **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.
|
|
7593
7806
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -7601,6 +7814,7 @@ new release.Release(project: GitHubProject, options: ReleaseOptions)
|
|
|
7601
7814
|
* **versionrcOptions** (<code>Map<string, any></code>) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
|
|
7602
7815
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
7603
7816
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
7817
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts.
|
|
7604
7818
|
* **branch** (<code>string</code>) The default branch name to release from.
|
|
7605
7819
|
* **task** (<code>[Task](#projen-task)</code>) The task to execute in order to create the release artifacts.
|
|
7606
7820
|
* **versionFile** (<code>string</code>) A name of a .json file to set the `version` field in after a bump.
|
|
@@ -7613,6 +7827,7 @@ new release.Release(project: GitHubProject, options: ReleaseOptions)
|
|
|
7613
7827
|
|
|
7614
7828
|
Name | Type | Description
|
|
7615
7829
|
-----|------|-------------
|
|
7830
|
+
**artifactsDirectory**🔹 | <code>string</code> | Location of build artifacts.
|
|
7616
7831
|
**branches**🔹 | <code>Array<string></code> | Retrieve all release branch names.
|
|
7617
7832
|
**publisher**🔹 | <code>[release.Publisher](#projen-release-publisher)</code> | Package publisher.
|
|
7618
7833
|
|
|
@@ -7825,6 +8040,8 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
7825
8040
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
7826
8041
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
7827
8042
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
8043
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
8044
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
7828
8045
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
7829
8046
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
7830
8047
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -7850,12 +8067,12 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
7850
8067
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
7851
8068
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
7852
8069
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
7853
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
7854
8070
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
7855
8071
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
7856
8072
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
7857
8073
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
7858
8074
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8075
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
7859
8076
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
7860
8077
|
* **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.
|
|
7861
8078
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -7870,6 +8087,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
7870
8087
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
7871
8088
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
7872
8089
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
8090
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
7873
8091
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
7874
8092
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
7875
8093
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -7888,6 +8106,7 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
7888
8106
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
7889
8107
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
7890
8108
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8109
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
7891
8110
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
7892
8111
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
7893
8112
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -7910,7 +8129,6 @@ new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
|
|
|
7910
8129
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
7911
8130
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
7912
8131
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
7913
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
7914
8132
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
7915
8133
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
7916
8134
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -7970,6 +8188,8 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
7970
8188
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
7971
8189
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
7972
8190
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
8191
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
8192
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
7973
8193
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
7974
8194
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
7975
8195
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -7995,12 +8215,12 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
7995
8215
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
7996
8216
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
7997
8217
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
7998
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
7999
8218
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8000
8219
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8001
8220
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8002
8221
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8003
8222
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8223
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
8004
8224
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8005
8225
|
* **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.
|
|
8006
8226
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -8015,6 +8235,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8015
8235
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
8016
8236
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
8017
8237
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
8238
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
8018
8239
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8019
8240
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8020
8241
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -8033,6 +8254,7 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8033
8254
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
8034
8255
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8035
8256
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8257
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8036
8258
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8037
8259
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
8038
8260
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8055,7 +8277,6 @@ new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
|
|
|
8055
8277
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
8056
8278
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
8057
8279
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
8058
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
8059
8280
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
8060
8281
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
8061
8282
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -8115,6 +8336,8 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8115
8336
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
8116
8337
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
8117
8338
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
8339
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
8340
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
8118
8341
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
8119
8342
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
8120
8343
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -8140,12 +8363,12 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8140
8363
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8141
8364
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8142
8365
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8143
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
8144
8366
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8145
8367
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8146
8368
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8147
8369
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8148
8370
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8371
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
8149
8372
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8150
8373
|
* **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.
|
|
8151
8374
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -8160,6 +8383,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8160
8383
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
8161
8384
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
8162
8385
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
8386
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
8163
8387
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8164
8388
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8165
8389
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -8178,6 +8402,7 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8178
8402
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
8179
8403
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8180
8404
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8405
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8181
8406
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8182
8407
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
8183
8408
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8200,7 +8425,6 @@ new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
|
|
|
8200
8425
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
8201
8426
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
8202
8427
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
8203
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
8204
8428
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
8205
8429
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
8206
8430
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -8505,6 +8729,8 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8505
8729
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
8506
8730
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
8507
8731
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
8732
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
8733
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
8508
8734
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
8509
8735
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
8510
8736
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -8530,12 +8756,12 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8530
8756
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8531
8757
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8532
8758
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8533
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
8534
8759
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8535
8760
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8536
8761
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8537
8762
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8538
8763
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8764
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
8539
8765
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8540
8766
|
* **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.
|
|
8541
8767
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -8550,6 +8776,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8550
8776
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
8551
8777
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
8552
8778
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
8779
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
8553
8780
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8554
8781
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8555
8782
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -8568,6 +8795,7 @@ new web.NextJsProject(options: NextJsProjectOptions)
|
|
|
8568
8795
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
8569
8796
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8570
8797
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8798
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8571
8799
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8572
8800
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
8573
8801
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8647,6 +8875,8 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8647
8875
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
8648
8876
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
8649
8877
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
8878
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
8879
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
8650
8880
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
8651
8881
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
8652
8882
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -8672,12 +8902,12 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8672
8902
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8673
8903
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8674
8904
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8675
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
8676
8905
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8677
8906
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8678
8907
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8679
8908
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8680
8909
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
8910
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
8681
8911
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8682
8912
|
* **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.
|
|
8683
8913
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -8692,6 +8922,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8692
8922
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
8693
8923
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
8694
8924
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
8925
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
8695
8926
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8696
8927
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8697
8928
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -8710,6 +8941,7 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8710
8941
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
8711
8942
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8712
8943
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
8944
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8713
8945
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8714
8946
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
8715
8947
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -8732,7 +8964,6 @@ new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
|
|
|
8732
8964
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
8733
8965
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
8734
8966
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
8735
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
8736
8967
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
8737
8968
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
8738
8969
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -8862,6 +9093,8 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
8862
9093
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
8863
9094
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
8864
9095
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
9096
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
9097
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
8865
9098
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
8866
9099
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
8867
9100
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -8887,12 +9120,12 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
8887
9120
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
8888
9121
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
8889
9122
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
8890
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
8891
9123
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
8892
9124
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
8893
9125
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
8894
9126
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
8895
9127
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
9128
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
8896
9129
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
8897
9130
|
* **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.
|
|
8898
9131
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -8907,6 +9140,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
8907
9140
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
8908
9141
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
8909
9142
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
9143
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
8910
9144
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
8911
9145
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
8912
9146
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -8925,6 +9159,7 @@ new web.ReactProject(options: ReactProjectOptions)
|
|
|
8925
9159
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
8926
9160
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
8927
9161
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
9162
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
8928
9163
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
8929
9164
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
8930
9165
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -9045,6 +9280,8 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9045
9280
|
* **authorUrl** (<code>string</code>) Author's URL / Website. __*Optional*__
|
|
9046
9281
|
* **autoDetectBin** (<code>boolean</code>) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
|
|
9047
9282
|
* **bin** (<code>Map<string, string></code>) Binary programs vended with your module. __*Optional*__
|
|
9283
|
+
* **bugsEmail** (<code>string</code>) The email address to which issues should be reported. __*Optional*__
|
|
9284
|
+
* **bugsUrl** (<code>string</code>) The url to your project's issue tracker. __*Optional*__
|
|
9048
9285
|
* **bundledDeps** (<code>Array<string></code>) List of dependencies to bundle into this module. __*Optional*__
|
|
9049
9286
|
* **codeArtifactOptions** (<code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code>) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
|
|
9050
9287
|
* **deps** (<code>Array<string></code>) Runtime dependencies of this module. __*Default*__: []
|
|
@@ -9070,12 +9307,12 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9070
9307
|
* **scripts** (<code>Map<string, string></code>) npm scripts to include. __*Default*__: {}
|
|
9071
9308
|
* **stability** (<code>string</code>) Package's Stability. __*Optional*__
|
|
9072
9309
|
* **antitamper** (<code>boolean</code>) Checks that after build there are no modified files on git. __*Default*__: true
|
|
9073
|
-
* **artifactsDirectory** (<code>string</code>) A directory which will contain artifacts to be published to npm. __*Default*__: "dist"
|
|
9074
9310
|
* **jsiiReleaseVersion** (<code>string</code>) Version requirement of `jsii-release` which is used to publish modules to npm. __*Default*__: "latest"
|
|
9075
9311
|
* **majorVersion** (<code>number</code>) Major version to release from the default branch. __*Default*__: Major version is not enforced.
|
|
9076
9312
|
* **npmDistTag** (<code>string</code>) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
|
|
9077
9313
|
* **postBuildSteps** (<code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code>) Steps to execute after build as part of the release workflow. __*Default*__: []
|
|
9078
9314
|
* **prerelease** (<code>string</code>) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
|
|
9315
|
+
* **publishDryRun** (<code>boolean</code>) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
|
|
9079
9316
|
* **publishTasks** (<code>boolean</code>) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
|
|
9080
9317
|
* **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.
|
|
9081
9318
|
* **releaseEveryCommit** (<code>boolean</code>) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
|
|
@@ -9090,6 +9327,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9090
9327
|
* **workflowContainerImage** (<code>string</code>) Container image to use for GitHub workflows. __*Default*__: default image
|
|
9091
9328
|
* **workflowRunsOn** (<code>Array<string></code>) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
|
|
9092
9329
|
* **defaultReleaseBranch** (<code>string</code>) The name of the main release branch.
|
|
9330
|
+
* **artifactsDirectory** (<code>string</code>) A directory which will contain build artifacts. __*Default*__: "dist"
|
|
9093
9331
|
* **autoApproveProjenUpgrades** (<code>boolean</code>) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: false
|
|
9094
9332
|
* **autoApproveUpgrades** (<code>boolean</code>) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
|
|
9095
9333
|
* **buildWorkflow** (<code>boolean</code>) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
|
|
@@ -9108,6 +9346,7 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9108
9346
|
* **mutableBuild** (<code>boolean</code>) Automatically update files modified during builds to pull-request branches. __*Default*__: true
|
|
9109
9347
|
* **npmignore** (<code>Array<string></code>) Additional entries to .npmignore. __*Optional*__
|
|
9110
9348
|
* **npmignoreEnabled** (<code>boolean</code>) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
|
|
9349
|
+
* **package** (<code>boolean</code>) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
|
|
9111
9350
|
* **projenDevDependency** (<code>boolean</code>) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
|
|
9112
9351
|
* **projenrcJs** (<code>boolean</code>) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
|
|
9113
9352
|
* **projenrcJsOptions** (<code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code>) Options for .projenrc.js. __*Default*__: default options
|
|
@@ -9130,7 +9369,6 @@ new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
|
|
|
9130
9369
|
* **eslint** (<code>boolean</code>) Setup eslint. __*Default*__: true
|
|
9131
9370
|
* **eslintOptions** (<code>[javascript.EslintOptions](#projen-javascript-eslintoptions)</code>) Eslint options. __*Default*__: opinionated default options
|
|
9132
9371
|
* **libdir** (<code>string</code>) Typescript artifacts output directory. __*Default*__: "lib"
|
|
9133
|
-
* **package** (<code>boolean</code>) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. __*Default*__: true
|
|
9134
9372
|
* **projenrcTs** (<code>boolean</code>) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
|
|
9135
9373
|
* **projenrcTsOptions** (<code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code>) Options for .projenrc.ts. __*Optional*__
|
|
9136
9374
|
* **sampleCode** (<code>boolean</code>) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
|
|
@@ -10115,7 +10353,7 @@ Name | Type | Description
|
|
|
10115
10353
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
10116
10354
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10117
10355
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10118
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
10356
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10119
10357
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
10120
10358
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
10121
10359
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -10126,6 +10364,8 @@ Name | Type | Description
|
|
|
10126
10364
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
10127
10365
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
10128
10366
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
10367
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
10368
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
10129
10369
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
10130
10370
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
10131
10371
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -10191,7 +10431,7 @@ Name | Type | Description
|
|
|
10191
10431
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
10192
10432
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
10193
10433
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
10194
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
10434
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
10195
10435
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
10196
10436
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
10197
10437
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -10212,6 +10452,7 @@ Name | Type | Description
|
|
|
10212
10452
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
10213
10453
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
10214
10454
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
10455
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
10215
10456
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
10216
10457
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
10217
10458
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
@@ -10373,7 +10614,7 @@ Name | Type | Description
|
|
|
10373
10614
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10374
10615
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10375
10616
|
**appEntrypoint**?🔹 | <code>string</code> | The CDK app's entrypoint (relative to the source directory, which is "src" by default).<br/>__*Default*__: "main.ts"
|
|
10376
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
10617
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10377
10618
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
10378
10619
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
10379
10620
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -10384,6 +10625,8 @@ Name | Type | Description
|
|
|
10384
10625
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
10385
10626
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
10386
10627
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
10628
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
10629
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
10387
10630
|
**buildCommand**?🔹 | <code>string</code> | A command to execute before synthesis.<br/>__*Default*__: no build command
|
|
10388
10631
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
10389
10632
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
@@ -10448,7 +10691,7 @@ Name | Type | Description
|
|
|
10448
10691
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
10449
10692
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
10450
10693
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
10451
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
10694
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
10452
10695
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
10453
10696
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
10454
10697
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -10469,6 +10712,7 @@ Name | Type | Description
|
|
|
10469
10712
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
10470
10713
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
10471
10714
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
10715
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
10472
10716
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
10473
10717
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
10474
10718
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
@@ -10567,7 +10811,7 @@ Name | Type | Description
|
|
|
10567
10811
|
**repositoryUrl**⚠️ | <code>string</code> | Git repository URL.
|
|
10568
10812
|
**allowLibraryDependencies**?⚠️ | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10569
10813
|
**antitamper**?⚠️ | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10570
|
-
**artifactsDirectory**?⚠️ | <code>string</code> | A directory which will contain artifacts
|
|
10814
|
+
**artifactsDirectory**?⚠️ | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10571
10815
|
**authorEmail**?⚠️ | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
10572
10816
|
**authorName**?⚠️ | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
10573
10817
|
**authorOrganization**?⚠️ | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -10578,6 +10822,8 @@ Name | Type | Description
|
|
|
10578
10822
|
**autoDetectBin**?⚠️ | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
10579
10823
|
**autoMergeOptions**?⚠️ | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
10580
10824
|
**bin**?⚠️ | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
10825
|
+
**bugsEmail**?⚠️ | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
10826
|
+
**bugsUrl**?⚠️ | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
10581
10827
|
**buildWorkflow**?⚠️ | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
10582
10828
|
**bundledDeps**?⚠️ | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
10583
10829
|
**bundlerOptions**?⚠️ | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -10643,7 +10889,7 @@ Name | Type | Description
|
|
|
10643
10889
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
10644
10890
|
**npmignoreEnabled**?⚠️ | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
10645
10891
|
**outdir**?⚠️ | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
10646
|
-
**package**?⚠️ | <code>boolean</code> | Defines a `
|
|
10892
|
+
**package**?⚠️ | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
10647
10893
|
**packageManager**?⚠️ | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
10648
10894
|
**packageName**?⚠️ | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
10649
10895
|
**parent**?⚠️ | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -10664,6 +10910,7 @@ Name | Type | Description
|
|
|
10664
10910
|
**projenrcJsonOptions**?⚠️ | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
10665
10911
|
**projenrcTs**?⚠️ | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
10666
10912
|
**projenrcTsOptions**?⚠️ | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
10913
|
+
**publishDryRun**?⚠️ | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
10667
10914
|
**publishTasks**?⚠️ | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
10668
10915
|
**publishToGo**?⚠️ | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
10669
10916
|
**publishToMaven**?⚠️ | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
@@ -10773,6 +11020,27 @@ Name | Type | Description
|
|
|
10773
11020
|
|
|
10774
11021
|
|
|
10775
11022
|
|
|
11023
|
+
## struct BuildWorkflowOptions 🔹 <a id="projen-build-buildworkflowoptions"></a>
|
|
11024
|
+
|
|
11025
|
+
|
|
11026
|
+
|
|
11027
|
+
|
|
11028
|
+
|
|
11029
|
+
|
|
11030
|
+
Name | Type | Description
|
|
11031
|
+
-----|------|-------------
|
|
11032
|
+
**artifactsDirectory**🔹 | <code>string</code> | A name of a directory that includes build artifacts.
|
|
11033
|
+
**buildTask**🔹 | <code>[Task](#projen-task)</code> | The task to execute in order to build the project.
|
|
11034
|
+
**antitamper**?🔹 | <code>boolean</code> | Enable anti-tamper check.<br/>__*Default*__: true
|
|
11035
|
+
**containerImage**?🔹 | <code>string</code> | The container image to use for builds.<br/>__*Default*__: the default workflow container
|
|
11036
|
+
**env**?🔹 | <code>Map<string, string></code> | Build environment variables.<br/>__*Default*__: {}
|
|
11037
|
+
**gitIdentity**?🔹 | <code>[github.GitIdentity](#projen-github-gitidentity)</code> | Git identity to use for the workflow.<br/>__*Default*__: default identity
|
|
11038
|
+
**mutableBuild**?🔹 | <code>boolean</code> | Automatically update files modified during builds to pull-request branches.<br/>__*Default*__: true
|
|
11039
|
+
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build.<br/>__*Default*__: []
|
|
11040
|
+
**preBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before the build.<br/>__*Default*__: []
|
|
11041
|
+
|
|
11042
|
+
|
|
11043
|
+
|
|
10776
11044
|
## struct Catalog 🔹 <a id="projen-cdk-catalog"></a>
|
|
10777
11045
|
|
|
10778
11046
|
|
|
@@ -10803,7 +11071,7 @@ Name | Type | Description
|
|
|
10803
11071
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
10804
11072
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
10805
11073
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
10806
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
11074
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
10807
11075
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
10808
11076
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
10809
11077
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -10814,6 +11082,8 @@ Name | Type | Description
|
|
|
10814
11082
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
10815
11083
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
10816
11084
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
11085
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11086
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
10817
11087
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
10818
11088
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
10819
11089
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -10870,7 +11140,7 @@ Name | Type | Description
|
|
|
10870
11140
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
10871
11141
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
10872
11142
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
10873
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
11143
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
10874
11144
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
10875
11145
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
10876
11146
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -10891,6 +11161,7 @@ Name | Type | Description
|
|
|
10891
11161
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
10892
11162
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
10893
11163
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
11164
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
10894
11165
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
10895
11166
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
10896
11167
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
@@ -10948,6 +11219,8 @@ Name | Type | Description
|
|
|
10948
11219
|
**dotNetNamespace**🔹 | <code>string</code> | <span></span>
|
|
10949
11220
|
**packageId**🔹 | <code>string</code> | <span></span>
|
|
10950
11221
|
**nugetApiKeySecret**?🔹 | <code>string</code> | GitHub secret which contains the API key for NuGet.<br/>__*Default*__: "NUGET_API_KEY"
|
|
11222
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
11223
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
10951
11224
|
|
|
10952
11225
|
|
|
10953
11226
|
|
|
@@ -10967,6 +11240,8 @@ Name | Type | Description
|
|
|
10967
11240
|
**gitUserName**?⚠️ | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "github-actions"
|
|
10968
11241
|
**githubRepo**?⚠️ | <code>string</code> | GitHub repository to push to.<br/>__*Default*__: derived from `moduleName`
|
|
10969
11242
|
**githubTokenSecret**?⚠️ | <code>string</code> | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_TOKEN"
|
|
11243
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
11244
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
10970
11245
|
|
|
10971
11246
|
|
|
10972
11247
|
|
|
@@ -10990,6 +11265,8 @@ Name | Type | Description
|
|
|
10990
11265
|
**mavenServerId**?🔹 | <code>string</code> | Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).<br/>__*Default*__: "ossrh" (Maven Central) or "github" when using GitHub Packages
|
|
10991
11266
|
**mavenStagingProfileId**?🔹 | <code>string</code> | GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).<br/>__*Default*__: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages
|
|
10992
11267
|
**mavenUsername**?🔹 | <code>string</code> | GitHub secret name which contains the Username for maven repository.<br/>__*Default*__: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages
|
|
11268
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
11269
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
10993
11270
|
|
|
10994
11271
|
|
|
10995
11272
|
|
|
@@ -11009,7 +11286,7 @@ Name | Type | Description
|
|
|
11009
11286
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11010
11287
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11011
11288
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11012
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
11289
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11013
11290
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11014
11291
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
11015
11292
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -11020,6 +11297,8 @@ Name | Type | Description
|
|
|
11020
11297
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
11021
11298
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
11022
11299
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
11300
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11301
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11023
11302
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11024
11303
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11025
11304
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -11075,7 +11354,7 @@ Name | Type | Description
|
|
|
11075
11354
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
11076
11355
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
11077
11356
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
11078
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
11357
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
11079
11358
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
11080
11359
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
11081
11360
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -11096,6 +11375,7 @@ Name | Type | Description
|
|
|
11096
11375
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
11097
11376
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
11098
11377
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
11378
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
11099
11379
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
11100
11380
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
11101
11381
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
@@ -11152,6 +11432,8 @@ Name | Type | Description
|
|
|
11152
11432
|
-----|------|-------------
|
|
11153
11433
|
**distName**🔹 | <code>string</code> | <span></span>
|
|
11154
11434
|
**module**🔹 | <code>string</code> | <span></span>
|
|
11435
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
11436
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
11155
11437
|
**twinePasswordSecret**?🔹 | <code>string</code> | The GitHub secret which contains PyPI password.<br/>__*Default*__: "TWINE_PASSWORD"
|
|
11156
11438
|
**twineRegistryUrl**?🔹 | <code>string</code> | The registry url to use when releasing packages.<br/>__*Default*__: twine default
|
|
11157
11439
|
**twineUsernameSecret**?🔹 | <code>string</code> | The GitHub secret which contains PyPI user name.<br/>__*Default*__: "TWINE_USERNAME"
|
|
@@ -11173,7 +11455,7 @@ Name | Type | Description
|
|
|
11173
11455
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11174
11456
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11175
11457
|
**appEntrypoint**?🔹 | <code>string</code> | The CDK8s app's entrypoint (relative to the source directory, which is "src" by default).<br/>__*Default*__: "main.ts"
|
|
11176
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
11458
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11177
11459
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11178
11460
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
11179
11461
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -11184,6 +11466,8 @@ Name | Type | Description
|
|
|
11184
11466
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
11185
11467
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
11186
11468
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
11469
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11470
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11187
11471
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11188
11472
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11189
11473
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -11241,7 +11525,7 @@ Name | Type | Description
|
|
|
11241
11525
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
11242
11526
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
11243
11527
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
11244
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
11528
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
11245
11529
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
11246
11530
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
11247
11531
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -11262,6 +11546,7 @@ Name | Type | Description
|
|
|
11262
11546
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
11263
11547
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
11264
11548
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
11549
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
11265
11550
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
11266
11551
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
11267
11552
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
@@ -11318,7 +11603,7 @@ Name | Type | Description
|
|
|
11318
11603
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11319
11604
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11320
11605
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11321
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
11606
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11322
11607
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11323
11608
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
11324
11609
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -11329,6 +11614,8 @@ Name | Type | Description
|
|
|
11329
11614
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
11330
11615
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
11331
11616
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
11617
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11618
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11332
11619
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11333
11620
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11334
11621
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -11389,7 +11676,7 @@ Name | Type | Description
|
|
|
11389
11676
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
11390
11677
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
11391
11678
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
11392
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
11679
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
11393
11680
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
11394
11681
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
11395
11682
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -11410,6 +11697,7 @@ Name | Type | Description
|
|
|
11410
11697
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
11411
11698
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
11412
11699
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
11700
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
11413
11701
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
11414
11702
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
11415
11703
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
@@ -11472,7 +11760,7 @@ Name | Type | Description
|
|
|
11472
11760
|
**repositoryUrl**🔹 | <code>string</code> | Git repository URL.
|
|
11473
11761
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
11474
11762
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
11475
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
11763
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
11476
11764
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
11477
11765
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
11478
11766
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -11483,6 +11771,8 @@ Name | Type | Description
|
|
|
11483
11771
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
11484
11772
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
11485
11773
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
11774
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
11775
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
11486
11776
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
11487
11777
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
11488
11778
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -11539,7 +11829,7 @@ Name | Type | Description
|
|
|
11539
11829
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
11540
11830
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
11541
11831
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
11542
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
11832
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
11543
11833
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
11544
11834
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
11545
11835
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -11560,6 +11850,7 @@ Name | Type | Description
|
|
|
11560
11850
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
11561
11851
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
11562
11852
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
11853
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
11563
11854
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
11564
11855
|
**publishToGo**?🔹 | <code>[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)</code> | Publish Go bindings to a git repository.<br/>__*Default*__: no publishing
|
|
11565
11856
|
**publishToMaven**?🔹 | <code>[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)</code> | Publish to maven.<br/>__*Default*__: no publishing
|
|
@@ -12413,6 +12704,8 @@ Name | Type | Description
|
|
|
12413
12704
|
**authorUrl**?🔹 | <code>string</code> | Author's URL / Website.<br/>__*Optional*__
|
|
12414
12705
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
12415
12706
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
12707
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12708
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12416
12709
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12417
12710
|
**codeArtifactOptions**?🔹 | <code>[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
12418
12711
|
**deps**?🔹 | <code>Array<string></code> | Runtime dependencies of this module.<br/>__*Default*__: []
|
|
@@ -12453,7 +12746,7 @@ Name | Type | Description
|
|
|
12453
12746
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
12454
12747
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
12455
12748
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
12456
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
12749
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
12457
12750
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
12458
12751
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
12459
12752
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -12464,6 +12757,8 @@ Name | Type | Description
|
|
|
12464
12757
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
12465
12758
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
12466
12759
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
12760
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
12761
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
12467
12762
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
12468
12763
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
12469
12764
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -12508,6 +12803,7 @@ Name | Type | Description
|
|
|
12508
12803
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
12509
12804
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
12510
12805
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
12806
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
12511
12807
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
12512
12808
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
12513
12809
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -12526,6 +12822,7 @@ Name | Type | Description
|
|
|
12526
12822
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
12527
12823
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
12528
12824
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
12825
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
12529
12826
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
12530
12827
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
12531
12828
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
@@ -13085,6 +13382,20 @@ Name | Type | Description
|
|
|
13085
13382
|
|
|
13086
13383
|
|
|
13087
13384
|
|
|
13385
|
+
## struct CommonPublishOptions 🔹 <a id="projen-release-commonpublishoptions"></a>
|
|
13386
|
+
|
|
13387
|
+
|
|
13388
|
+
Common publishing options.
|
|
13389
|
+
|
|
13390
|
+
|
|
13391
|
+
|
|
13392
|
+
Name | Type | Description
|
|
13393
|
+
-----|------|-------------
|
|
13394
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13395
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13396
|
+
|
|
13397
|
+
|
|
13398
|
+
|
|
13088
13399
|
## struct GitHubReleasesPublishOptions 🔹 <a id="projen-release-githubreleasespublishoptions"></a>
|
|
13089
13400
|
|
|
13090
13401
|
|
|
@@ -13097,6 +13408,8 @@ Name | Type | Description
|
|
|
13097
13408
|
**changelogFile**🔹 | <code>string</code> | The location of an .md file (relative to `dist/`) that includes the changelog for the release.
|
|
13098
13409
|
**releaseTagFile**🔹 | <code>string</code> | The location of a text file (relative to `dist/`) that contains the release tag.
|
|
13099
13410
|
**versionFile**🔹 | <code>string</code> | The location of a text file (relative to `dist/`) that contains the version number.
|
|
13411
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13412
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13100
13413
|
|
|
13101
13414
|
|
|
13102
13415
|
|
|
@@ -13133,6 +13446,8 @@ Name | Type | Description
|
|
|
13133
13446
|
**gitUserName**?⚠️ | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "github-actions"
|
|
13134
13447
|
**githubRepo**?⚠️ | <code>string</code> | GitHub repository to push to.<br/>__*Default*__: derived from `moduleName`
|
|
13135
13448
|
**githubTokenSecret**?⚠️ | <code>string</code> | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_TOKEN"
|
|
13449
|
+
**prePublishSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13450
|
+
**publishTools**?⚠️ | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13136
13451
|
|
|
13137
13452
|
|
|
13138
13453
|
|
|
@@ -13153,6 +13468,8 @@ Name | Type | Description
|
|
|
13153
13468
|
**mavenServerId**?⚠️ | <code>string</code> | Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).<br/>__*Default*__: "ossrh" (Maven Central) or "github" when using GitHub Packages
|
|
13154
13469
|
**mavenStagingProfileId**?⚠️ | <code>string</code> | GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).<br/>__*Default*__: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages
|
|
13155
13470
|
**mavenUsername**?⚠️ | <code>string</code> | GitHub secret name which contains the Username for maven repository.<br/>__*Default*__: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages
|
|
13471
|
+
**prePublishSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13472
|
+
**publishTools**?⚠️ | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13156
13473
|
|
|
13157
13474
|
|
|
13158
13475
|
|
|
@@ -13168,6 +13485,8 @@ Name | Type | Description
|
|
|
13168
13485
|
**codeArtifactOptions**?⚠️ | <code>[release.CodeArtifactOptions](#projen-release-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
13169
13486
|
**distTag**?⚠️ | <code>string</code> | Tags can be used to provide an alias instead of version numbers.<br/>__*Default*__: "latest"
|
|
13170
13487
|
**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`.
|
|
13488
|
+
**prePublishSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13489
|
+
**publishTools**?⚠️ | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13171
13490
|
**registry**?⚠️ | <code>string</code> | The domain name of the npm package registry.<br/>__*Default*__: "registry.npmjs.org"
|
|
13172
13491
|
|
|
13173
13492
|
|
|
@@ -13182,6 +13501,8 @@ Name | Type | Description
|
|
|
13182
13501
|
Name | Type | Description
|
|
13183
13502
|
-----|------|-------------
|
|
13184
13503
|
**nugetApiKeySecret**?⚠️ | <code>string</code> | GitHub secret which contains the API key for NuGet.<br/>__*Default*__: "NUGET_API_KEY"
|
|
13504
|
+
**prePublishSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13505
|
+
**publishTools**?⚠️ | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13185
13506
|
|
|
13186
13507
|
|
|
13187
13508
|
|
|
@@ -13194,6 +13515,8 @@ Name | Type | Description
|
|
|
13194
13515
|
|
|
13195
13516
|
Name | Type | Description
|
|
13196
13517
|
-----|------|-------------
|
|
13518
|
+
**prePublishSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13519
|
+
**publishTools**?⚠️ | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13197
13520
|
**twinePasswordSecret**?⚠️ | <code>string</code> | The GitHub secret which contains PyPI password.<br/>__*Default*__: "TWINE_PASSWORD"
|
|
13198
13521
|
**twineRegistryUrl**?⚠️ | <code>string</code> | The registry url to use when releasing packages.<br/>__*Default*__: twine default
|
|
13199
13522
|
**twineUsernameSecret**?⚠️ | <code>string</code> | The GitHub secret which contains PyPI user name.<br/>__*Default*__: "TWINE_USERNAME"
|
|
@@ -13232,6 +13555,8 @@ Name | Type | Description
|
|
|
13232
13555
|
**mavenServerId**?🔹 | <code>string</code> | Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).<br/>__*Default*__: "ossrh" (Maven Central) or "github" when using GitHub Packages
|
|
13233
13556
|
**mavenStagingProfileId**?🔹 | <code>string</code> | GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).<br/>__*Default*__: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages
|
|
13234
13557
|
**mavenUsername**?🔹 | <code>string</code> | GitHub secret name which contains the Username for maven repository.<br/>__*Default*__: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages
|
|
13558
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13559
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13235
13560
|
|
|
13236
13561
|
|
|
13237
13562
|
|
|
@@ -13247,6 +13572,8 @@ Name | Type | Description
|
|
|
13247
13572
|
**codeArtifactOptions**?🔹 | <code>[release.CodeArtifactOptions](#projen-release-codeartifactoptions)</code> | Options for publishing npm package to AWS CodeArtifact.<br/>__*Default*__: undefined
|
|
13248
13573
|
**distTag**?⚠️ | <code>string</code> | Tags can be used to provide an alias instead of version numbers.<br/>__*Default*__: "latest"
|
|
13249
13574
|
**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`.
|
|
13575
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13576
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13250
13577
|
**registry**?🔹 | <code>string</code> | The domain name of the npm package registry.<br/>__*Default*__: "registry.npmjs.org"
|
|
13251
13578
|
|
|
13252
13579
|
|
|
@@ -13261,6 +13588,8 @@ Options for NuGet releases.
|
|
|
13261
13588
|
Name | Type | Description
|
|
13262
13589
|
-----|------|-------------
|
|
13263
13590
|
**nugetApiKeySecret**?🔹 | <code>string</code> | GitHub secret which contains the API key for NuGet.<br/>__*Default*__: "NUGET_API_KEY"
|
|
13591
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13592
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13264
13593
|
|
|
13265
13594
|
|
|
13266
13595
|
|
|
@@ -13276,6 +13605,7 @@ Name | Type | Description
|
|
|
13276
13605
|
**artifactName**🔹 | <code>string</code> | The name of the artifact to download (e.g. `dist`).
|
|
13277
13606
|
**buildJobId**🔹 | <code>string</code> | The job ID that produces the build artifacts.
|
|
13278
13607
|
**condition**?🔹 | <code>string</code> | A GitHub workflow expression used as a condition for publishers.<br/>__*Default*__: no condition
|
|
13608
|
+
**dryRun**?🔹 | <code>boolean</code> | Do not actually publish, only print the commands that would be executed instead.<br/>__*Optional*__
|
|
13279
13609
|
**failureIssue**?🔹 | <code>boolean</code> | Create an issue when a publish task fails.<br/>__*Default*__: false
|
|
13280
13610
|
**failureIssueLabel**?🔹 | <code>string</code> | The label to apply to the issue marking failed publish tasks.<br/>__*Default*__: "failed-release"
|
|
13281
13611
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement for `jsii-release`.<br/>__*Default*__: "latest"
|
|
@@ -13293,6 +13623,8 @@ Options for PyPI release.
|
|
|
13293
13623
|
|
|
13294
13624
|
Name | Type | Description
|
|
13295
13625
|
-----|------|-------------
|
|
13626
|
+
**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
|
|
13627
|
+
**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
|
|
13296
13628
|
**twinePasswordSecret**?🔹 | <code>string</code> | The GitHub secret which contains PyPI password.<br/>__*Default*__: "TWINE_PASSWORD"
|
|
13297
13629
|
**twineRegistryUrl**?🔹 | <code>string</code> | The registry url to use when releasing packages.<br/>__*Default*__: twine default
|
|
13298
13630
|
**twineUsernameSecret**?🔹 | <code>string</code> | The GitHub secret which contains PyPI user name.<br/>__*Default*__: "TWINE_USERNAME"
|
|
@@ -13308,17 +13640,18 @@ Options for `Release`.
|
|
|
13308
13640
|
|
|
13309
13641
|
Name | Type | Description
|
|
13310
13642
|
-----|------|-------------
|
|
13643
|
+
**artifactsDirectory**🔹 | <code>string</code> | A directory which will contain build artifacts.
|
|
13311
13644
|
**branch**🔹 | <code>string</code> | The default branch name to release from.
|
|
13312
13645
|
**task**🔹 | <code>[Task](#projen-task)</code> | The task to execute in order to create the release artifacts.
|
|
13313
13646
|
**versionFile**🔹 | <code>string</code> | A name of a .json file to set the `version` field in after a bump.
|
|
13314
13647
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13315
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts to be published to npm.<br/>__*Default*__: "dist"
|
|
13316
13648
|
**githubRelease**?🔹 | <code>boolean</code> | Create a GitHub release for each release.<br/>__*Default*__: true
|
|
13317
13649
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `jsii-release` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
13318
13650
|
**majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
|
|
13319
13651
|
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
13320
13652
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
13321
13653
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
13654
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
13322
13655
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13323
13656
|
**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.
|
|
13324
13657
|
**releaseEveryCommit**?⚠️ | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`.<br/>__*Default*__: true
|
|
@@ -13345,12 +13678,12 @@ Project options for release.
|
|
|
13345
13678
|
Name | Type | Description
|
|
13346
13679
|
-----|------|-------------
|
|
13347
13680
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13348
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts to be published to npm.<br/>__*Default*__: "dist"
|
|
13349
13681
|
**jsiiReleaseVersion**?🔹 | <code>string</code> | Version requirement of `jsii-release` which is used to publish modules to npm.<br/>__*Default*__: "latest"
|
|
13350
13682
|
**majorVersion**?🔹 | <code>number</code> | Major version to release from the default branch.<br/>__*Default*__: Major version is not enforced.
|
|
13351
13683
|
**npmDistTag**?🔹 | <code>string</code> | The npmDistTag to use when publishing from the default branch.<br/>__*Default*__: "latest"
|
|
13352
13684
|
**postBuildSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute after build as part of the release workflow.<br/>__*Default*__: []
|
|
13353
13685
|
**prerelease**?🔹 | <code>string</code> | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").<br/>__*Default*__: normal semantic versions
|
|
13686
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
13354
13687
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13355
13688
|
**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.
|
|
13356
13689
|
**releaseEveryCommit**?⚠️ | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`.<br/>__*Default*__: true
|
|
@@ -13407,7 +13740,7 @@ Name | Type | Description
|
|
|
13407
13740
|
**name**⚠️ | <code>string</code> | This is the name of your project.
|
|
13408
13741
|
**allowLibraryDependencies**?⚠️ | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
13409
13742
|
**antitamper**?⚠️ | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13410
|
-
**artifactsDirectory**?⚠️ | <code>string</code> | A directory which will contain artifacts
|
|
13743
|
+
**artifactsDirectory**?⚠️ | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
13411
13744
|
**authorEmail**?⚠️ | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
13412
13745
|
**authorName**?⚠️ | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
13413
13746
|
**authorOrganization**?⚠️ | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -13418,6 +13751,8 @@ Name | Type | Description
|
|
|
13418
13751
|
**autoDetectBin**?⚠️ | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
13419
13752
|
**autoMergeOptions**?⚠️ | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
13420
13753
|
**bin**?⚠️ | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
13754
|
+
**bugsEmail**?⚠️ | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
13755
|
+
**bugsUrl**?⚠️ | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
13421
13756
|
**buildWorkflow**?⚠️ | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
13422
13757
|
**bundledDeps**?⚠️ | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
13423
13758
|
**bundlerOptions**?⚠️ | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -13469,7 +13804,7 @@ Name | Type | Description
|
|
|
13469
13804
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
13470
13805
|
**npmignoreEnabled**?⚠️ | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
13471
13806
|
**outdir**?⚠️ | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
13472
|
-
**package**?⚠️ | <code>boolean</code> | Defines a `
|
|
13807
|
+
**package**?⚠️ | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
13473
13808
|
**packageManager**?⚠️ | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
13474
13809
|
**packageName**?⚠️ | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
13475
13810
|
**parent**?⚠️ | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -13490,6 +13825,7 @@ Name | Type | Description
|
|
|
13490
13825
|
**projenrcJsonOptions**?⚠️ | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13491
13826
|
**projenrcTs**?⚠️ | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
13492
13827
|
**projenrcTsOptions**?⚠️ | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
13828
|
+
**publishDryRun**?⚠️ | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
13493
13829
|
**publishTasks**?⚠️ | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13494
13830
|
**pullRequestTemplate**?⚠️ | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
13495
13831
|
**pullRequestTemplateContents**?⚠️ | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
@@ -13542,7 +13878,7 @@ Name | Type | Description
|
|
|
13542
13878
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
13543
13879
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
13544
13880
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13545
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
13881
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
13546
13882
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
13547
13883
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
13548
13884
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -13553,6 +13889,8 @@ Name | Type | Description
|
|
|
13553
13889
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
13554
13890
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
13555
13891
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
13892
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
13893
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
13556
13894
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
13557
13895
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
13558
13896
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -13604,7 +13942,7 @@ Name | Type | Description
|
|
|
13604
13942
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
13605
13943
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
13606
13944
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
13607
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
13945
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
13608
13946
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
13609
13947
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
13610
13948
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -13625,6 +13963,7 @@ Name | Type | Description
|
|
|
13625
13963
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13626
13964
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
13627
13965
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
13966
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
13628
13967
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13629
13968
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
13630
13969
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
@@ -13781,7 +14120,7 @@ Name | Type | Description
|
|
|
13781
14120
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
13782
14121
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
13783
14122
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13784
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
14123
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
13785
14124
|
**assetsdir**?🔹 | <code>string</code> | Assets directory.<br/>__*Default*__: "public"
|
|
13786
14125
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
13787
14126
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -13793,6 +14132,8 @@ Name | Type | Description
|
|
|
13793
14132
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
13794
14133
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
13795
14134
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
14135
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
14136
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
13796
14137
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
13797
14138
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
13798
14139
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -13837,6 +14178,7 @@ Name | Type | Description
|
|
|
13837
14178
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
13838
14179
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
13839
14180
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
14181
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
13840
14182
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
13841
14183
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
13842
14184
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -13855,6 +14197,7 @@ Name | Type | Description
|
|
|
13855
14197
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
13856
14198
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
13857
14199
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
14200
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
13858
14201
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13859
14202
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
13860
14203
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
@@ -13903,7 +14246,7 @@ Name | Type | Description
|
|
|
13903
14246
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
13904
14247
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
13905
14248
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
13906
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
14249
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
13907
14250
|
**assetsdir**?🔹 | <code>string</code> | Assets directory.<br/>__*Default*__: "public"
|
|
13908
14251
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
13909
14252
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
@@ -13915,6 +14258,8 @@ Name | Type | Description
|
|
|
13915
14258
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
13916
14259
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
13917
14260
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
14261
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
14262
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
13918
14263
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
13919
14264
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
13920
14265
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -13966,7 +14311,7 @@ Name | Type | Description
|
|
|
13966
14311
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
13967
14312
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
13968
14313
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
13969
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
14314
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
13970
14315
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
13971
14316
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
13972
14317
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -13987,6 +14332,7 @@ Name | Type | Description
|
|
|
13987
14332
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
13988
14333
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
13989
14334
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
14335
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
13990
14336
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
13991
14337
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
13992
14338
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
@@ -14069,7 +14415,7 @@ Name | Type | Description
|
|
|
14069
14415
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14070
14416
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14071
14417
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14072
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
14418
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14073
14419
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
14074
14420
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
14075
14421
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -14080,6 +14426,8 @@ Name | Type | Description
|
|
|
14080
14426
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
14081
14427
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
14082
14428
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
14429
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
14430
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
14083
14431
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
14084
14432
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
14085
14433
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -14124,6 +14472,7 @@ Name | Type | Description
|
|
|
14124
14472
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
14125
14473
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
14126
14474
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
14475
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
14127
14476
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
14128
14477
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
14129
14478
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -14142,6 +14491,7 @@ Name | Type | Description
|
|
|
14142
14491
|
**projenrcJsOptions**?🔹 | <code>[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)</code> | Options for .projenrc.js.<br/>__*Default*__: default options
|
|
14143
14492
|
**projenrcJson**?🔹 | <code>boolean</code> | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.<br/>__*Default*__: false
|
|
14144
14493
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
14494
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
14145
14495
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
14146
14496
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
14147
14497
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|
|
@@ -14219,7 +14569,7 @@ Name | Type | Description
|
|
|
14219
14569
|
**name**🔹 | <code>string</code> | This is the name of your project.
|
|
14220
14570
|
**allowLibraryDependencies**?🔹 | <code>boolean</code> | Allow the project to include `peerDependencies` and `bundledDependencies`.<br/>__*Default*__: true
|
|
14221
14571
|
**antitamper**?🔹 | <code>boolean</code> | Checks that after build there are no modified files on git.<br/>__*Default*__: true
|
|
14222
|
-
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain artifacts
|
|
14572
|
+
**artifactsDirectory**?🔹 | <code>string</code> | A directory which will contain build artifacts.<br/>__*Default*__: "dist"
|
|
14223
14573
|
**authorEmail**?🔹 | <code>string</code> | Author's e-mail.<br/>__*Optional*__
|
|
14224
14574
|
**authorName**?🔹 | <code>string</code> | Author's name.<br/>__*Optional*__
|
|
14225
14575
|
**authorOrganization**?🔹 | <code>boolean</code> | Author's Organization.<br/>__*Optional*__
|
|
@@ -14230,6 +14580,8 @@ Name | Type | Description
|
|
|
14230
14580
|
**autoDetectBin**?🔹 | <code>boolean</code> | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.<br/>__*Default*__: true
|
|
14231
14581
|
**autoMergeOptions**?🔹 | <code>[github.AutoMergeOptions](#projen-github-automergeoptions)</code> | Configure options for automatic merging on GitHub.<br/>__*Default*__: see defaults in `AutoMergeOptions`
|
|
14232
14582
|
**bin**?🔹 | <code>Map<string, string></code> | Binary programs vended with your module.<br/>__*Optional*__
|
|
14583
|
+
**bugsEmail**?🔹 | <code>string</code> | The email address to which issues should be reported.<br/>__*Optional*__
|
|
14584
|
+
**bugsUrl**?🔹 | <code>string</code> | The url to your project's issue tracker.<br/>__*Optional*__
|
|
14233
14585
|
**buildWorkflow**?🔹 | <code>boolean</code> | Define a GitHub workflow for building PRs.<br/>__*Default*__: true if not a subproject
|
|
14234
14586
|
**bundledDeps**?🔹 | <code>Array<string></code> | List of dependencies to bundle into this module.<br/>__*Optional*__
|
|
14235
14587
|
**bundlerOptions**?🔹 | <code>[javascript.BundlerOptions](#projen-javascript-bundleroptions)</code> | Options for `Bundler`.<br/>__*Optional*__
|
|
@@ -14281,7 +14633,7 @@ Name | Type | Description
|
|
|
14281
14633
|
**npmignore**?⚠️ | <code>Array<string></code> | Additional entries to .npmignore.<br/>__*Optional*__
|
|
14282
14634
|
**npmignoreEnabled**?🔹 | <code>boolean</code> | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.<br/>__*Default*__: true
|
|
14283
14635
|
**outdir**?🔹 | <code>string</code> | The root directory of the project.<br/>__*Default*__: "."
|
|
14284
|
-
**package**?🔹 | <code>boolean</code> | Defines a `
|
|
14636
|
+
**package**?🔹 | <code>boolean</code> | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).<br/>__*Default*__: true
|
|
14285
14637
|
**packageManager**?🔹 | <code>[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)</code> | The Node Package Manager used to execute scripts.<br/>__*Default*__: NodePackageManager.YARN
|
|
14286
14638
|
**packageName**?🔹 | <code>string</code> | The "name" in package.json.<br/>__*Default*__: defaults to project name
|
|
14287
14639
|
**parent**?🔹 | <code>[Project](#projen-project)</code> | The parent project, if this project is part of a bigger project.<br/>__*Optional*__
|
|
@@ -14302,6 +14654,7 @@ Name | Type | Description
|
|
|
14302
14654
|
**projenrcJsonOptions**?🔹 | <code>[ProjenrcOptions](#projen-projenrcoptions)</code> | Options for .projenrc.json.<br/>__*Default*__: default options
|
|
14303
14655
|
**projenrcTs**?🔹 | <code>boolean</code> | Use TypeScript for your projenrc file (`.projenrc.ts`).<br/>__*Default*__: false
|
|
14304
14656
|
**projenrcTsOptions**?🔹 | <code>[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)</code> | Options for .projenrc.ts.<br/>__*Optional*__
|
|
14657
|
+
**publishDryRun**?🔹 | <code>boolean</code> | Instead of actually publishing to package managers, just print the publishing command.<br/>__*Default*__: false
|
|
14305
14658
|
**publishTasks**?🔹 | <code>boolean</code> | Define publishing tasks that can be executed manually as well as workflows.<br/>__*Default*__: false
|
|
14306
14659
|
**pullRequestTemplate**?🔹 | <code>boolean</code> | Include a GitHub pull request template.<br/>__*Default*__: true
|
|
14307
14660
|
**pullRequestTemplateContents**?🔹 | <code>Array<string></code> | The contents of the pull request template.<br/>__*Default*__: default content
|