relizy / loadRelizyConfig

Function: loadRelizyConfig()

loadRelizyConfig(options?): Promise<ResolvedRelizyConfig>

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

Parameters

options?

baseConfig?

ResolvedRelizyConfig

configName?

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; 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; packages?: (string | undefined)[]; private?: boolean; registry?: string; tag?: string; }; release?: { changelog?: boolean; clean?: boolean; commit?: boolean; noVerify?: boolean; providerRelease?: boolean; publish?: boolean; push?: boolean; }; repo?: { domain?: string; provider?: GitProvider; repo?: string; token?: string; }; scopeMap?: {[key: string]: string | undefined; }; signTags?: boolean; templates?: { commitMessage?: string; emptyChangelogContent?: string; tagBody?: string; tagMessage?: string; }; to?: string; tokens?: { bitbucket?: string; github?: string; gitlab?: string; }; types?: {[key: string]: boolean | { semver?: SemverBumpType; title?: string; } | undefined; }; }

overrides.bump?

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

Default

undefined

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')

Default

undefined

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; }

Default

undefined

overrides.changelog.formatCmd?

string

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

Default

undefined

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

Default

undefined

overrides.hideAuthorEmail?

boolean

overrides.logLevel?

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

Default

undefined

overrides.monorepo?

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

Default

undefined

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; packages?: (string | undefined)[]; private?: boolean; registry?: string; tag?: string; }

Default

undefined

overrides.publish.access?

"public" | "restricted"

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

Default

undefined

overrides.publish.args?

(string | undefined)[]

overrides.publish.buildCmd?

string

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

Default

undefined

overrides.publish.otp?

string

NPM OTP (e.g. 123456)

Default

undefined

overrides.publish.packages?

(string | undefined)[]

Glob pattern matching for packages to publish

Default

undefined

overrides.publish.private?

boolean

overrides.publish.registry?

string

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

Default

undefined

overrides.publish.tag?

string

NPM tag (e.g. latest)

Default

undefined

overrides.release?

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

Default

undefined

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.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; }

Default

undefined

overrides.repo.domain?

string

Git domain (e.g. github.com)

Default

undefined

overrides.repo.provider?

GitProvider

Git provider (e.g. github or gitlab)

Default

'github'

overrides.repo.repo?

string

Git repository (e.g. user/repo)

Default

undefined

overrides.repo.token?

string

Git token

Default

undefined

overrides.scopeMap?

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

overrides.signTags?

boolean

overrides.templates?

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

Default

undefined

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

Default

undefined

overrides.tokens?

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

overrides.tokens.bitbucket?

string

overrides.tokens.github?

string

overrides.tokens.gitlab?

string

overrides.types?

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

Returns

Promise<ResolvedRelizyConfig>