User Guide¶
Everything you need to know about using releasio effectively.
Core Concepts¶
-
CLI Commands
Master all releasio commands from
checktodo-release -
Configuration
Customize every aspect of the release process
-
Version Management
Semantic versioning, pre-releases, and version files
-
Changelog
Beautiful changelog generation with templates
-
Commits
Conventional commits and custom parsers
Quick Reference¶
Common Commands¶
# Preview release (safe, no changes)
releasio check
# Create/update release PR
releasio release-pr --execute
# Publish release
releasio release --execute
# Full release workflow
releasio do-release --execute
Configuration Files¶
releasio looks for configuration in this order:
.releasio.toml(highest priority)releasio.tomlpyproject.tomlunder[tool.releasio]
Version Bumping¶
| Commit Type | Version Bump | Example |
|---|---|---|
feat: |
Minor | 0.1.0 → 0.2.0 |
fix: |
Patch | 0.1.0 → 0.1.1 |
feat!: |
Major | 0.1.0 → 1.0.0 |