relizy / RelizyConfig

Interface: RelizyConfig

Defined in: src/types.ts:1141

Extends

• Partial<Omit<IChangelogConfig, "output" | "templates" | "publish" | "types" | "tokens">>

Properties

ai?

optional ai?: AIConfig

Defined in: src/types.ts:1209

AI-powered changelog and release notes configuration

---

bump?

optional bump?: BumpConfig

Defined in: src/types.ts:1181

Bump config

---

changelog?

optional changelog?: ChangelogConfig

Defined in: src/types.ts:1189

Changelog config

---

cwd?

optional cwd?: string

Defined in: src/types.ts:1157

Current working directory

Default

process.cwd()

Overrides

Partial.cwd

---

detectRewrittenTags?

optional detectRewrittenTags?: boolean

Defined in: src/types.ts:1231

Detect when the resolved from tag points to a commit that is no longer reachable from to (typically because the history was rebased after the tag was created). When enabled, relizy explains the situation and either prompts or auto-corrects, avoiding bloated changelogs and over-bumping.

Default

true

---

excludeAuthors?

optional excludeAuthors?: string[]

Defined in: node_modules/.pnpm/[email protected][email protected]/node_modules/changelogen/dist/index.d.mts:47

Inherited from

Partial.excludeAuthors

---

from?

optional from?: string

Defined in: src/types.ts:1161

Start tag

Overrides

Partial.from

---

hideAuthorEmail?

optional hideAuthorEmail?: boolean

Defined in: node_modules/.pnpm/[email protected][email protected]/node_modules/changelogen/dist/index.d.mts:48

Inherited from

Partial.hideAuthorEmail

---

hooks?

optional hooks?: HookConfig

Defined in: src/types.ts:1213

Hooks config

---

logLevel?

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

Defined in: src/types.ts:1218

Set log level

Default

'default'

---

monorepo?

optional monorepo?: MonorepoConfig

Defined in: src/types.ts:1169

Monorepo config

---

newVersion?

optional newVersion?: string

Defined in: node_modules/.pnpm/[email protected][email protected]/node_modules/changelogen/dist/index.d.mts:33

Inherited from

Partial.newVersion

---

noAuthors?

optional noAuthors?: boolean

Defined in: node_modules/.pnpm/[email protected][email protected]/node_modules/changelogen/dist/index.d.mts:46

Inherited from

Partial.noAuthors

---

onRewrittenTag?

optional onRewrittenTag?: OnRewrittenTag

Defined in: src/types.ts:1241

Strategy applied when a rewritten/orphaned from tag is detected. Defaults to prompt interactively, or ephemeral when non-interactive (--yes / no TTY / CI).

• prompt: interactive selection.
• ephemeral: use the reachable equivalent commit for this run only.
• rebind: move the local tag onto the equivalent commit (no push).
• error: throw and stop.

---

prComment?

optional prComment?: PrCommentConfig

Defined in: src/types.ts:1201

PR comment configuration

---

projectName?

optional projectName?: string

Defined in: src/types.ts:1146

Project name Useful for tweet and slack posts

---

publish?

optional publish?: PublishConfig

Defined in: src/types.ts:1185

Publish config

---

release?

optional release?: ReleaseConfig

Defined in: src/types.ts:1193

Release config

---

repo?

optional repo?: RepoConfig

Defined in: src/types.ts:1173

Repo config

Overrides

Partial.repo

---

safetyCheck?

optional safetyCheck?: boolean

Defined in: src/types.ts:1223

Global safety check. The safety check will verify if tokens or others required for release are set (depends on the release options)

Default

true

---

scopeMap?

optional scopeMap?: Record<string, string>

Defined in: node_modules/.pnpm/[email protected][email protected]/node_modules/changelogen/dist/index.d.mts:28

Inherited from

Partial.scopeMap

---

signTags?

optional signTags?: boolean

Defined in: node_modules/.pnpm/[email protected][email protected]/node_modules/changelogen/dist/index.d.mts:34

Inherited from

Partial.signTags

---

social?

optional social?: SocialConfig

Defined in: src/types.ts:1197

Social media configuration

---

templates?

optional templates?: TemplatesConfig

Defined in: src/types.ts:1177

Templates config

---

to?

optional to?: string

Defined in: src/types.ts:1165

End tag

Overrides

Partial.to

---

tokens?

optional tokens?: TokensConfig

Defined in: src/types.ts:1205

API tokens configuration

---

types?

optional types?: Record<string, false | { semver?: SemverBumpType; title: string; }>

Defined in: src/types.ts:1148