relizy / loadRelizyConfig

Function: loadRelizyConfig()

loadRelizyConfig(options?): Promise<ResolvedRelizyConfig>

Defined in: src/core/config.ts:113

Parameters

options?

baseConfig?

ResolvedRelizyConfig

configFile?

string

overrides?

{ bump?: { clean?: boolean; dependencyTypes?: ("dependencies" | "peerDependencies" | "devDependencies" | undefined)[]; preid?: string; type?: ReleaseType; yes?: boolean; }; changelog?: { formatCmd?: string; includeCommitBody?: boolean; rootChangelog?: boolean; }; cwd?: string; excludeAuthors?: (string | undefined)[]; from?: string; hideAuthorEmail?: boolean; hooks?: { before:bump?: string | { }; before:changelog?: string | { }; before:commit-and-tag?: string | { }; before:provider-release?: string | { }; before:publish?: string | { }; before:push?: string | { }; before:release?: string | { }; error:bump?: string | { }; error:changelog?: string | { }; error:commit-and-tag?: string | { }; error:provider-release?: string | { }; error:publish?: string | { }; error:push?: string | { }; error:release?: string | { }; generate:changelog?: { }; success:bump?: string | { }; success:changelog?: string | { }; success:commit-and-tag?: string | { }; success:provider-release?: string | { }; success:publish?: string | { }; success:push?: string | { }; success:release?: string | { }; }; logLevel?: "error" | "default" | "silent" | "warning" | "normal" | "debug" | "trace" | "verbose"; monorepo?: { ignorePackageNames?: (string | undefined)[]; packages?: (string | undefined)[]; versionMode?: VersionMode; }; newVersion?: string; noAuthors?: boolean; publish?: { access?: "public" | "restricted"; args?: (string | undefined)[]; buildCmd?: string; otp?: string; packageManager?: PackageManager; packages?: (string | undefined)[]; private?: boolean; registry?: string; safetyCheck?: boolean; tag?: string; token?: string; }; release?: { changelog?: boolean; clean?: boolean; commit?: boolean; gitTag?: boolean; noVerify?: boolean; providerRelease?: boolean; publish?: boolean; push?: boolean; }; repo?: { domain?: string; provider?: GitProvider; repo?: string; token?: string; }; safetyCheck?: boolean; scopeMap?: {[key: string]: string | undefined; }; signTags?: boolean; templates?: { commitMessage?: string; emptyChangelogContent?: string; tagBody?: string; tagMessage?: string; }; to?: string; tokens?: { github?: string; gitlab?: string; registry?: string; }; types?: {[key: string]: false | { semver?: SemverBumpType; title?: string; } | undefined; }; }

overrides.bump?

{ clean?: boolean; dependencyTypes?: ("dependencies" | "peerDependencies" | "devDependencies" | undefined)[]; preid?: string; type?: ReleaseType; yes?: boolean; }

Bump config

overrides.bump.clean?

boolean

Check if there are any changes to commit before bumping.

Default

true

overrides.bump.dependencyTypes?

("dependencies" | "peerDependencies" | "devDependencies" | undefined)[]

Include dependencies when bumping.

Default

['dependencies']

overrides.bump.preid?

string

Prerelease identifier (e.g. 'beta', 'alpha')

overrides.bump.type?

ReleaseType

Release type (e.g. 'major', 'minor', 'patch', 'prerelease', 'prepatch', 'preminor', 'premajor')

Default

'release'

overrides.bump.yes?

boolean

Skip confirmation prompt about bumping packages

Default

true

overrides.changelog?

{ formatCmd?: string; includeCommitBody?: boolean; rootChangelog?: boolean; }

Changelog config

overrides.changelog.formatCmd?

string

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

overrides.changelog.includeCommitBody?

boolean

Include commit body in the changelog.

Default

true

overrides.changelog.rootChangelog?

boolean

Generate changelog at root level with all changes

Default

true

overrides.cwd?

string

Current working directory

Default

process.cwd()

overrides.excludeAuthors?

(string | undefined)[]

overrides.from?

string

Start tag

overrides.hideAuthorEmail?

boolean

overrides.hooks?

{ before:bump?: string | { }; before:changelog?: string | { }; before:commit-and-tag?: string | { }; before:provider-release?: string | { }; before:publish?: string | { }; before:push?: string | { }; before:release?: string | { }; error:bump?: string | { }; error:changelog?: string | { }; error:commit-and-tag?: string | { }; error:provider-release?: string | { }; error:publish?: string | { }; error:push?: string | { }; error:release?: string | { }; generate:changelog?: { }; success:bump?: string | { }; success:changelog?: string | { }; success:commit-and-tag?: string | { }; success:provider-release?: string | { }; success:publish?: string | { }; success:push?: string | { }; success:release?: string | { }; }

Hooks config

overrides.hooks.before:bump?

string | { }

overrides.hooks.before:changelog?

string | { }

overrides.hooks.before:commit-and-tag?

string | { }

overrides.hooks.before:provider-release?

string | { }

