From ffa6fed7b30c5c884f9ce3f5fc23215779d86098 Mon Sep 17 00:00:00 2001 From: Marek Date: Wed, 20 Oct 2021 20:02:07 +0200 Subject: [PATCH] Improve the template for release versioning (#2906) * Specify the location of the user agent string * Specify the `cargo install` command * Fix a typo Co-authored-by: Deirdre Connolly --- .github/PULL_REQUEST_TEMPLATE/release-checklist.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md index 74f94a07f..8ebe8447b 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md @@ -16,6 +16,7 @@ To check if any of the top-level crates need version increments, go to the zebra - [ ] Increment the crates that have new commits since the last version update - [ ] Increment any crates that depend on crates that have changed - [ ] Use the `zebrad` crate version in the `zebra-network` user agent string + (currently the constant `USER_AGENT` in `zebra-network/src/constants.rs`) - [ ] Use the latest git tag in `README.md` ### How to Increment Versions @@ -89,7 +90,8 @@ Also check for crates that depend on crates that have changed. They should get a ## Initial Testing -- [ ] After any changes, test that the `cargo install` command in `README.md` works (use `--path` instead of `--git` locally) +- [ ] After any changes, test that the `cargo install` command in works. Use + e.g. `cargo install --locked --path zebrad`. ## Change Log @@ -129,8 +131,8 @@ From "Keep a Changelog": ## Final Testing -- [ ] After tagging the release, test that the exact `cargo install` command works - (`--git` behaves a bit differently to `--path`) +- [ ] After tagging the release, test that the exact `cargo install` command in + `README.md` works (`--git` behaves a bit differently to `--path`) If the build fails after tagging: 1. fix the build