Repository navigation
fix release - #9
Merged
Merged
Conversation
Lead with cargo-binstall, which resolves the release archives with no extra metadata because their names already match its default patterns. Narrow the old "Building and installing" section to building from a clone, so installing is not described in two places.
Release immutability was switched on between v0.1.0 and v0.1.1, so release-plz published a sealed release and the binaries job could not upload to it: HTTP 422: Cannot upload assets to an immutable release v0.1.1 therefore shipped with no archives attached. The setting is now off; record the constraint next to the release instructions so it does not get switched back on.
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
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.
What
Two README changes:
docs(readme)- adds an## Installationsection at the top of the README, leading withcargo binstalland falling back tocargo install. The existing## Building and installingsection is narrowed to## Building from source, so installation is no longer described in two places.fix(ci)- records in the## Releasingsection that release immutability must stay off on this repository.Why
The README had no installation section. Installation instructions were buried two thirds of the way down under a heading about building, which is not where someone landing on the crate page looks.
The second commit documents the cause of a real release failure. Release immutability was switched on between v0.1.0 and v0.1.1.
release.ymlpublishes the GitHub release via release-plz and then attaches the prebuilt archives from thebinariesjob about a minute later, which an immutable release rejects:Both
binariesmatrix jobs failed on the v0.1.1 run, so v0.1.1 shipped with no archives attached. The crate itself published to crates.io correctly and exactly once. The setting has been turned off, and this commit records the constraint next to the release instructions so it does not get switched back on.Notes
cargo binstallneeds noCargo.tomlmetadata. The existing asset names (mdpreviewer-v{version}-{target}.tar.gzunderreleases/download/v{version}/) already match cargo-binstall's default URL andbin-dirpatterns. Verified by resolving both v0.1.0 asset URLs (HTTP 200).cargo binstall mdpreviewerwill fall back to building from source, because v0.1.1 has no assets to fetch.fix(ci)is used instead of a bareci:on purpose:release-plz.tomlskips^(test|chore|ci|build|style), so a bareci:commit would never reach the changelog.Testing
mise run lintpasses (rustfmt, clippy, rumdl, oxfmt, actionlint, zizmor, yamlfmt, taplo).mise run release:previewconfirms the next release is 0.1.2 with both commits categorised correctly:No code changes, so no behaviour to test beyond the above.