relizy / BumpOptions

Interface: BumpOptions

Defined in: src/types.ts:145

Extends

• BumpConfig

Properties

clean?

optional clean: boolean

Defined in: src/types.ts:132

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:155

Use custom config

Default

undefined

---

configName?

optional configName: string

Defined in: src/types.ts:170

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:137

Include dependencies when bumping.

Default

['dependencies']

Inherited from

BumpConfig.dependencyTypes

---

dryRun?

optional dryRun: boolean

Defined in: src/types.ts:150

Run without side effects

Default

false

---

force?

optional force: boolean

Defined in: src/types.ts:165

Bump all packages even if there are no commits

Default

false

---

logLevel?

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

Defined in: src/types.ts:160

Set log level

Default

undefined

---

preid?

optional preid: string

Defined in: src/types.ts:127

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

Default

undefined

Inherited from

BumpConfig.preid

---

suffix?

optional suffix: string

Defined in: src/types.ts:175

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

Default

undefined

---

type?

optional type: ReleaseType

Defined in: src/types.ts:122

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:142

Skip confirmation prompt about bumping packages

Default

true

Inherited from

BumpConfig.yes