jj-release
Automated semantic releases and changelogs for Jujutsu repositories.
Tools like release-plz and cargo-release are built around mutable Git
branches. jj-release is built for jj: it walks history with revsets, moves
bookmarks instead of branches, and starts a release from a commit message, so
shipping is just another jj new.
Features
- Semantic versioning from your commits. Bumps are computed from Conventional Commits, with cargo-semver-checks catching breaking API changes your commit messages missed.
- Keep a Changelog output. Grouped, scoped, optionally emoji-headed sections
prepended to
CHANGELOG.md. - Forge releases and PRs on GitHub, GitLab, Forgejo/Codeberg, and Gitea.
- Workspaces with unified or independent versioning, published in dependency order.
- Version bumps everywhere. Manifests, cross-member dependencies,
flake.nix, and any file you configure with regex replacements. - Distro packages. Optionally update your AUR package and submit a Fedora COPR build after each release.
- Safe by default. Pre-flight checks run before anything changes, and nothing is pushed until the publish succeeds.
Rust is the primary target. npm and Go manifests are supported but less battle-tested.
Installation
By default, only github and gitlab features are included.
# Forgejo/Codeberg only, no GitHub or GitLab
| Platform | Command |
|---|---|
| Arch (AUR) | paru -S jj-release |
| Arch (AUR, full) | paru -S jj-release-full |
| Fedora | sudo dnf copr enable sayless88/jj-release && sudo dnf install jj-release |
| Fedora (full) | sudo dnf install jj-release-full |
| Nix | nix run github:saylesss88/jj-release |
| From source | cargo install --git https://github.com/saylesss88/jj-release |
| Cargo Binstall | cargo binstall jj-release |
Requires jj 0.43+ in a colocated repository (jj git init --colocate). Forge
releases need gh or glab for GitHub and GitLab. See
Installation
for Cargo features, NixOS configuration, and optional tools.
For Forgejo/Gitea forge support and AUR/COPR publishing, install the
fullvariant:paru -S jj-release-fullorsudo dnf install jj-release-full.
Quick start
# When you're ready to ship:
jj-release runs locally or in CI. For GitHub Actions, see
CI setup.
How it works
When jj-release finds a commit containing the trigger (Release: please by
default) since the last version tag, it:
- Classifies commits since the last tag as major, minor, or patch, using the latest crates.io version as the baseline.
- Runs pre-flight checks, including
cargo publish --dry-run. - Writes the changelog and bumps versions.
- Creates a
chore: release vX.Y.Zcommit and tag. - Publishes to crates.io.
- Moves the bookmark and pushes the commit and tag.
- Creates a forge release and updates distro packages, if configured.
If anything fails before the push, your remote is untouched. See Recovering from a failed release.
Prefer to review first? jj-release pr opens a pull request with the changelog
preview instead of releasing.
Documentation
- Configuration reference
- Conventional Commits and changelogs
- Forges
- Workspaces
- Changelogs
- AUR and COPR publishing
- Library API (
jj_release_core)
Repository layout
Credits
Ideas and code adapted from release-plz (crates.io version baseline, semver checks), cargo-release, and git-cliff (changelogs).