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

Add extra dependency update steps to the README (#63) 

* Add extra dependency update steps to the README

* Use correct dependency steps from Cargo.toml

* Explain how to make new dependencies work

* Simplify instructions

* Add "check all open PRs before releasing"

* Add "run cargo-release" to the release instructions

Co-authored-by: Arya <aryasolhi@gmail.com>

---------

Co-authored-by: Arya <aryasolhi@gmail.com>
This commit is contained in:
teor 2023-02-24 09:08:01 +10:00 committed by GitHub
parent fb997ccf3f
commit 2b2c666c04
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -24,7 +24,13 @@ to include a lot of other stuff e.g. the orchard library.
1. Update `depend/zcash` with the latest tagged version of `zcashd`
2. Update `Cargo.toml` versions to match the versions used by the latest tagged version of `zcashd`, and its dependencies
3. Publish a new release
3. For dependencies that are shared with Zebra (but not `zcashd`), match the latest version in Zebra's [Cargo.lock](https://github.com/ZcashFoundation/zebra/blob/main/Cargo.lock):
- use `cargo tree --invert <crate>` to see if the crate is from `zcash_script` or another dependency
- see the list in [Cargo.toml](https://github.com/ZcashFoundation/zcash_script/blob/master/Cargo.toml#L69)
4. For new dependencies with a leading zero in their version (`0.x.y`), use a `>=` dependency [to make them automatically upgrade to match Zebra's dependencies](https://doc.rust-lang.org/cargo/reference/resolver.html#semver-compatibility)
5. Check all open PRs to see if they can be merged before the release
6. Run `cargo-release` with `--no-publish` to commit any automatic changes
7. Publish a new release
### Updating `depend/zcash`