Skip to content

relizy / RelizyConfig

Interface: RelizyConfig

Defined in: src/types.ts:553

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

Bump config


changelog?

optional changelog: ChangelogConfig

Defined in: src/types.ts:595

Changelog config


cwd?

optional cwd: string

Defined in: src/types.ts:563

Current working directory

Default

ts
process.cwd()

Overrides

Partial.cwd


excludeAuthors?

optional excludeAuthors: string[]

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

Inherited from

Partial.excludeAuthors


from?

optional from: string

Defined in: src/types.ts:567

Start tag

Overrides

Partial.from


hideAuthorEmail?

optional hideAuthorEmail: boolean

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

Inherited from

Partial.hideAuthorEmail


hooks?

optional hooks: HookConfig

Defined in: src/types.ts:607

Hooks config


logLevel?

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

Defined in: src/types.ts:612

Set log level

Default

ts
'default'

monorepo?

optional monorepo: MonorepoConfig

Defined in: src/types.ts:575

Monorepo config


newVersion?

optional newVersion: string

Defined in: node_modules/.pnpm/changelogen@0.6.2_magicast@0.5.1/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.1/node_modules/changelogen/dist/index.d.mts:46

Inherited from

Partial.noAuthors


publish?

optional publish: PublishConfig

Defined in: src/types.ts:591

Publish config


release?

optional release: ReleaseConfig

Defined in: src/types.ts:599

Release config


repo?

optional repo: RepoConfig

Defined in: src/types.ts:579

Repo config

Overrides

Partial.repo


safetyCheck?

optional safetyCheck: boolean

Defined in: src/types.ts:617

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

Default

ts
true

scopeMap?

optional scopeMap: Record<string, string>

Defined in: node_modules/.pnpm/changelogen@0.6.2_magicast@0.5.1/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.1/node_modules/changelogen/dist/index.d.mts:34

Inherited from

Partial.signTags


templates?

optional templates: TemplatesConfig

Defined in: src/types.ts:583

Templates config


to?

optional to: string

Defined in: src/types.ts:571

End tag

Overrides

Partial.to


tokens?

optional tokens: TokensConfig

Defined in: src/types.ts:603

Tokens config


types?

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

Defined in: src/types.ts:554

Released under the MIT License.