relizy / RelizyConfig

Interface: RelizyConfig

Defined in: src/types.ts:920

Relizy configuration

See

https://louismazel.github.io/relizy/config/overview

Extends

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

Properties

bump?

optional bump: BumpConfig

Defined in: src/types.ts:960

Bump config

---

changelog?

optional changelog: ChangelogConfig

Defined in: src/types.ts:968

Changelog config

---

cwd?

optional cwd: string

Defined in: src/types.ts:936

Current working directory

Default

process.cwd()

Overrides

Partial.cwd

---

excludeAuthors?

optional excludeAuthors: string[]

Defined in: node_modules/.pnpm/changelogen@0.6.2_magicast@0.5.2/node_modules/changelogen/dist/index.d.mts:47

Inherited from

Partial.excludeAuthors

---

from?

optional from: string

Defined in: src/types.ts:940

Start tag

Overrides

Partial.from

---

hideAuthorEmail?

optional hideAuthorEmail: boolean

Defined in: node_modules/.pnpm/changelogen@0.6.2_magicast@0.5.2/node_modules/changelogen/dist/index.d.mts:48

Inherited from

Partial.hideAuthorEmail

---

hooks?

optional hooks: HookConfig

Defined in: src/types.ts:988

Hooks config

---

logLevel?

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

Defined in: src/types.ts:993

Set log level

Default

'default'

---

monorepo?

optional monorepo: MonorepoConfig

Defined in: src/types.ts:948

Monorepo config

---

newVersion?

optional newVersion: string

Defined in: node_modules/.pnpm/changelogen@0.6.2_magicast@0.5.2/node_modules/changelogen/dist/index.d.mts:33

Inherited from

Partial.newVersion

---

noAuthors?

optional noAuthors: boolean

Defined in: node_modules/.pnpm/changelogen@0.6.2_magicast@0.5.2/node_modules/changelogen/dist/index.d.mts:46

Inherited from

Partial.noAuthors

---

prComment?

optional prComment: PrCommentConfig

Defined in: src/types.ts:980

PR comment configuration

---

projectName?

optional projectName: string

Defined in: src/types.ts:925

Project name Useful for tweet and slack posts

---

publish?

optional publish: PublishConfig

Defined in: src/types.ts:964

Publish config

---

release?

optional release: ReleaseConfig

Defined in: src/types.ts:972

Release config

---

repo?

optional repo: RepoConfig

Defined in: src/types.ts:952

Repo config

Overrides

Partial.repo

---

safetyCheck?

optional safetyCheck: boolean

Defined in: src/types.ts:998

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/changelogen@0.6.2_magicast@0.5.2/node_modules/changelogen/dist/index.d.mts:28

Inherited from

Partial.scopeMap

---

signTags?

optional signTags: boolean

Defined in: node_modules/.pnpm/changelogen@0.6.2_magicast@0.5.2/node_modules/changelogen/dist/index.d.mts:34

Inherited from

Partial.signTags

---

social?

optional social: SocialConfig

Defined in: src/types.ts:976

Social media configuration

---

templates?

optional templates: TemplatesConfig

Defined in: src/types.ts:956

Templates config

---

to?

optional to: string

Defined in: src/types.ts:944

End tag

Overrides

Partial.to

---

tokens?

optional tokens: TokensConfig

Defined in: src/types.ts:984

API tokens configuration

---

types?

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

Defined in: src/types.ts:927