overrides.hooks.before:publish?

string | { }

overrides.hooks.before:push?

string | { }

overrides.hooks.before:release?

string | { }

overrides.hooks.error:bump?

string | { }

overrides.hooks.error:changelog?

string | { }

overrides.hooks.error:commit-and-tag?

string | { }

overrides.hooks.error:provider-release?

string | { }

overrides.hooks.error:publish?

string | { }

overrides.hooks.error:push?

string | { }

overrides.hooks.error:release?

string | { }

overrides.hooks.generate:changelog?

{ }

overrides.hooks.success:bump?

string | { }

overrides.hooks.success:changelog?

string | { }

overrides.hooks.success:commit-and-tag?

string | { }

overrides.hooks.success:provider-release?

string | { }

overrides.hooks.success:publish?

string | { }

overrides.hooks.success:push?

string | { }

overrides.hooks.success:release?

string | { }

overrides.logLevel?

"error" | "default" | "silent" | "warning" | "normal" | "debug" | "trace" | "verbose"

Set log level

Default

'default'

overrides.monorepo?

{ ignorePackageNames?: (string | undefined)[]; packages?: (string | undefined)[]; versionMode?: VersionMode; }

Monorepo config

overrides.monorepo.ignorePackageNames?

(string | undefined)[]

Package names to ignore.

Default

[]

overrides.monorepo.packages?

(string | undefined)[]

Glob pattern matching for packages to bump.

overrides.monorepo.versionMode?

VersionMode

Version mode for the monorepo.

overrides.newVersion?

string

overrides.noAuthors?

boolean

overrides.publish?

{ access?: "public" | "restricted"; args?: (string | undefined)[]; buildCmd?: string; otp?: string; packageManager?: PackageManager; packages?: (string | undefined)[]; private?: boolean; registry?: string; safetyCheck?: boolean; tag?: string; token?: string; }

Publish config

overrides.publish.access?

"public" | "restricted"

NPM access level (e.g. public or restricted)

overrides.publish.args?

(string | undefined)[]

overrides.publish.buildCmd?

string

Command to build your packages before publishing (e.g. pnpm build)

overrides.publish.otp?

string

NPM OTP (e.g. 123456)

overrides.publish.packageManager?

PackageManager

Package manager (e.g. pnpm, npm, yarn or bun)

overrides.publish.packages?

(string | undefined)[]

Glob pattern matching for packages to publish

overrides.publish.private?

boolean

overrides.publish.registry?

string

NPM registry URL (e.g. https://registry.npmjs.org/)

overrides.publish.safetyCheck?

boolean

Skip safety check

Default

false

overrides.publish.tag?

string

NPM tag (e.g. latest)

overrides.publish.token?

string

NPM token (e.g. 123456) - only supported for pnpm and npm

overrides.release?

{ changelog?: boolean; clean?: boolean; commit?: boolean; gitTag?: boolean; noVerify?: boolean; providerRelease?: boolean; publish?: boolean; push?: boolean; }

Release config

overrides.release.changelog?

boolean

Generate changelog files (CHANGELOG.md)

Default

true

overrides.release.clean?

boolean

Determine if the working directory is clean and if it is not clean, exit

Default

false

overrides.release.commit?

boolean

Commit changes and create tag

Default

true

overrides.release.gitTag?

boolean

Create tag

Default

true

overrides.release.noVerify?

boolean

Skip git verification while committing by using --no-verify flag

Default

true

overrides.release.providerRelease?

boolean

Publish release to your repository (github or gitlab)

Default

true

overrides.release.publish?

boolean

Publish release to your registry

Default

true

overrides.release.push?

boolean

Push changes to your repository (commit and tag(s))

Default

true

overrides.repo?

{ domain?: string; provider?: GitProvider; repo?: string; token?: string; }

Repo config

overrides.repo.domain?

string

Git domain (e.g. github.com)

overrides.repo.provider?

GitProvider

Git provider (e.g. github or gitlab)

Default

'github'

overrides.repo.repo?

string

Git repository (e.g. user/repo)

overrides.repo.token?

string

Git token

overrides.safetyCheck?

boolean

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

Default

true

overrides.scopeMap?

{[key: string]: string | undefined; }

overrides.signTags?

boolean

overrides.templates?

{ commitMessage?: string; emptyChangelogContent?: string; tagBody?: string; tagMessage?: string; }

Templates config

overrides.templates.commitMessage?

string

Commit message template

overrides.templates.emptyChangelogContent?

string

Empty changelog content

overrides.templates.tagBody?

string

Not used with "independent" version mode

overrides.templates.tagMessage?

string

Tag message template

overrides.to?

string

End tag

overrides.tokens?

{ github?: string; gitlab?: string; registry?: string; }

Tokens config

overrides.tokens.github?

string

overrides.tokens.gitlab?

string

overrides.tokens.registry?

string

overrides.types?

{[key: string]: false | { semver?: SemverBumpType; title?: string; } | undefined; }

Returns

Promise<ResolvedRelizyConfig>