relizy / BumpConfig
Interface: BumpConfig
Defined in: packages/relizy/src/types.ts:349
Extended by
Properties
capZeroMajor?
optionalcapZeroMajor?:boolean
Defined in: packages/relizy/src/types.ts:402
Cap commit-detected major bumps to minor while the current version is in the 0.x.y range (semver §4, initial development), so a breaking change does not graduate a 0.x package to 1.0.0 automatically.
Set to false to opt out: a breaking commit then bumps 0.x.y straight to 1.0.0. This only affects commit-based detection; explicit CLI release types (--major, --premajor, …) are never capped. Once the package reaches 1.x, this option is a no-op.
Default
trueclean?
optionalclean?:boolean
Defined in: packages/relizy/src/types.ts:363
Check if there are any changes to commit before bumping.
Default
truedependencyTypes?
optionaldependencyTypes?: ("dependencies"|"peerDependencies"|"devDependencies")[]
Defined in: packages/relizy/src/types.ts:373
Dependency fields whose internal dependencies bump the package (a patch): when its published range rejects their new version, or on every bump of them, see dependents.
peerDependencies is not included by default: a package is bumped only when the range of its peer dependency rejects the new version, see outOfRangePeers.
Default
['dependencies']dependents?
optionaldependents?:"always"|"out-of-range"
Defined in: packages/relizy/src/types.ts:385
When a package is bumped because of an internal dependency listed in one of the dependencyTypes fields:
out-of-range: only when the range it was published with rejects the new version of the dependency (workspace:*on every bump,workspace:^on a major, a minor in0.xor a prerelease). A specifier that is not a semver range (catalog:,link:,npm:...) counts as out of range.always: on every bump of the dependency, e.g. for a package that bundles its dependency.
Default
'out-of-range'outOfRangePeers?
optionaloutOfRangePeers?:"error"|"warn"|"bump"
Defined in: packages/relizy/src/types.ts:427
What to do with a package that is not bumped while the range of one of its peer dependencies, as published, does not accept the new version of that dependency: workspace:* is published as the exact version, so any new version is out of its range; workspace:^ only on a major, or on a prerelease (npm rejects 6.20.0-beta.0 for ^6.19.1). Its consumers would get peer dependency errors (npm) or warnings (pnpm).
bump: bump the package, so it is released with an up-to-date range: a patch, or a major when the dependency makes a breaking change. The packages outside of the release (e.g. not in the targeted--group) are reported with a warning.warn: only warn before publishing.error: fail the release before publishing.
Whatever this option, a package released while its peer dependency makes a breaking change its published range rejects is bumped as for a breaking commit (capZeroMajor applies). In unified/selective mode, a peer dependency of another version group gives that bump to the root version.
Independent of dependencyTypes, which bumps the dependents on every bump of their dependencies (or only out of range, see dependents).
Default
'bump'preid?
optionalpreid?:string
Defined in: packages/relizy/src/types.ts:358
Prerelease identifier (e.g. 'beta', 'alpha')
type?
optionaltype?:BumpReleaseType
Defined in: packages/relizy/src/types.ts:354
Release type (e.g. 'major', 'minor', 'patch', 'prerelease', 'prepatch', 'preminor', 'premajor')
Default
'release'yes?
optionalyes?:boolean
Defined in: packages/relizy/src/types.ts:390
Skip confirmation prompt about bumping packages
Default
false