Bundled dependencies will be added as normal dependencies as well as to the
bundledDependencies section of your package.json.
Names modules to install. By default, the the dependency will
-be installed in the next npx projen run and the version will be recorded
-in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax:
+be installed in the next pnpm projen run and the version will be recorded
+in your package.json file. You can upgrade manually or using pnpm add/update. If you wish to specify a version range use this syntax:
module@^7.
Adds an AWS CDK module dependencies
The list of modules to depend on
@@ -197,13 +197,13 @@Defines normal dependencies.
Names modules to install. By default, the the dependency will
-be installed in the next npx projen run and the version will be recorded
-in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax:
+be installed in the next pnpm projen run and the version will be recorded
+in your package.json file. You can upgrade manually or using pnpm add/update. If you wish to specify a version range use this syntax:
module@^7.
Defines development/test dependencies.
Names modules to install. By default, the the dependency will
-be installed in the next npx projen run and the version will be recorded
-in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax:
+be installed in the next pnpm projen run and the version will be recorded
+in your package.json file. You can upgrade manually or using pnpm add/update. If you wish to specify a version range use this syntax:
module@^7.
Exclude the matching files from pre-synth cleanup. Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth.
@@ -222,8 +222,8 @@ pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.Names modules to install. By default, the the dependency will
-be installed in the next npx projen run and the version will be recorded
-in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax:
+be installed in the next pnpm projen run and the version will be recorded
+in your package.json file. You can upgrade manually or using pnpm add/update. If you wish to specify a version range use this syntax:
module@^7.
Replaces the contents of multiple npm package.json scripts.
The scripts to set
@@ -259,7 +259,7 @@Optionaloptions: RenderWorkflowSetupOptionsOptions.
Job steps
Returns the shell command to execute in order to run a task. This will
-typically be npx projen TASK.
pnpm projen TASK.
The task for which the command is required
Replaces the contents of an npm package.json script.
The script name
diff --git a/docs/projen/classes/Workflow.html b/docs/projen/classes/Workflow.html index 8fb2992..e1170d8 100644 --- a/docs/projen/classes/Workflow.html +++ b/docs/projen/classes/Workflow.html @@ -3,7 +3,7 @@Optional ReadonlyaddAutomatically add the resolved packageManager to devEngines.packageManager
+in package.json, setting onFail to ignore.
Optional ReadonlyallowAllow the project to include peerDependencies and bundledDependencies.
This is normally only allowed for libraries. For apps, there's no meaning
for specifying these.
Optional ReadonlyappThe command line to execute in order to synthesize the CDK application (language specific).
Optional ReadonlyappThe CDK app's entrypoint (relative to the source directory, which is "src" by default).
-Optional ReadonlyartifactsA directory which will contain build artifacts.
-Optional ReadonlyauditRun security audit on dependencies.
When enabled, creates an "audit" task that checks for known security vulnerabilities in dependencies. By default, runs during every build and checks for "high" severity vulnerabilities or above in all dependencies (including dev dependencies).
-Optional ReadonlyauditSecurity audit options.
-Optional ReadonlyauthorAuthor's e-mail
@@ -212,28 +220,28 @@Optional ReadonlyauthorIs the author an organization
Optional ReadonlyauthorAuthor's URL / Website
Optional ReadonlyautoEnable and configure the 'auto approve' workflow.
-Optional ReadonlyautoAutomatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
Throw if set to true but autoApproveOptions are not defined.
Optional ReadonlyautoAutomatically add all executables under the bin directory to your
package.json file under the bin section.
Optional ReadonlyautoEnable automatic merging on GitHub. Has no effect if github.mergify
is set to false.
Optional ReadonlyautoConfigure options for automatic merging on GitHub. Has no effect if
github.mergify or autoMerge is set to false.
Optional ReadonlybinBinary programs vended with your module.
@@ -241,11 +249,11 @@ yourpackage.json, but unless autoDetectBin is false, every
executable file under bin will automatically be added to this section.
Optional ReadonlybiomeSetup Biome.
-Optional ReadonlybiomeBiome options
-Optional ReadonlybugsThe email address to which issues should be reported.
@@ -253,16 +261,16 @@Optional ReadonlybuildA command to execute before synthesis. This command will be called when
running cdk synth or when cdk watch identifies a change in your source
code before redeployment.
Optional ReadonlybuildDefine a GitHub workflow for building PRs.
-Optional ReadonlybuildOptions for PR build workflow.
Optional ReadonlybuildBuild workflow triggers
-Optional ReadonlybumpThe commit-and-tag-version compatible package used to bump the package version, as a dependency string.
This can be any compatible package version, including the deprecated standard-version@9.
Optional ReadonlybundledList of dependencies to bundle into this module. These modules will be
added both to the dependencies section and bundledDependencies section of
your package.json.
The recommendation is to only specify the module name here (e.g.
-express). This will behave similar to yarn add or npm install in the
+express). This will behave similar to pnpm add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
-the same syntax passed to npm i or yarn add (e.g. express@^2) and
-this will be what you package.json will eventually include.
pnpm add or npm i (e.g. express@^2) and
+this will be what your package.json will eventually include.
Optional ReadonlybundlerOptions for Bundler.
Optional ReadonlybunThe version of Bun to use if using Bun as a package manager.
-Optional ReadonlycdkWarning: NodeJS only. Install the @aws-cdk/assert library?
-Optional ReadonlycdkInstall the assertions library?
Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib'
-Optional ReadonlycdkVersion range of the AWS CDK CLI to depend on.
Can be either a specific version, or an NPM version range.
By default, the latest 2.x version will be installed; you can use this option to restrict it to a specific version or version range.
-Optional ReadonlycdkWhich AWS CDKv1 modules this project requires
@@ -316,18 +324,18 @@ If this is disabled,cdkDependencies will be added to devDependencies to ensure
they are present during development.
Note: this setting only applies to construct library projects
-Optional Readonlycdkoutcdk.out directory.
-Optional ReadonlycdkAWS CDK modules required for testing.
ReadonlycdkMinimum version of the AWS CDK to depend on.
-Optional ReadonlycdkUse pinned version instead of caret version for CDK.
@@ -335,229 +343,241 @@ If you use experimental features this will let you define the moment you include breaking changes.Optional ReadonlycheckConfigure which licenses should be deemed acceptable for use by dependencies
This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
-Optional ReadonlyclobberAdd a clobber task which resets the repo to origin.
Optional ReadonlycodeOptions for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
-Optional ReadonlycodeDefine a GitHub workflow step for sending code coverage metrics to https://codecov.io/
Uses codecov/codecov-action@v5
By default, OIDC auth is used. Alternatively a token can be provided via codeCovTokenSecret.
Optional ReadonlycodeDefine the secret name for a specified https://codecov.io/ token
-Optional ReadonlycommitWhether to commit the managed files by default.
-Optional ReadonlyconstructsMinimum version of the constructs library to depend on.
Optional ReadonlycontextAdditional context to include in cdk.json.
Optional ReadonlycopyrightLicense copyright owner.
-Optional ReadonlycopyrightThe copyright years to put in the LICENSE file.
-ReadonlydefaultThe name of the main release branch.
-Optional ReadonlydeleteAutomatically delete lockfiles from package managers that are not the +active one. Only triggered when the lockfile for the configured package +manager already exists.
+This is useful when migrating between package managers to avoid conflicts.
+Optional ReadonlydependabotUse dependabot to handle dependency upgrades. +
Optional ReadonlydependabotUse dependabot to handle dependency upgrades.
Cannot be used in conjunction with depsUpgrade.
Optional ReadonlydependabotOptions for dependabot.
-Optional ReadonlydepsRuntime dependencies of this module.
The recommendation is to only specify the module name here (e.g.
-express). This will behave similar to yarn add or npm install in the
+express). This will behave similar to pnpm add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
-the same syntax passed to npm i or yarn add (e.g. express@^2) and
-this will be what you package.json will eventually include.
pnpm add or npm i (e.g. express@^2) and
+this will be what your package.json will eventually include.
Optional ReadonlydepsUse tasks and github workflows to handle dependency upgrades.
Cannot be used in conjunction with dependabot.
Optional ReadonlydepsOptions for UpgradeDependencies.
Optional ReadonlydescriptionThe description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
Optional ReadonlydevAdd a VSCode development environment (used for GitHub Codespaces)
-Optional ReadonlydevBuild dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed.
The recommendation is to only specify the module name here (e.g.
-express). This will behave similar to yarn add or npm install in the
+express). This will behave similar to pnpm add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
-the same syntax passed to npm i or yarn add (e.g. express@^2) and
-this will be what you package.json will eventually include.
pnpm add or npm i (e.g. express@^2) and
+this will be what your package.json will eventually include.
Optional ReadonlydisableDo not generate a tsconfig.json file (used by jsii projects since
+
Optional ReadonlydevConfigure the devEngines field in package.json.
The devEngines.packageManager field is automatically populated based on
+the resolved packageManager value. Any fields provided here are merged
+with the auto-populated packageManager entry.
Optional ReadonlydisableDo not generate a tsconfig.json file (used by jsii projects since
tsconfig.json is generated by the jsii compiler).
Optional ReadonlydisableDo not generate a tsconfig.dev.json file.
Optional ReadonlydocgenDocgen by Typedoc
-Optional ReadonlydocsDocs directory
-Optional ReadonlyedgeAutomatically adds an cloudfront.experimental.EdgeFunction for each
.edge-lambda.ts handler in your source tree. If this is disabled, you can
manually add an awscdk.AutoDiscover component to your project.
Optional ReadonlyentrypointModule entrypoint (main in package.json)
Set to an empty string to not include main in your package.json
Optional ReadonlyentrypointThe .d.ts file that includes the type declarations for this module.
-Optional ReadonlyeslintSetup eslint.
-Optional ReadonlyeslintEslint options
-Optional Readonly ExperimentalexperimentalEnable experimental support for the AWS CDK integ-runner.
-Optional ReadonlyfeatureFeature flags that should be enabled in cdk.json.
Make sure to double-check any changes to feature flags in cdk.json before deploying.
Unexpected changes may cause breaking changes in your CDK app.
You can overwrite any feature flag by passing it into the context field.
Optional ReadonlygithubEnable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.
-Optional ReadonlygithubOptions for GitHub integration
-Optional ReadonlygitignoreAdditional entries to .gitignore
Optional ReadonlygitConfiguration options for .gitignore file
Optional ReadonlygitConfiguration options for git
Optional ReadonlygitpodAdd a Gitpod development environment
-Optional ReadonlyhomepagePackage's Homepage / Website
Optional ReadonlyintegrationAutomatically discovers and creates integration tests for each .integ.ts
file in under your test directory.
Optional ReadonlyjestSetup jest unit tests
-Optional ReadonlyjestJest options
-Optional ReadonlyjsiiVersion requirement of publib which is used to publish modules to npm.
Optional ReadonlykeywordsKeywords to include in package.json.
Optional ReadonlylambdaAutomatically adds an awscdk.LambdaFunction for each .lambda.ts handler
in your source tree. If this is disabled, you can manually add an
awscdk.AutoDiscover component to your project.
Optional ReadonlylambdaAutomatically adds an awscdk.LambdaExtension for each .lambda-extension.ts
entrypoint in your source tree. If this is disabled, you can manually add an
awscdk.AutoDiscover component to your project
Optional ReadonlylambdaCommon options for all AWS Lambda functions.
-Optional ReadonlylibdirTypescript artifacts output directory
-Optional ReadonlylicenseLicense's SPDX identifier.
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
Use the licensed option if you want to no license to be specified.
Optional ReadonlylicensedIndicates if a license should be added.
-Optional ReadonlyloggingConfigure logging options such as verbosity.
-Optional ReadonlymajorMajor version to release from the default branch.
If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.
-Optional ReadonlymaxThe maximum node version supported by this package. @@ -566,16 +586,16 @@ This requirement is enforced via the engines field.
You will normally not need to set this option. Consider this option only if your package is known to not function with newer versions of node.
-
Example
-