Skip to content
This repository has been archived by the owner on Jul 20, 2021. It is now read-only.

Preparing a release

Jump to bottom
Greg Caporaso edited this page Mar 6, 2017 · 2 revisions

Publishing a release of An Introduction to Applied Bioinformatics

These notes describe how to build and publish a release of IAB, and how to upload the content to readIAB.org.

Part 1: Prepare the release.

  1. Ensure that the Travis build is passing on the master branch.

  2. Update version number in setup.py. The version numbering in IAB is PEP 440 compliant.

  3. Submit a pull request with these changes and let Travis run.

Part 2: Build and test the html and IPython Notebook content.

  1. Install build-iab if you don't already have it installed.

  2. From the top-level An-Introduction-to-Applied-Bioinformatics directory, build the html and IPython Notebooks with the following commands. Poke through these files to ensure that they look right, and that the Edit links work correctly.

    biab html -i book -o html
biab notebook -i book -o ipynb

Part 3: Tag the release.

  1. If Travis passes, and if the build notebooks look correct, merge the pull request you created in Part 1. This will trigger the website build system to run, and will put this release version in the book/latest folder on S3.

  2. From the An Introduction to Applied Bioinformatics GitHub page, click on the release link and draft a new release. Use the version number for the tag name and create the tag against master. Fill in a release title that is consistent with previous release titles and add a summary of the release. This release summary will be the primary information that you should point users to when announcing the release.

Part 4: Update the website so the new version of IAB is live.

  1. In the readiab.org S3 bucket, copy the book/latest directory to book/<version>, where <version> is the version number of IAB that you just released.

  2. Update all version numbers in index.html to point to the new release version. We only maintain links to the latest release version and the current development version.

Part 5:

  1. Update the version strings to indicate the development release number. This should be <version>.dev0, where <version> is the next planned release. For example, if you just released version 0.1.3, this should probably be 0.1.4.dev0.

  2. Submit a pull request with these changes. Let the Travis build run, and if the tests pass merge the pull request. This will trigger the website build system to run, and will put this development version in the book/latest folder on S3.

  3. Announce the release pointing to the release notes on GitHub.

  4. 🍻

Acknowledgements

These notes were developed based on scikit-bio's RELEASE.md.

Clone this wiki locally