diff --git a/API.md b/API.md index e3596d5..67169dd 100644 --- a/API.md +++ b/API.md @@ -1626,9 +1626,11 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... } | scripts | {[ key: string ]: string} | npm scripts to include. | | stability | string | Package's Stability. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | +| bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | number | Major version to release from the default branch. | | minMajorVersion | number | Minimal Major version to release. | +| nextVersionCommand | string | A shell command to control the next version to release. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | projen.github.workflows.JobStep[] | Steps to execute after build as part of the release workflow. | | prerelease | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | @@ -2630,7 +2632,7 @@ public readonly pnpmVersion: string; ``` - *Type:* string -- *Default:* "7" +- *Default:* "9" The version of PNPM to use if using PNPM as a package manager. @@ -2719,6 +2721,21 @@ Options for Yarn Berry. --- +##### `bumpPackage`Optional + +```typescript +public readonly bumpPackage: string; +``` + +- *Type:* string +- *Default:* A recent version of "commit-and-tag-version" + +The `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`. + +--- + ##### `jsiiReleaseVersion`Optional ```typescript @@ -2766,6 +2783,37 @@ Can not be set together with `majorVersion`. --- +##### `nextVersionCommand`Optional + +```typescript +public readonly nextVersionCommand: string; +``` + +- *Type:* string +- *Default:* The next version will be determined based on the commit history and project settings. + +A shell command to control the next version to release. + +If present, this shell command will be run before the bump is executed, and +it determines what version to release. It will be executed in the following +environment: + +- Working directory: the project directory. +- `$VERSION`: the current version. Looks like `1.2.3`. +- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset. + +The command should print one of the following to `stdout`: + +- Nothing: the next version number will be determined based on commit history. +- `x.y.z`: the next version number will be `x.y.z`. +- `major|minor|patch`: the next version number will be the current version number + with the indicated component bumped. + +This setting cannot be specified together with `minMajorVersion`; the invoked +script can be used to achieve the effects of `minMajorVersion`. + +--- + ##### `npmDistTag`Optional ```typescript