mirror of
https://github.com/chanzuckerberg/cellxgene.git
synced 2026-09-17 13:58:00 +08:00
58 lines
2.6 KiB
Markdown
58 lines
2.6 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
|
|
|
|
## Process
|
|
|
|
Follow these steps to create a release.
|
|
|
|
1. Preparation:
|
|
- Define the release version number, using [semantic versioning](https://semver.org/)
|
|
- 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 `bumpversion --config-file .bumpversion.cfg [major | minor | patch]`
|
|
- 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](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 have `setuptools` and `twine` installed and that you
|
|
have registered for pypi and 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.)
|