Skip to content

relizy / TemplatesConfig

Interface: TemplatesConfig ​

Defined in: src/types.ts:1152

Properties ​

changelogTitle? ​

optional changelogTitle?: string

Defined in: src/types.ts:1210

Changelog section title template Available variables: , ,

Default ​

ts
'{{oldVersion}}...{{newVersion}}'

commitBody? ​

optional commitBody?: string

Defined in: src/types.ts:1175

Commit message body template. When defined, it is passed as the commit body.

Default in unified/selective modes: undefined (no body). Default in independent mode (when commitMessage and commitBody are not customized): ''.

Same variables as commitMessage.


commitMessage? ​

optional commitMessage?: string

Defined in: src/types.ts:1166

Commit message template (title).

Default in unified/selective modes: 'chore(release): bump version to '. Default in independent mode (when not customized): 'chore(release): bump packages'.

Available variables:

  • — in independent mode, comma-separated list of bumped name@version (legacy behavior); otherwise the new version.
  • — number of bumped packages.
  • — comma-separated list of bumped package names.
  • — comma-separated list of bumped name@version.
  • — version from the root package.json.

emptyChangelogContent? ​

optional emptyChangelogContent?: string

Defined in: src/types.ts:1192

Empty changelog content

Default ​

ts
'No relevant changes for this release'

slackMessage? ​

optional slackMessage?: string

Defined in: src/types.ts:1204

Slack message template (optional - if not provided, uses rich blocks format) Available variables: , , , ,

Default ​

ts
undefined

tagBody? ​

optional tagBody?: string

Defined in: src/types.ts:1187

Not used with "independent" version mode

Default ​

ts
'v{{newVersion}}'
Available variables: {{newVersion}}

tagMessage? ​

optional tagMessage?: string

Defined in: src/types.ts:1181

Tag message template

Default ​

ts
'Bump version to {{newVersion}}'
Available variables: {{newVersion}}

twitterMessage? ​

optional twitterMessage?: string

Defined in: src/types.ts:1198

Twitter message template Available variables: , , , ,

Default ​

ts
'📣 {{projectName}} {{newVersion}} is out!\n\n{{changelog}}\n\n{{releaseUrl}}\n{{changelogUrl}}'

Released under the MIT License.