diff --git a/docs/release_process.md b/docs/release_process.md index 0432df0d..6de49521 100644 --- a/docs/release_process.md +++ b/docs/release_process.md @@ -20,35 +20,36 @@ 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 + - 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` + - 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/)). +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 + - [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` +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 + - [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 + - [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 + - 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