mirror of
https://github.com/chanzuckerberg/cellxgene.git
synced 2026-10-07 08:48:11 +08:00
Update release_process.md (#443)
* Update release_process.md * Clarified release process
This commit is contained in:
@@ -7,6 +7,8 @@ echo "removing node_modules"
|
|||||||
rm -rf $CELLXGENE_DIR/client/node_modules
|
rm -rf $CELLXGENE_DIR/client/node_modules
|
||||||
echo "removing client_build"
|
echo "removing client_build"
|
||||||
rm -rf $CELLXGENE_DIR/client/build
|
rm -rf $CELLXGENE_DIR/client/build
|
||||||
|
echo "removing dist"
|
||||||
|
rm -rf $CELLXGENE_DIR/dist
|
||||||
echo "removing egg-info"
|
echo "removing egg-info"
|
||||||
rm -rf $CELLXGENE_DIR/cellxgene.egg-info
|
rm -rf $CELLXGENE_DIR/cellxgene.egg-info
|
||||||
echo "removing static files"
|
echo "removing static files"
|
||||||
|
|||||||
+10
-2
@@ -24,12 +24,20 @@ Follow these steps to create a release.
|
|||||||
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`
|
||||||
- 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. Create Github release using the version number and release notes ([instructions](https://help.github.com/articles/creating-releases/)).
|
6. Merge to master
|
||||||
7. Publish to pypi by performing the following steps
|
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
|
(assumes you have `setuptools` and `twine` installed and that you 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
|
||||||
|
|||||||
Reference in New Issue
Block a user