Changelog Configuration

Customize changelog generation.

Changelog Config Options

formatCmd

Command to format the changelog after generation (e.g., with Prettier):

import { defineConfig } from 'relizy'

export default defineConfig({
  changelog: {
    formatCmd: 'prettier --write CHANGELOG.md',
  },
})

rootChangelog

Generate a changelog at root level that contains all changes from all packages:

• Type: boolean
• Default: true

import { defineConfig } from 'relizy'

export default defineConfig({
  changelog: {
    rootChangelog: true,
  },
})

includeCommitBody

Include the commit body in the changelog entries:

• Type: boolean
• Default: true

import { defineConfig } from 'relizy'

export default defineConfig({
  changelog: {
    includeCommitBody: true,
  },
})

Complete Changelog Config Example

import { defineConfig } from 'relizy'

export default defineConfig({
  changelog: {
    formatCmd: 'prettier --write CHANGELOG.md',
    rootChangelog: true,
    includeCommitBody: true,
  },
})

Commit Types

Customize how commit types appear in changelogs:

import { defineConfig } from 'relizy'

export default defineConfig({
  types: {
    feat: { title: '🎉 New Features', semver: 'minor' },
    fix: { title: '🔧 Bug Fixes', semver: 'patch' },
    perf: { title: '⚡ Performance', semver: 'patch' },
    docs: { title: '📖 Documentation', semver: 'patch' },
    style: { title: '💄 Styling', semver: 'patch' },
    refactor: { title: '🔨 Refactors', semver: 'patch' },
    test: { title: '🧪 Tests' },
    ci: { title: '🤖 CI/CD' },
    chore: { title: '🧹 Chores' },
    build: false,
  },
})

Exclude Authors

Filter out commits from specific authors:

import { defineConfig } from 'relizy'

export default defineConfig({
  excludeAuthors: [
    'dependabot[bot]',
    'renovate[bot]',
    'github-actions[bot]',
  ],
})

Repository URLs

Set custom GitHub/GitLab URLs:

import { defineConfig } from 'relizy'

export default defineConfig({
  repo: {
    domain: 'github.com',
    repo: 'user/repo',
    provider: 'github',
    token: process.env.GITHUB_TOKEN,
  },
})

Complete Example

import { defineConfig } from 'relizy'

export default defineConfig({
  types: {
    feat: { title: '✨ Features', semver: 'minor' },
    fix: { title: '🐛 Fixes', semver: 'patch' },
  },
  excludeAuthors: ['dependabot[bot]'],
  repo: {
    domain: 'github.com',
    repo: 'user/repo',
    provider: 'github',
    token: process.env.GITHUB_TOKEN,
  },
})