Changelog Configuration

Customize changelog generation.

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({
  github: 'user/repo',
  // or
  gitlab: 'user/repo',
})

Complete Example

import { defineConfig } from 'relizy'

export default defineConfig({
  types: {
    feat: { title: '✨ Features', semver: 'minor' },
    fix: { title: '🐛 Fixes', semver: 'patch' },
  },
  excludeAuthors: ['dependabot[bot]'],
  github: 'myorg/myrepo',
  output: 'CHANGELOG.md',
})