-
Notifications
You must be signed in to change notification settings - Fork 77
Release Checklist
Georgiy Komarov edited this page Feb 1, 2023
·
23 revisions
-
Update the following files on a branch
prerel-v3.2.1
:- Dockerfile
- Dockerfile.slim
- Syntax.ml
- Syntax.ml
-
Create a pull-request on GitHub and merge it into master.
-
Create a release branch
release-v3.2.1
frommaster
and tag an alpha releasev3.2.1-alpha.0
.
$git checkout master # Checkout master
$git pull # Get and merge the latest master from the repo
$git checkout -b release-v3.2.1 master # Create a new release branch
$git push origin release-v3.2.1 # Push the release branch to the repo
$git tag v3.2.1-alpha.0
$git push origin v3.2.1-alpha.0
-
- Thoroughly test
v3.2.1-alpha.0
, including end-to-end testing with the blockchain. - Clear Travis-CI cache before these tests, to ensure that latest opam packages are fetched and our code is tested against that.
- Thoroughly test
-
- No new features are to be allowed into a release branch, hot-fixes only. To push a hot-fix to a release branch, create a PR against the release branch (not
master
). Test the PR with the same rigor as in (4) above. - If applicable, cherry-pick or merge each hot-fix to
master
. - Create more alpha releases if needed.
- No new features are to be allowed into a release branch, hot-fixes only. To push a hot-fix to a release branch, create a PR against the release branch (not
-
Once the release branch is ready, create a new release on GitHub against the tip of the branch, tagging it as
v3.2.1
. Add release notes if applicable.- Prepare release notes by filtering out commits since the last release: https://github.com/Zilliqa/scilla/compare
-
Since GitHub does not pack git submodules, tarballs containing the dependencies need to be manually created and uploaded as (binary) assets. One way to create those tarballs would be to copy the Scilla root directory, checkout the tag to be released, execute
git clean -dfx; rm -rf _opam _build .git deps/libff/{build,install}
zip scilla-<tag>.zip -r scilla-<tag>
tar cfz scilla-<tag>.tar.gz scilla-<tag>