Skip to content

Configuration

Customize releasio to fit your project's workflow.

Zero Configuration

releasio works out of the box with sensible defaults:

# Just works!
releasio check

Only create configuration when you need to customize behavior.

Configuration Files

releasio looks for configuration in this order:

File Priority Format
.releasio.toml Highest Top-level keys
releasio.toml Medium Top-level keys
pyproject.toml Lowest Under [tool.releasio] 
default_branch = "main"

[version]
tag_prefix = "v"

[changelog]
path = "CHANGELOG.md"

[tool.releasio]
default_branch = "main"

[tool.releasio.version]
tag_prefix = "v"

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

Format Difference

Standalone files use top-level keys. pyproject.toml uses the [tool.releasio] prefix.

Quick Reference

  • Configuration Files

    File formats and precedence

    Files

  • Full Reference

    Complete configuration options

    Reference

  • Examples

    Common configuration patterns

    Examples

Configuration Sections

Section Purpose
[version] Version management
[changelog] Changelog generation
[commits] Commit parsing rules
[github] GitHub integration
[publish] PyPI publishing
[hooks] Release lifecycle hooks
[security] Security advisories
[branches] Multi-channel releases

Initialize Configuration

Generate a configuration file with defaults:

releasio init

This creates .releasio.toml with common options you can customize.