docs(release): document .deb install and curate release-notes install block (DX-5675)#27
Merged
johnpmitsch merged 1 commit intoJun 11, 2026
Conversation
… block (DX-5675)
README install section reordered around one recommended path per platform —
Homebrew (macOS/Linux), Scoop (Windows), .deb (Debian/Ubuntu), AUR (Arch),
COPR (Fedora/EPEL), Docker (GHCR) — with crates.io / source / prebuilt
binaries grouped under an Alternatives subsection. The .deb, COPR, and
Docker entries are new; the others are kept verbatim.
Adds a `release-update-install-notes` justfile recipe that prepends a
curated "How to install" block (rendered from a reviewable template at
packaging/release-notes-install.md.tmpl, with {{VERSION}} substitution) to
the GitHub release body. cargo-dist's auto-generated install section is
preserved below a `---` separator. The block is bracketed by HTML-comment
markers so re-runs replace the existing block instead of stacking, making
the recipe safe to invoke standalone or as the final step of
`release-sync-manual-channels`, which it now is.
markwu35
approved these changes
Jun 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.debinstall path (currently undocumented despite shippingqn_X.Y.Z_{amd64,arm64}.debon every release) and reorders the README install section around one recommended path per platform — Homebrew on macOS/Linux, Scoop on Windows,.debon Debian/Ubuntu, AUR on Arch, COPR on Fedora/EPEL, Docker on GHCR — withcargo install/ source / raw prebuilt binaries grouped under a newAlternativessubsection.release-update-install-notesjustfile recipe that prepends a curated "How to install" block to the GitHub release body. cargo-dist's auto-generated install section is preserved below a---separator. The block is rendered from a reviewable template atpackaging/release-notes-install.md.tmpl(with{{VERSION}}substitution) and bracketed by HTML-comment markers so re-runs replace the existing block instead of stacking duplicates.release-sync-manual-channelsas the final step, so every channel link in the install block is live before the body advertises it.No changes to
dist-workspace.toml,release.yml, orpublish-deb.yml. cargo-dist keeps producing its own install section; this layers on top.Test plan
just --listshows the newrelease-update-install-notesrecipe and the justfile parses cleanly.just release-update-install-notes 0.1.8 --dry-runsubstitutes every{{VERSION}}with0.1.8and preserves the cargo-dist body below the---separator.gh release view). Pass 1 == Pass 2 == Pass 3.## Installblock appears at the top of the GitHub release body with every link live (Homebrew tap, Scoop bucket, the actual.debasset on this release, COPR project, GHCR image), and the cargo-dist auto-generated section is still present below the separator..debsnippet from the release notes for the just-cut release, install, runqn --version, confirm the installed version matches the release tag.Closes DX-5675