From 3475f3f12e3691b1f23fa349d679ddbef3a16821 Mon Sep 17 00:00:00 2001 From: Charlotte Weaver Date: Fri, 16 Nov 2018 14:36:43 -0800 Subject: [PATCH] Update release_process.md (#443) * Update release_process.md * Clarified release process --- bin/clean | 2 ++ docs/release_process.md | 12 ++++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/bin/clean b/bin/clean index e989035f..3ba2a395 100755 --- a/bin/clean +++ b/bin/clean @@ -7,6 +7,8 @@ echo "removing node_modules" rm -rf $CELLXGENE_DIR/client/node_modules echo "removing client_build" rm -rf $CELLXGENE_DIR/client/build +echo "removing dist" +rm -rf $CELLXGENE_DIR/dist echo "removing egg-info" rm -rf $CELLXGENE_DIR/cellxgene.egg-info echo "removing static files" diff --git a/docs/release_process.md b/docs/release_process.md index f944d6ee..0432df0d 100644 --- a/docs/release_process.md +++ b/docs/release_process.md @@ -24,12 +24,20 @@ Follow these steps to create a release. 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. Create Github release using the version number and release notes ([instructions](https://help.github.com/articles/creating-releases/)). -7. Publish to pypi by performing the following steps +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