projen

import { IConstruct } from "constructs"; import { Component } from "./component"; import { Task } from "./task"; /** * This command determines if there were any changes since the last release in a cross-platform compatible way. * It is used as a condition for both the `bump` and the `release` tasks. * * Explanation: * - log commits | git log * - limit log output to a single line per commit | --oneline * - looks only at the most recent commit | -1 * - silent grep output | grep -q * - exits with code 0 if a match is found | grep -q "chore(release):" * - exits with code 1 if a match is found (reverse-match) | grep -qv "chore(release):" */ export declare const CHANGES_SINCE_LAST_RELEASE = "git log --oneline -1 | grep -qv \"chore(release):\""; /** * Options for `Version`. */ export interface VersionOptions { /** * A name of a .json file to set the `version` field in after a bump. * * @example "package.json" */ readonly versionInputFile: string; /** * The name of the directory into which `changelog.md` and `version.txt` files * are emitted. */ readonly artifactsDirectory: string; /** * Custom configuration for versionrc file used by standard-release */ readonly versionrcOptions?: Record<string, any>; /** * The tag prefix corresponding to this version. */ readonly tagPrefix?: string; /** * Find commits that should be considered releasable * Used to decide if a release is required. * * @default ReleasableCommits.everyCommit() */ readonly releasableCommits?: ReleasableCommits; /** * 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`. * * @default "commit-and-tag-version@12" */ readonly bumpPackage?: string; /** * 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. * - `$SUGGESTED_BUMP`: the suggested bump action based on commits. One of `major|minor|patch|none`. * * 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. * * @default - The next version will be determined based on the commit history and project settings. */ readonly nextVersionCommand?: string; } export declare class Version extends Component { /** * @deprecated use `version.bumpPackage` on the component instance instead */ static readonly STANDARD_VERSION = "commit-and-tag-version@^12"; readonly bumpTask: Task; readonly unbumpTask: Task; /** * The name of the changelog file (under `artifactsDirectory`). */ readonly changelogFileName: string; /** * The name of the file that contains the version (under `artifactsDirectory`). */ readonly versionFileName: string; /** * The name of the file that contains the release tag (under `artifactsDirectory`). */ readonly releaseTagFileName: string; /** * The package used to bump package versions, as a dependency string. * This is a `commit-and-tag-version` compatible package. */ readonly bumpPackage: string; private readonly nextVersionCommand?; constructor(scope: IConstruct, options: VersionOptions); /** * Return the environment variables to modify the bump command for release branches. * * These options are used to modify the behavior of the version bumping script * for additional branches, by setting environment variables. * * No settings are inherited from the base `Version` object (but any parameters that * control versions do conflict with the use of a `nextVersionCommand`). */ envForBranch(branchOptions: VersionBranchOptions): Record<string, string>; } /** * Options to pass to `modifyBranchEnvironment` */ export interface VersionBranchOptions { /** * The major versions released from this branch. */ readonly majorVersion?: number; /** * The minimum major version to release. */ readonly minMajorVersion?: number; /** * The minor versions released from this branch. */ readonly minorVersion?: number; /** * Bump the version as a pre-release tag. * * @default - normal releases */ readonly prerelease?: string; /** * Automatically add the given prefix to release tags. * Useful if you are releasing on multiple branches with overlapping * version numbers. * * Note: this prefix is used to detect the latest tagged version * when bumping, so if you change this on a project with an existing version * history, you may need to manually tag your latest release * with the new prefix. * * @default - no prefix */ readonly tagPrefix?: string; } /** * Find commits that should be considered releasable to decide if a release is required. * * This setting only controls whether a release is triggered, yes or no. The * paths used here are independent of the code that controls what commits are inspected * to determine the version number. */ export declare class ReleasableCommits { cmd: string; /** * Release every commit * * This will only not release if the most recent commit is tagged with the latest matching tag. * * @param path Consider only commits that are enough to explain how the files that match the specified paths came to be. * This path is relative to the current working dir of the `bump` task, i.e. to only consider commits of a subproject use `"."`. */ static everyCommit(path?: string): ReleasableCommits; /** * Limit commits by their conventional commit type * * This will only release commit that match one of the provided types. * Commits are required to follow the conventional commit spec and will be ignored otherwise. * * @param types List of conventional commit types that should be released * @param path Consider only commits that are enough to explain how the files that match the specified paths came to be. * This path is relative to the current working dir of the `bump` task, i.e. to only consider commits of a subproject use `"."`. */ static ofType(types: string[], path?: string): ReleasableCommits; /** * Release only features and fixes * * Shorthand for `ReleasableCommits.onlyOfType(['feat', 'fix'])`. * * @param path Consider only commits that are enough to explain how the files that match the specified paths came to be. * This path is relative to the current working dir of the `bump` task, i.e. to only consider commits of a subproject use `"."`. */ static featuresAndFixes(path?: string): ReleasableCommits; /** * Use an arbitrary shell command to find releasable commits since the latest tag. * * A new release will be initiated, if the number of returned commits is greater than zero. * Must return a newline separate list of commits that should considered releasable. * `$LATEST_TAG` will be replaced with the actual latest tag for the given prefix.* * * @example "git log --oneline $LATEST_TAG..HEAD -- ." */ static exec(cmd: string): ReleasableCommits; private constructor(); }