zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Make some small changes to release-checklist.md (#2671) 

* Update release-checklist.md

* give all alternatives to check what changed

Co-authored-by: teor <teor@riseup.net>
This commit is contained in:
Alfredo Garcia 2021-08-26 19:45:19 -03:00 committed by GitHub
parent a4b0b46d21
commit ac76d35cbb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.github/PULL_REQUEST_TEMPLATE/release-checklist.md vendored
View File

@ -11,8 +11,7 @@ assignees: ''
### Which Crates to Increment ### Which Crates to Increment
To check if any of the top-level crates need version increments, go to the zebra GitHub code page: https://github.com/ZcashFoundation/zebra. `git diff --stat <previous-release-tag> origin/main` is also useful to see To check if any of the top-level crates need version increments, go to the zebra GitHub code page: https://github.com/ZcashFoundation/zebra and use the last modified dates of each crate. Alternatively you can use the github compare tool and check the `main` branch against the last tag ([Example](https://github.com/ZcashFoundation/zebra/compare/v1.0.0-alpha.15...main)). `git diff --stat <previous-release-tag> origin/main` is also useful to see what's changed.
what's changed.
- [ ] Increment the crates that have new commits since the last version update - [ ] Increment the crates that have new commits since the last version update
- [ ] Increment any crates that depend on crates that have changed - [ ] Increment any crates that depend on crates that have changed
@ -63,11 +62,13 @@ Once you know which versions you want to increment, you can find them in the:
Merge all these version increments as one commit, by squashing and rebasing the PR onto the main branch. Merge all these version increments as one commit, by squashing and rebasing the PR onto the main branch.
After you have your changes pushed start a PR with them using this template by adding `&template=release-checklist.md` to the comparing url ([Example](https://github.com/ZcashFoundation/zebra/compare/v1.0.0-alpha.16?expand=1&template=release-checklist.md)).
#### Version Tooling #### Version Tooling
You can use `fastmod` to interactively find and replace versions. You can use `fastmod` to interactively find and replace versions.
For example, for `zebra-1.0.0-alpha-12`, we did: For example, for `zebra-1.0.0-alpha.12`, we did:
``` ```
fastmod --extensions rs,toml,md --fixed-strings '1.0.0-alpha.12' '1.0.0-alpha.13' fastmod --extensions rs,toml,md --fixed-strings '1.0.0-alpha.12' '1.0.0-alpha.13'
fastmod --extensions rs,toml,md --fixed-strings '1.0.0-alpha.11' '1.0.0-alpha.12' fastmod --extensions rs,toml,md --fixed-strings '1.0.0-alpha.11' '1.0.0-alpha.12'