relizy / ChangelogOptions

Interface: ChangelogOptions

Defined in: src/types.ts:263

Extends

• ChangelogConfig

Properties

bumpResult?

optional bumpResult: BumpResultTruthy

Defined in: src/types.ts:280

Bump result

---

config?

optional config: ResolvedRelizyConfig

Defined in: src/types.ts:284

Use custom config

---

configName?

optional configName: string

Defined in: src/types.ts:293

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

Default

'relizy'

---

dryRun?

optional dryRun: boolean

Defined in: src/types.ts:276

Run without side effects

Default

false

---

force

force: boolean

Defined in: src/types.ts:298

Generate changelog for all packages even if there are no commits

Default

false

---

formatCmd?

optional formatCmd: string

Defined in: src/types.ts:251

Command to format the changelog (e.g. prettier --write CHANGELOG.md).

Inherited from

ChangelogConfig.formatCmd

---

from?

optional from: string

Defined in: src/types.ts:267

Start tag

---

includeCommitBody?

optional includeCommitBody: boolean

Defined in: src/types.ts:261

Include commit body in the changelog.

Default

true

Inherited from

ChangelogConfig.includeCommitBody

---

logLevel?

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

Defined in: src/types.ts:288

Set log level

---

rootChangelog?

optional rootChangelog: boolean

Defined in: src/types.ts:256

Generate changelog at root level with all changes

Default

true

Inherited from

ChangelogConfig.rootChangelog

---

suffix?

optional suffix: string

Defined in: src/types.ts:302

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

---

to?

optional to: string

Defined in: src/types.ts:271

End tag