Skip to content

Release Process

mdink edited this page Feb 28, 2026 · 1 revision

Release Process

This page documents how to cut a new mdink release.

1 — Prepare the version bump

Edit Cargo.toml to bump the version:

[package]
version = "0.2.0"  # was 0.1.1

Run cargo check to update Cargo.lock with the new version:

cargo check

Commit both files:

git add Cargo.toml Cargo.lock
git commit -m "Bump version to v0.2.0"

2 — Tag and push

git tag v0.2.0
git push origin main v0.2.0

Pushing the tag triggers the CI release pipeline.


3 — CI pipeline

The release workflow (.github/workflows/release.yml) runs when a tag matching v* is pushed. It has four job groups, with the build targets running in parallel:

assets job (once, platform-independent)

Runs cargo xtask dist-assets to generate:

  • assets/mdink.1.gz — gzipped man page
  • assets/completions/ — shell completion files for bash, zsh, fish

These are uploaded as a CI artifact for the deb job to consume.

build jobs (5 targets)

Target OS Archive
x86_64-unknown-linux-gnu Ubuntu mdink-linux-x86_64.tar.gz
aarch64-unknown-linux-gnu Ubuntu (cross) mdink-linux-aarch64.tar.gz
x86_64-apple-darwin macOS mdink-macos-x86_64.tar.gz
aarch64-apple-darwin macOS mdink-macos-aarch64.tar.gz
x86_64-pc-windows-msvc Windows mdink-windows-x86_64.zip

Each job builds with cargo build --profile dist (maximum optimization + symbol stripping) and packages the binary into the archive.

deb job

Depends on the assets job. Downloads the generated assets, then runs cargo deb to build a Debian .deb package that includes the binary, man page, and shell completions.

release job

Depends on all build and deb jobs. Downloads all artifacts and creates a draft GitHub Release with:

  • All .tar.gz binaries
  • The .zip Windows binary
  • The .deb package
  • Auto-generated release notes (from merged PRs since the last tag)

4 — Publish the draft

  1. Go to github.com/mdink-rs/mdink/releases.
  2. Open the draft release created by CI.
  3. Review the auto-generated release notes; edit as needed.
  4. Click Publish release.

Checklist

  • Cargo.toml version bumped
  • Cargo.lock updated (cargo check)
  • Both files committed
  • Tag pushed: git tag vX.Y.Z && git push origin main vX.Y.Z
  • All CI jobs green
  • Draft release reviewed and published

Clone this wiki locally