relizy / ChangelogOptions

Interface: ChangelogOptions

Defined in: src/types.ts:341

Extends

• ChangelogConfig

Properties

bumpResult?

optional bumpResult?: BumpResultTruthy

Defined in: src/types.ts:358

Bump result

---

config?

optional config?: ResolvedRelizyConfig

Defined in: src/types.ts:362

Use custom config

---

configName?

optional configName?: string

Defined in: src/types.ts:371

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

Default

'relizy'

---

dryRun?

optional dryRun?: boolean

Defined in: src/types.ts:354

Run without side effects

Default

false

---

force

force: boolean

Defined in: src/types.ts:376

Generate changelog for all packages even if there are no commits

Default

false

---

formatCmd?

optional formatCmd?: string

Defined in: src/types.ts:329

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

Inherited from

ChangelogConfig.formatCmd

---

from?

optional from?: string

Defined in: src/types.ts:345

Start tag

---

includeCommitBody?

optional includeCommitBody?: boolean

Defined in: src/types.ts:339

Include commit body in the changelog.

Default

true

Inherited from

ChangelogConfig.includeCommitBody

---

includePrivates?

optional includePrivates?: boolean

Defined in: src/types.ts:385

Include private packages in the changelog generation.

Default

false

---

logLevel?

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

Defined in: src/types.ts:366

Set log level

---

rootChangelog?

optional rootChangelog?: boolean

Defined in: src/types.ts:334

Generate changelog at root level with all changes

Default

true

Inherited from

ChangelogConfig.rootChangelog

---

suffix?

optional suffix?: string

Defined in: src/types.ts:380

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

End tag