Skip to content

Changelog Generation

Automatic release notes from your commits.

Overview

releasio generates beautiful changelogs from your commit history:

%%{init: {'theme': 'neutral'}}%%
graph LR
    A[Commits] --> B[Parse]
    B --> C[Group]
    C --> D[Format]
    D --> E[CHANGELOG.md]

Example Output

CHANGELOG.md
# Changelog

## [1.2.0] - 2024-01-15

### Features
- Add user dashboard (#42)
- Support dark mode (#45)

### Bug Fixes
- Resolve login timeout (#43)
- Fix email validation (#44)

### Documentation
- Update installation guide (#46)

Configuration

Basic Setup

.releasio.toml
[changelog]
path = "CHANGELOG.md"

Full Options

.releasio.toml
[changelog]
# Output file
path = "CHANGELOG.md"

# Show commit authors
show_authors = true

# Show commit hashes
show_commit_hash = true

# Highlight first-time contributors
show_first_time_contributors = true
first_contributor_badge = "🎉 First contribution!"

# Include dependency updates
include_dependency_updates = true

Section Headers

Customize how commits are grouped:

.releasio.toml
[changelog.section_headers]
breaking = "⚠️ Breaking Changes"
feat = "✨ Features"
fix = "🐛 Bug Fixes"
perf = "⚡ Performance"
docs = "📚 Documentation"
refactor = "♻️ Refactoring"

Default Sections

Commit Type Default Header
Breaking Breaking Changes
feat Features
fix Bug Fixes
docs Documentation
perf Performance
refactor Refactoring
test Testing
build Build
ci CI/CD

Changelog Engines

Native Generator (Default)

releasio includes a built-in changelog generator:

  • Fast and reliable
  • No external dependencies
  • Conventional commit support

git-cliff Integration

For advanced customization, use git-cliff:

.releasio.toml
[changelog]
engine = "git-cliff"

git-cliff Guide

Features

Author Attribution

[changelog]
show_authors = true

Output: 

- Add user dashboard (#42) by @username


[changelog]
show_commit_hash = true

Output: 

- Add user dashboard ([abc123](https://github.com/user/repo/commit/abc123))

First-Time Contributors

[changelog]
show_first_time_contributors = true
first_contributor_badge = "🎉"

Output: 

- Add user dashboard (#42) by @newuser 🎉

Sections

  • Templates

    Customize changelog format

    Templates

  • :material-cliff:{ .lg .middle } git-cliff

    Advanced changelog generation

    git-cliff

Preview Changes

Before generating, preview what will be added:

releasio check

Output: 

📝 Changelog Preview:

## [1.2.0] - 2024-01-15

### Features
- Add user dashboard (#42)

### Bug Fixes
- Resolve login timeout (#43)

See Also