From 8b0f5ebf1e67293314722d9646f41749dc8fd848 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Wed, 30 Sep 2026 21:34:00 +0200 Subject: [PATCH] docs: explain automatic binstall metadata repair --- README.md | 8 ++++++++ src/cli.rs | 1 + 2 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 8e2eef1..a461a11 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,14 @@ rust_realease ./my-tool --prepare-repo \ --commit-preparation --create-tag --push-preparation ``` +If you only want to add or repair the recommended `[package.metadata.binstall]` entries in `Cargo.toml`, use the existing metadata-only path: + +```bash +rust_realease ./my-tool --fix-metadata --stop-after metadata +``` + +Preview the same change without writing it by adding `--dry-run`. The generated values follow the archive layout produced by `rust_realease`, including the configured release tag prefix. + The preparation commit uses your configured Git author and signing settings. The tag is annotated and follows your Git tag-signing configuration (`git config tag.gpgsign true` to sign it); an existing tag is never moved. The branch and tag are pushed atomically without force. Use `--cross-image-tag main` only when you want preparation to set Cross images for the selected targets. ## Build local artifacts diff --git a/src/cli.rs b/src/cli.rs index 1d36aa8..81564d4 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -33,6 +33,7 @@ pub struct Cli { pub unlocked: bool, #[arg(long)] pub dry_run: bool, + /// Add or repair supported Cargo release metadata, including cargo-binstall metadata. #[arg(long)] pub fix_metadata: bool, #[arg(long)]