mirror of
https://github.com/chanzuckerberg/cellxgene.git
synced 2026-09-15 20:57:56 +08:00
86eb01eb2c
* Add --no-cache-dir to make release-install target Prevents installing from cache so you get the freshest release * Testing releases is not optional * Updated release documentation
96 lines
4.5 KiB
Markdown
96 lines
4.5 KiB
Markdown
# 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
|
|
- Define the release version number, using [semantic versioning](https://semver.org/),
|
|
and specifying all three digits (eg, 0.3.0)
|
|
- Write the release title and release notes and add to
|
|
[release notes document](https://docs.google.com/document/d/1KnHwkYfhyWO5H8BDcMu7y3ogjvq5Yi4OwpmZ8DB6w0Y/edit)
|
|
2. Create a release branch, eg, `release-version`
|
|
3. In the release branch:
|
|
- Run `make release-stage-1 PART=[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).
|
|
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](https://help.github.com/articles/creating-releases/)).
|
|
- 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 that you have registered for pypi,
|
|
and that you have write access to the cellxgene pypi package):
|
|
- Build the distribution and upload to test pypi `make release-stage-2`
|
|
- Test the test installation in a fresh virtual environment using `make install-release-test`
|
|
- Upload the package to real pypi using `make release-stage-final`
|
|
- 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.)
|
|
|
|
## Troubleshooting
|
|
### Fails to upload to test.pypi
|
|
|
|
_PyPi doesn't allow you to reupload a release with the same version number_
|
|
If you accidentally burned a release number you want to use on prod, you have a few options:
|
|
1) OPTION 1: Create distribution `make pydist`; test release locally `pip install dist/<release tarball>`;
|
|
then upload to prod `make release-stage-final`.
|
|
2) OPTION 2: (DANGER) release directly to prod: `make release-directly-to-prod`.
|
|
3) OPTION 3: If the release was burned on prod as well run from Step 3 again with option
|
|
PART=patch until you get to an unburned version.
|
|
|
|
### The release doesn't install or fails your tests when you install it
|
|
|
|
Delete it from pypi - Go to pypi.org -> sign in -> go to the cellxgene package -> click manage -> then in the options drop down click delete -> follow the instructions. You will not be able to use that release number again. If it is a minor bug and not a major regression, you can just release a patch.
|
|
### If you need to run stage final on a different computer than stage 2
|
|
If you run stage final without running stage 2 first, the dist will not have been build on the computer running stage final. The solution is to run `make release-directly-to-prod`. This both builds the distribution files and then releases directly to prod pypi.org.
|
|
|
|
## Stage Details
|
|
### Stage 1 - `make release-stage-1`
|
|
1. Pip installs requirements-dev
|
|
2. Bumps version by [PART]
|
|
3. Deletes build directory, client/build, dist and cellxgene.egg-info
|
|
4. Creates the package-lock.json
|
|
|
|
### Stage 2 - `make release-stage-2`
|
|
1. Pip installs requirements-dev
|
|
2. Builds client and server
|
|
3. Creates distribution release (sdist)
|
|
4. Uploads to test.pypi.org
|
|
|
|
### Stage final - `make release-stage-final`
|
|
** Does not build distribution **
|
|
1. Uploads to pypi.org
|
|
|
|
### (DANGER) Release directly to prod `make release-directly-to-prod`
|
|
** builds distribution and uploads directly to prod **
|
|
Only use this if you are directed to by the troubleshooting guide
|
|
1. Pip installs requirements-dev
|
|
2. Builds client and server
|
|
3. Creates distribution release (sdist)
|
|
4. Uploads to pypi.org
|