vg
vg copied to clipboard
Release vg v1.56.0
- [ ] Create a new release on Github
- [ ] Look up the next scheduled codename in
version.cpp
. If we have run to the end of the list of codenames, quickly PR some more tomaster
. - [ ] Tag it vX.Y.Z
- [ ] Title it vg X.Y.Z - Codename Here
- [ ] Mark it as a prerelease
- [ ] Publish it (which tags the commit and kicks off the Docker build on our Gitlab)
- [ ] Look up the next scheduled codename in
- [ ] Produce a buildable source tarball, containing code for
vg
and all submodules, and upload it to the release.mkdir source-tarball cd source-tarball git clone --recursive https://github.com/vgteam/vg.git cd vg git fetch --tags origin LATEST_TAG="$(git describe --tags `git rev-list --tags --max-count=1`)" git checkout "${LATEST_TAG}" git submodule update --init --recursive make include/vg_git_version.hpp rm -Rf .git find deps -name ".git" -exec rm -Rf "{}" \; cd .. mv vg "vg-${LATEST_TAG}" tar -czf "vg-${LATEST_TAG}.tar.gz" "vg-${LATEST_TAG}" rm -Rf "vg-${LATEST_TAG}"
- [ ] Build and upload a static Linux binary (/bin/vg file) for the release (Mac OS X can't build static binaries.)
cd vg git remote add upstream https://github.com/vgteam/vg.git || true git fetch --tags upstream LATEST_TAG="$(git describe --tags `git rev-list --tags --max-count=1`)" git checkout "${LATEST_TAG}" git submodule sync git submodule update --init --recursive rm -f lib/libsdsl.a sed -i s/march=native/march=nehalem/ deps/sdsl-lite/CMakeLists.txt locate libz.a || (sudo apt-get update && make get-deps) CXXFLAGS=" -march=nehalem " make -j8 static strip -d bin/vg bin/vg test
- [ ] In the new release:
- [ ] Copy-paste the description of the previous release.
- [ ] Edit the links and Docker container names in the description to point to the new release
- [ ] Insert changes from the draft changelog
- [ ] List any new dependencies
- [ ] List any updated, moved, new, or removed submodules
It may help to consult the log of commits since the last release, or to use a command like
git diff v1.43.0..v1.44.0 deps/
.
- [ ] Clear the draft changelog for the next release
- [ ] Create a milestone for the next release here, named vX.Y+1.Z, due in 6 weeks.
- [ ] Create an issue Release vg vX.Y+1.Z for the next release on the Github issues page, using the checklist template under the
Release process
heading on this wiki page.- [ ] Assign it to the milestone.
- [ ] Update this wiki page with the next release version, date, issue, and milestone.
- [ ] Gitlab is responsible for building multi-arch (ARM and x86) Docker releases. Make sure that the
production-build-job
on Gitlab succeeded in the Gitlab CI pipeline for the correct tag of vg. If something went wrong, you can build and push the container manually for your current architecture only:
See also this issue for building multi-arch Docker images manually.VG_VERSION="vX.Y.Z" git clone --recursive https://github.com/vgteam/vg.git cd vg git checkout ${VG_VERSION} git submodule sync git submodule update --init --recursive make include/vg_git_version.hpp docker pull mirror.gcr.io/library/ubuntu:20.04 docker build --target run -t quay.io/vgteam/vg:${VG_VERSION} -f Dockerfile . docker build --target test -f Dockerfile . docker logout quay.io docker login quay.io docker push quay.io/vgteam/vg:${VG_VERSION} docker logout quay.io
- [ ] Once the Docker build is complete, obtain the ARM64 static binary from the container, and upload it to the release.
VG_VERSION="vX.Y.Z" IMAGE_ID="quay.io/vgteam/vg:${VG_VERSION}" docker pull --platform linux/arm64 "${IMAGE_ID}" CONTAINER_ID="$(docker create --platform linux/arm64 "${IMAGE_ID}")" docker cp "${CONTAINER_ID}:vg/bin/vg" "./vg-arm64" docker rm "${CONTAINER_ID}" docker rmi "${IMAGE_ID}"
- [ ] Edit the release and mark it as no longer a pre-release, to make it the latest stable release.
- [ ] Contact Rose Miyatsu at UCSC by e-mail to promote the release. Send a couple sentences about the milestones reached in the release, a link to the release on Github, and the vg logo or any more relevant image available. Include these relevant Twitters: @BenedictPaten @erikgarrison @jeizenga @jltsiren @amnovak @JMonlong @glenn_hickey @XianChang6
- [ ] Close the previous release issue, and the previous release milestone in the milestone list.