cellxgene/dev_docs/release_process.md

cellxgene release process

This document defines the release process for cellxgene

Overview

The goal of the release process is to publish an installable package to PyPi, with a matching tagged release on github.

The release process should result in the following side-effects:

• Version number bump, using semantic versioning
• JS assets built & packaged, committed to the repo
• Tagged github release
• Publication to PyPi

Recipe

Follow these steps to create a release.

1. Preparation:
   • python3.6 environment, and a cellxgene clone
   • install required tools: pip install -r requirements-dev.txt
   • Define the release version number, using semantic versioning, and specifying all three digits (eg, 0.3.0)
   • Write the release title and release notes and add to release notes document
2. Create a release branch, eg, release-version
3. In the release branch:
   • Run bumpversion --config-file .bumpversion.cfg [major | minor | patch], where you choose major/minor/patch depending on which part of the version is being bumped (eg, 0.2.9->0.3 is minor).
   • Clean up existing environment using bin/clean
   • Build the JS asserts using bin/build-client
4. Commit and push the new branch
5. Create a PR for the release.
   • [optional] As needed, conduct PR review.
6. Merge to master
7. Create Github release using the version number and release notes (instructions).
   • Draft new release
   • Type version name matching release version number from (1)
   • Select master as release branch (ensure you merged the release PR)
   • Type title Release {version num}
   • [optional] Check pre-release if this release is not ready for production
   • Publish Release
8. Publish to pypi by performing the following steps (assumes you have setuptools and twine installed, that you have registered for pypi, and that you have write access to the cellxgene pypi package):
   • Build the distribution by calling python setup.py sdist inside the top-level directory
   • [optional] Upload the package to test pypi twine upload --repository-url https://test.pypi.org/legacy/ dist/*
   • [optional] Test the test installation in a fresh virtual environment using pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple cellxgene
   • Upload the package to real pypi using twine upload dist/*
   • [optional] Test the installation in a fresh virtual environment using pip install cellxgene

The optional steps are for testing purposes, and are recommended for publishing any major releases, and any releases that significantly change the packaging (e.g. new bundled files, new dependencies, etc.)