fork/cellxgene
1
0
Fork 0
mirror of https://github.com/chanzuckerberg/cellxgene.git synced 2026-10-03 03:08:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix formatting issues (#468)

Browse Source 
- Fix step 8 bullets
- Appropriate capitalization
- Add link to release notes doc
This commit is contained in:
Charlotte Weaver
2018-11-26 13:52:00 -08:00
committed by GitHub
parent f2612707bb
commit 43a4e087ef
1 changed files with 16 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/release_process.md
+16 -15
View File
@@ -20,35 +20,36 @@ Follow these steps to create a release.
1. Preparation: 1. Preparation:
- Define the release version number, using [semantic versioning](https://semver.org/) - 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` 2. Create a release branch, eg, `release-version`
3. In the release branch: 3. In the release branch:
- run `bumpversion --config-file .bumpversion.cfg [major | minor | patch]` - Run `bumpversion --config-file .bumpversion.cfg [major | minor | patch]`
- clean up existing environment using `bin/clean` - Clean up existing environment using `bin/clean`
- build the JS asserts using `bin/build-client` - Build the JS asserts using `bin/build-client`
4. Commit and push the new branch 4. Commit and push the new branch
5. Create a PR for the release. 5. Create a PR for the release.
- [optional] As needed, conduct PR review. - [optional] As needed, conduct PR review.
6. Merge to master 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 - Draft new release
- Type version name matching release version number from (1) - Type version name matching release version number from (1)
- Select `master` as release branch (ensure you merged the release PR) - Select `master` as release branch (ensure you merged the release PR)
- Type title `Release {version num}` - 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 - Publish Release
8. Publish to pypi by performing the following steps 8. Publish to pypi by performing the following steps (assumes you have `setuptools` and `twine` installed and that you
(assumes you have `setuptools` and `twine` installed and that you have have registered for pypi and have write access to the cellxgene pypi package)
registered for pypi and have write access to the cellxgene pypi package) - Build the distribution by calling
- build the distribution by calling `python setup.py sdist`
`python setup.py sdist`
inside the top-level directory 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/*` `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` `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/*` - Upload the package to real pypi using `twine upload dist/*`
- [optional] test the installation in a fresh virtual environment using - [optional] Test the installation in a fresh virtual environment using
`pip install cellxgene` `pip install cellxgene`
The optional steps are for testing purposes, and are recommended The optional steps are for testing purposes, and are recommended