From 3529e2565ff58628a0c695ffb23c8ae9e79a83e9 Mon Sep 17 00:00:00 2001 From: bshifaw Date: Tue, 17 Oct 2023 11:00:37 -0400 Subject: [PATCH 1/4] Added steps to make release in dev docs --- developer_docs/README.md | 6 +++--- developer_docs/publish_release.md | 7 +++++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/developer_docs/README.md b/developer_docs/README.md index 87ecc65f..33d130e1 100644 --- a/developer_docs/README.md +++ b/developer_docs/README.md @@ -25,10 +25,10 @@ the Cromshell development environment can be set up by the following steps: After following the above development environment setup steps, cromshell should have been added to your path. -Run `cromshell-alpha --help` to confirm installation. +Run `cromshell --help` to confirm installation. - > cromshell-alpha --help - Usage: cromshell-alpha [OPTIONS] COMMAND [ARGS]... + > cromshell --help + Usage: cromshell [OPTIONS] COMMAND [ARGS]... Cromshell is a script for submitting workflows to a cromwell server and monitoring / querying their results. diff --git a/developer_docs/publish_release.md b/developer_docs/publish_release.md index 9767c088..a07fc297 100644 --- a/developer_docs/publish_release.md +++ b/developer_docs/publish_release.md @@ -2,6 +2,13 @@ Cromshell can be installed from a brew tap or through pypi. Instructions on how to publish to these repos are detailed below. + +## Steps Summary +1. Set the correct version for the repository using bumpversion and merge changes to main. +2. Create a GitHub release. The release notes may be subdivided by "Feature Additions" and "Bug Fixes". +3. Publish on Brew. +4. Publish on PyPi. + ## Brew Tap Regular update of broadinstitute/dsp tap is needed as new releases of Cromshell are made. From 9c99f4db2966f66a5f146b9f0009b0a4ab191a8a Mon Sep 17 00:00:00 2001 From: bshifaw Date: Tue, 17 Oct 2023 14:08:29 -0400 Subject: [PATCH 2/4] =?UTF-8?q?Bump=20version:=202.0.0=20=E2=86=92=202.1.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 2 +- pyproject.toml | 2 +- setup.py | 2 +- src/cromshell/__main__.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 4014fbb2..400c1508 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.0.0 +current_version = 2.1.0 commit = True tag = True tag_name = {new_version} diff --git a/pyproject.toml b/pyproject.toml index 7ee37619..0e76219a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta" [project] name = "cromshell" # Version number is automatically set via bumpversion. DO NOT MODIFY: -version = "2.0.0" +version = "2.1.0" readme = "README.md" diff --git a/setup.py b/setup.py index 61ae9d91..ba847913 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ # https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure # Version number is automatically set via bumpversion. DO NOT MODIFY: -version = "2.0.0" +version = "2.1.0" setup( name="cromshell", version=version, diff --git a/src/cromshell/__main__.py b/src/cromshell/__main__.py index 22052e43..d2bc32b1 100644 --- a/src/cromshell/__main__.py +++ b/src/cromshell/__main__.py @@ -23,7 +23,7 @@ # Version number is automatically set via bumpversion. # DO NOT MODIFY: -__version__ = "2.0.0" +__version__ = "2.1.0" # Create a logger for this module: LOGGER = logging.getLogger(__name__) From 16b4105318eb0777d5eb4d2ad79954da86437d9b Mon Sep 17 00:00:00 2001 From: bshifaw Date: Tue, 17 Oct 2023 14:08:48 -0400 Subject: [PATCH 3/4] =?UTF-8?q?Bump=20version:=202.1.0=20=E2=86=92=202.1.1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 2 +- pyproject.toml | 2 +- setup.py | 2 +- src/cromshell/__main__.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 400c1508..02854053 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.1.0 +current_version = 2.1.1 commit = True tag = True tag_name = {new_version} diff --git a/pyproject.toml b/pyproject.toml index 0e76219a..2f2d20b8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta" [project] name = "cromshell" # Version number is automatically set via bumpversion. DO NOT MODIFY: -version = "2.1.0" +version = "2.1.1" readme = "README.md" diff --git a/setup.py b/setup.py index ba847913..c4407e65 100644 --- a/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ # https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure # Version number is automatically set via bumpversion. DO NOT MODIFY: -version = "2.1.0" +version = "2.1.1" setup( name="cromshell", version=version, diff --git a/src/cromshell/__main__.py b/src/cromshell/__main__.py index d2bc32b1..6a753b58 100644 --- a/src/cromshell/__main__.py +++ b/src/cromshell/__main__.py @@ -23,7 +23,7 @@ # Version number is automatically set via bumpversion. # DO NOT MODIFY: -__version__ = "2.1.0" +__version__ = "2.1.1" # Create a logger for this module: LOGGER = logging.getLogger(__name__) From 2753118f3adbbd7294455c523f36ba4b631def64 Mon Sep 17 00:00:00 2001 From: bshifaw Date: Tue, 17 Oct 2023 14:10:42 -0400 Subject: [PATCH 4/4] added bumpversion example usage --- developer_docs/publish_release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer_docs/publish_release.md b/developer_docs/publish_release.md index a07fc297..178662c2 100644 --- a/developer_docs/publish_release.md +++ b/developer_docs/publish_release.md @@ -4,7 +4,7 @@ Cromshell can be installed from a brew tap or through pypi. Instructions on how ## Steps Summary -1. Set the correct version for the repository using bumpversion and merge changes to main. +1. Set the correct version for the repository using bumpversion and merge changes to main. (e.g. `bumpversion --new-version 2.1.1 minor`) 2. Create a GitHub release. The release notes may be subdivided by "Feature Additions" and "Bug Fixes". 3. Publish on Brew. 4. Publish on PyPi.