relizy / ChangelogOptions

Interface: ChangelogOptions

Defined in: src/types.ts:195

Extends

• ChangelogConfig

Properties

bumpedPackages?

optional bumpedPackages: PackageInfo[]

Defined in: src/types.ts:215

Bumped packages

Default

undefined

---

config?

optional config: ResolvedRelizyConfig

Defined in: src/types.ts:220

Use custom config

Default

undefined

---

configName?

optional configName: string

Defined in: src/types.ts:230

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

Default

'relizy'

---

dryRun?

optional dryRun: boolean

Defined in: src/types.ts:210

Run without side effects

Default

false

---

formatCmd?

optional formatCmd: string

Defined in: src/types.ts:183

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

Default

undefined

Inherited from

ChangelogConfig.formatCmd

---

from?

optional from: string

Defined in: src/types.ts:200

Start tag

Default

undefined

---

includeCommitBody?

optional includeCommitBody: boolean

Defined in: src/types.ts:193

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

Set log level

Default

undefined

---

rootChangelog?

optional rootChangelog: boolean

Defined in: src/types.ts:188

Generate changelog at root level with all changes

Default

true

Inherited from

ChangelogConfig.rootChangelog

---

to?

optional to: string

Defined in: src/types.ts:205

End tag

Default

undefined