relizy / BumpOptions

Interface: BumpOptions

Defined in: src/types.ts:285

Extends

• BumpConfig

Properties

canary?

optional canary?: boolean

Defined in: src/types.ts:317

Publish a canary release from the current commit

Default

false

---

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

Inherited from

BumpConfig.capZeroMajor

---

clean?

optional clean?: boolean

Defined in: src/types.ts:260

Check if there are any changes to commit before bumping.

Default

true

Inherited from

BumpConfig.clean

---

config?

optional config?: ResolvedRelizyConfig

Defined in: src/types.ts:294

Use custom config

---

configName?

optional configName?: string

Defined in: src/types.ts:308

Custom config file name (e.g. relizy.standalone for relizy.standalone.config.ts)

Default

'relizy'

---

dependencyTypes?

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

Defined in: src/types.ts:265

Include dependencies when bumping.

Default

['dependencies']

Inherited from

BumpConfig.dependencyTypes

---

dryRun?

optional dryRun?: boolean

Defined in: src/types.ts:290

Run without side effects

Default

false

---

force?

optional force?: boolean

Defined in: src/types.ts:303

Bump all packages even if there are no commits

Default

false

---

includePrivates?

optional includePrivates?: boolean

Defined in: src/types.ts:322

Include private packages in the bump.

Default

false

---

logLevel?

optional logLevel?: "error" | "silent" | "warning" | "normal" | "default" | "debug" | "trace" | "verbose"

Defined in: src/types.ts:298

Set log level

---

preid?

optional preid?: string

Defined in: src/types.ts:255

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

Inherited from

BumpConfig.preid

---

suffix?

optional suffix?: string

Defined in: src/types.ts:312

Custom suffix for prerelease versions - replace the last .X with .suffix (e.g. 1.0.0-beta.0 -> 1.0.0-beta.suffix)

---

type?

optional type?: ReleaseType

Defined in: src/types.ts:251

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

Default

'release'

Inherited from

BumpConfig.type

---

yes?

optional yes?: boolean

Defined in: src/types.ts:270

Skip confirmation prompt about bumping packages

Default

true

Inherited from

BumpConfig.yes