Skip to content

Installation

Install releasio

pip install releasio

uv add releasio --dev

pipx install releasio

releasio works out of the box with its built-in native changelog generator. For more advanced changelog customization, you can optionally install git-cliff:

brew install git-cliff

cargo install git-cliff

npm install -g git-cliff

scoop install git-cliff

No External Dependencies Required

git-cliff is optional. releasio includes a native changelog generator that's enabled by default (native_fallback = true). Install git-cliff only if you need advanced features like custom Tera templates or complex commit parsing.

Verify Installation

Check that releasio is installed correctly:

# Check releasio
releasio --version

# Optional: Check git-cliff (if installed)
git-cliff --version

GitHub Actions

When using releasio in GitHub Actions, git-cliff is installed automatically by the action. No additional setup required.

- uses: mikeleppane/releasio@v2
  with:
    command: release-pr
    github-token: ${{ secrets.GITHUB_TOKEN }}

Next Steps