diff --git a/API.md b/API.md index 4b3ca06..4422caa 100644 --- a/API.md +++ b/API.md @@ -5034,9 +5034,11 @@ const clickUpCdkConstructLibraryOptions: clickupCdk.ClickUpCdkConstructLibraryOp | 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"). | @@ -6146,6 +6148,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 @@ -6193,6 +6210,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 @@ -7863,9 +7911,11 @@ const clickUpCdkTypeScriptAppOptions: clickupCdk.ClickUpCdkTypeScriptAppOptions | 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"). | @@ -8967,6 +9017,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 @@ -9014,6 +9079,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 @@ -10561,9 +10657,11 @@ const clickUpTypeScriptProjectOptions: clickupTs.ClickUpTypeScriptProjectOptions | 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"). | @@ -11639,6 +11737,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 @@ -11686,6 +11799,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 diff --git a/test/__snapshots__/clickup-cdk.test.ts.snap b/test/__snapshots__/clickup-cdk.test.ts.snap index a1996a7..b6c8a09 100644 --- a/test/__snapshots__/clickup-cdk.test.ts.snap +++ b/test/__snapshots__/clickup-cdk.test.ts.snap @@ -11,13 +11,13 @@ exports[`ClickUpCdkConstructLibrary defaults package.json 1`] = ` "devDependencies": { "@types/jest": "*", "@types/node": "^18", - "@typescript-eslint/eslint-plugin": "^7", - "@typescript-eslint/parser": "^7", + "@typescript-eslint/eslint-plugin": "^8", + "@typescript-eslint/parser": "^8", "aws-cdk-lib": "2.138.0", "commit-and-tag-version": "^12", "constructs": "10.0.5", "esbuild": "*", - "eslint": "^8", + "eslint": "^9", "eslint-config-prettier": "*", "eslint-import-resolver-typescript": "*", "eslint-plugin-import": "*", @@ -529,12 +529,12 @@ exports[`ClickUpCdkTypeScriptApp defaults package.json 1`] = ` "devDependencies": { "@types/jest": "*", "@types/node": "^18", - "@typescript-eslint/eslint-plugin": "^7", - "@typescript-eslint/parser": "^7", + "@typescript-eslint/eslint-plugin": "^8", + "@typescript-eslint/parser": "^8", "aws-cdk": "^2.138.0", "commit-and-tag-version": "^12", "esbuild": "*", - "eslint": "^8", + "eslint": "^9", "eslint-config-prettier": "*", "eslint-import-resolver-typescript": "*", "eslint-plugin-import": "*", @@ -996,12 +996,12 @@ exports[`ClickUpCdkTypeScriptApp options node20 package.json 1`] = ` "devDependencies": { "@types/jest": "*", "@types/node": "^20", - "@typescript-eslint/eslint-plugin": "^7", - "@typescript-eslint/parser": "^7", + "@typescript-eslint/eslint-plugin": "^8", + "@typescript-eslint/parser": "^8", "aws-cdk": "^2.138.0", "commit-and-tag-version": "^12", "esbuild": "*", - "eslint": "^8", + "eslint": "^9", "eslint-config-prettier": "*", "eslint-import-resolver-typescript": "*", "eslint-plugin-import": "*", @@ -1123,12 +1123,12 @@ exports[`cdk-diff additions - ClickUpCdkTypeScriptApp package.json 1`] = ` "@time-loop/cdk-log-parser": "*", "@types/jest": "*", "@types/node": "^18", - "@typescript-eslint/eslint-plugin": "^7", - "@typescript-eslint/parser": "^7", + "@typescript-eslint/eslint-plugin": "^8", + "@typescript-eslint/parser": "^8", "aws-cdk": "^2.138.0", "commit-and-tag-version": "^12", "esbuild": "*", - "eslint": "^8", + "eslint": "^9", "eslint-config-prettier": "*", "eslint-import-resolver-typescript": "*", "eslint-plugin-import": "*", diff --git a/test/__snapshots__/clickup-ts.test.ts.snap b/test/__snapshots__/clickup-ts.test.ts.snap index e9de79c..fa9228e 100644 --- a/test/__snapshots__/clickup-ts.test.ts.snap +++ b/test/__snapshots__/clickup-ts.test.ts.snap @@ -238,12 +238,12 @@ exports[`ClickUpTypeScriptProject defaults package.json 1`] = ` "devDependencies": { "@types/jest": "*", "@types/node": "^18", - "@typescript-eslint/eslint-plugin": "^7", - "@typescript-eslint/parser": "^7", + "@typescript-eslint/eslint-plugin": "^8", + "@typescript-eslint/parser": "^8", "commit-and-tag-version": "^12", "constructs": "^10.0.0", "esbuild": "*", - "eslint": "^8", + "eslint": "^9", "eslint-config-prettier": "*", "eslint-import-resolver-typescript": "*", "eslint-plugin-import": "*",