Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the template for release versioning #2906

Merged
merged 6 commits into from
Oct 20, 2021
Merged

Improve the template for release versioning #2906

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
12f06b8
Specify the location of the user agent string
upbqdn Oct 19, 2021
ce919e4
Specify the `cargo install` command
upbqdn Oct 19, 2021
d510b7f
Fix a typo
upbqdn Oct 19, 2021
64539a2
Merge branch 'main' into update-versioning
upbqdn Oct 19, 2021
61accd3
Merge branch 'main' into update-versioning
upbqdn Oct 20, 2021
41c9ed5
Merge branch 'main' into update-versioning
dconnolly Oct 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE/release-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down