relizy / BumpConfig

Interface: BumpConfig

Defined in: src/types.ts:246

Extended by

• BumpOptions
• ReleaseOptions

Properties

capZeroMajor?

optional capZeroMajor?: boolean

Defined in: src/types.ts:282

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

true

---

clean?

optional clean?: boolean

Defined in: src/types.ts:260

Check if there are any changes to commit before bumping.

Default

true

---

dependencyTypes?

optional dependencyTypes?: ("dependencies" | "peerDependencies" | "devDependencies")[]

Defined in: src/types.ts:265

Include dependencies when bumping.

Default

['dependencies']

---

preid?

optional preid?: string

Defined in: src/types.ts:255

Prerelease identifier (e.g. 'beta', 'alpha')

---

type?

optional type?: ReleaseType

Defined in: src/types.ts:251

Release type (e.g. 'major', 'minor', 'patch', 'prerelease', 'prepatch', 'preminor', 'premajor')

Default

'release'

---

yes?

optional yes?: boolean

Defined in: src/types.ts:270

Skip confirmation prompt about bumping packages

Default

true