|
||
---|---|---|
.github/workflows | ||
depend | ||
src | ||
.gitignore | ||
.gitmodules | ||
CHANGELOG.md | ||
Cargo.toml | ||
LICENSE | ||
README.md | ||
build.rs |
README.md
zcash_script
Rust bindings to the ECC's zcash_script
c++ library.
Cloning and checking out depend/zcash
Clone this repository using:
git clone --recurse-submodules
Or if you've already cloned:
git submodule update --init
To pull the latest version, use:
git pull --recurse-submodules
Updating depend/zcash
If you need to change the submodule's base branch:
git config -f .gitmodules submodule.depend/zcash.branch <branch-name>
To pull in recent changes from the upstream repo:
git submodule update --remote
To use a specific commit:
cd depend/zcash
git checkout <commit-hash>
Publishing New Releases
Releases for zcash-script
are made with the help of cargo release.
Checklist:
- create a new branch batch the release commits into a PR
- update
CHANGELOG.md
to document any major changes since the last release - open a PR to merge your branch into
master
- locally run
cargo release -- <level>
wherelevel
can bepatch
,minor
, ormajor
(source)
NOTE: It's important to specify the level when using cargo release because of the way it implements the substitutions. We specify a number of automatic substitutions in Cargo.toml
but they will only be applied if cargo release
also handles incrementing the version itself, do not increment the version by hand and then run cargo release
or cargo release -- release
, or it will not correctly update all version references in the codebase.