From ae163a26bb1a1a95f5b15978008cb274e4b908b1 Mon Sep 17 00:00:00 2001 From: Andrew Champion Date: Mon, 21 Nov 2022 12:09:28 +0000 Subject: [PATCH] Doc: README updates for release infrastructure --- CHANGELOG.md | 2 +- README.md | 8 ++++++-- release.toml | 1 + 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ea85ca8..5e714ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -99,7 +99,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - `stat`: also report block coordinate statistics. -[unreleased]: https://github.com/aschampion/n5gest/compare/v0.3.9...HEAD +[Unreleased]: https://github.com/aschampion/n5gest/compare/v0.3.9...HEAD [0.3.9]: https://github.com/aschampion/n5gest/compare/0.3.8...0.3.9 [0.3.8]: https://github.com/aschampion/n5gest/compare/0.3.7...0.3.8 [0.3.7]: https://github.com/aschampion/n5gest/compare/0.3.6...0.3.7 diff --git a/README.md b/README.md index 718f501..803721a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# n5gest +# n5gest [![Build Status](https://github.com/aschampion/n5gest/actions/workflows/ci.yml/badge.svg)](https://github.com/aschampion/n5gest/actions/workflows/ci.yml/) CLI utilities for working with [N5](https://github.com/saalfeldlab/n5) files. @@ -45,6 +45,11 @@ SUBCOMMANDS: validate-blocks Report malformed blocks. ``` +Installation options: +- Compile and install using cargo: `cargo install n5gest` +- Download a precompiled binary from [the latest GitHub releases](https://github.com/aschampion/n5gest/releases/latest) +- Install a precompiled binary using [cargo-binstall](https://github.com/ryankurte/cargo-binstall): `cargo binstall n5gest` + ## Development Version bumping (including changelog release section versioning) is handled by [cargo-release](https://github.com/crate-ci/cargo-release), e.g.: @@ -53,7 +58,6 @@ Version bumping (including changelog release section versioning) is handled by [ cargo release --dev-version minor ``` - ## License Licensed under either of diff --git a/release.toml b/release.toml index 64957ee..afcf9c4 100644 --- a/release.toml +++ b/release.toml @@ -1,6 +1,7 @@ publish = false pre-release-commit-message = "Version {{version}}" pre-release-replacements = [ + {file="README.md", search="n5gest \\d+\\.\\d+\\.\\d+", replace="{{crate_name}} = \"{{version}}\"", exactly=1}, {file="CHANGELOG.md", search="^## \\[Unreleased\\]", replace="## [{{version}}] - {{date}}", exactly=1}, {file="CHANGELOG.md", search="\\[Unreleased\\]", replace="[{{version}}]", min=1}, {file="CHANGELOG.md", search="\\.\\.\\.HEAD", replace="...{{tag_name}}", exactly=1},