-
Notifications
You must be signed in to change notification settings - Fork 112
Releases
Mark Diekhans edited this page Apr 17, 2020
·
32 revisions
The latest stable release of cactus is found at: https://github.com/ComparativeGenomicsToolkit/cactus/releases. Docker images are available from [https://quay.io/repository/comparative-genomics-toolkit/cactus?tab=tags](https://quay.io/repository/comparative-genomics-toolkit/cactus?tab=tags](https://quay.io/repository/comparative-genomics-toolkit/cactus?tab=tags](https://quay.io/repository/comparative-genomics-toolkit/cactus?tab=tags), with the release tagged by release number.
Cactus currently does not implement semantic versioning. We do try to minimize breaking changes but there are no guarantees in place.
We do try to maintain a semantic-like naming scheme for releases (e.g. the major release after v1.7.0 is c1.8.0).
- Maintain
ReleaseNotes.md
in the tree as changes are made, in newest-first order- Record any new features and important changes, include those in submodules.
- Make note of any breaking changes, include those in submodules.
- It may help to consult the log of commits since the last release.
- Check that all unit and integration tests (both Travis and GitLab) have been ran.
To cut a new release:
- Ensure the section for this release in
ReleaseNotes.md
is current. It may help to consult the log of commits or pull requests since the last release. - Edit
ReleaseNotes.md
and add release number and date. - Create a new release on Github
- Look up the next release number
- Tag it vX.Y.Z
- Title it Cactus X.Y.Z
- Fill in release description:
- Copy release description template below, edit to set release number.
- Inserted the section from ReleaseNotes.md describing this release.
- Mark it as a pre-release
- Publish it (which tags the commit and hopefully kicks off the Docker build on Quay)
- Produce a buildable source tarball, containing code for
cactus
and all submodules, and upload it to the release.make makeSrcRelease
- Build and upload a static Linux binary package on a CentOS 7.5 system. This has the
/bin/
files and python source needed topip install
cactus for the release.make makeBinRelease
- Verify that all links are working
- Edit the release and mark it as no longer a pre-release, to make it the latest stable release.
- Send announcement to cactus-announce@googlegroups.com,
pointing to release notes at
https://github.com/ComparativeGenomicsToolkit/cactus/releases/vX.Y.X/
.
# Cactus Release X.Y.Z
Cactus X.Y.Z is available in the following forms:
- Docker Image: `quay.io/comparative-genomics-toolkit/cactus:vX.Y.Z`
Install instructions in [README.md](https://github.com/ComparativeGenomicsToolkit/cactus/blob/vX.Y.Z/README.md)
- Pre-compile Linux Tarball: [cactus-bin-vX.Y.Z.tar.gz](https://github.com/ComparativeGenomicsToolkit/cactus/releases/download/vX.Y.X/cactus-bin-vX.Y.Z.tar.gz)
Install instructions in [BIN-INSTALL.md](https://github.com/ComparativeGenomicsToolkit/cactus/blob/vX.Y.Z/BIN-INSTALL.md)
- Source Tarball: [cactus-vX.Y.Z.tar.gz](https://github.com/ComparativeGenomicsToolkit/cactus/releases/download/vX.Y.Z/cactus-vX.Y.Z.tar.gz)
Install instructions in [README.md](https://github.com/ComparativeGenomicsToolkit/cactus/blob/vX.Y.Z/README.md)
Please subscribe to the [cactus-announce](https://groups.google.com/d/forum/cactus-announce) low-volume mailing list to receive notice of Cactus release.
## Release notes
<copy ReleaseNotes.md for this release here>
- Information on tag finding with Git
- This process shamelessly copied from vg