Skip to content

relizy / getDefaultConfig

Function: getDefaultConfig() ​

getDefaultConfig(): object

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

Returns ​

object

ai ​

ai: AIConfig

bump ​

bump: Required<Omit<BumpConfig, "preid">>

changelog ​

changelog: Required<ChangelogConfig>

cwd ​

cwd: string

detectRewrittenTags ​

detectRewrittenTags: boolean = true

excludeAuthors ​

excludeAuthors: never[] = []

logLevel ​

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

monorepo ​

monorepo: MonorepoConfig

noAuthors ​

noAuthors: boolean = false

prComment ​

prComment: Required<PrCommentConfig>

publish ​

publish: object

publish.args ​

args: never[] = []

publish.packageManager ​

packageManager: PackageManager

publish.private ​

private: false = false

publish.safetyCheck ​

safetyCheck: true = true

publish.safetyCheckTimeout ​

safetyCheckTimeout: number = 15000

publish.skipExistingVersions ​

skipExistingVersions: boolean

publish.token ​

token: string | undefined

release ​

release: Required<ReleaseConfig>

safetyCheck ​

safetyCheck: boolean = true

scopeMap ​

scopeMap: object = {}

social ​

social: object

social.slack ​

slack: object

social.slack.enabled ​

enabled: boolean = false

social.slack.noAuthors ​

noAuthors: boolean = false

social.slack.noPackages ​

noPackages: boolean = false

social.slack.onlyStable ​

onlyStable: boolean = true

social.slack.postMaxLength ​

postMaxLength: number = 2500

social.twitter ​

twitter: object

social.twitter.enabled ​

enabled: false = false

social.twitter.onlyStable ​

onlyStable: true = true

social.twitter.postMaxLength ​

postMaxLength: number = 280

templates ​

templates: object

templates.changelogTitle ​

changelogTitle: string = '...'

templates.commitBody ​

commitBody: string | undefined

templates.commitMessage ​

commitMessage: string | undefined

templates.emptyChangelogContent ​

emptyChangelogContent: string = 'No relevant changes for this release'

templates.slackMessage ​

slackMessage: undefined = undefined

templates.tagBody ​

tagBody: string = 'v'

templates.tagMessage ​

tagMessage: string = 'Bump version to '

templates.twitterMessage ​

twitterMessage: string = '📣 is out!\n\n\n\n\n'

tokens ​

tokens: object

tokens.ai ​

ai: object

tokens.ai.claude-code ​

claude-code: object

tokens.ai.claude-code.apiKey ​

apiKey: string | undefined

tokens.ai.claude-code.oauthToken ​

oauthToken: string | undefined

tokens.github ​

github: string | undefined

tokens.gitlab ​

gitlab: string | undefined

tokens.registry ​

registry: string | undefined

tokens.slack ​

slack: string | undefined

tokens.twitter ​

twitter: object

tokens.twitter.accessToken ​

accessToken: string | undefined

tokens.twitter.accessTokenSecret ​

accessTokenSecret: string | undefined

tokens.twitter.apiKey ​

apiKey: string | undefined

tokens.twitter.apiKeySecret ​

apiKeySecret: string | undefined

types ​

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

Released under the MIT License.