From f629104033fdf88e6eb8c43282502b8219849d0b Mon Sep 17 00:00:00 2001 From: John Chilton <jmchilton@gmail.com> Date: Fri, 8 May 2015 14:10:11 -0400 Subject: [PATCH] Update developing.rst for improved release process. --- docs/developing.rst | 12 ++++-------- tools/commit_version.py | 10 ++++++---- tools/new_version.py | 10 ++++++---- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/developing.rst b/docs/developing.rst index 316e379e..b8e0cc33 100644 --- a/docs/developing.rst +++ b/docs/developing.rst @@ -32,17 +32,13 @@ are fine. * Review ``git status`` for missing files. * Verify the latest Travis CI builds pass. +* ``make open-docs`` and review changelog. * ``make clean && make lint && make tests`` -* Update version info in ``pulsar/__init__.py`` (drop ``.dev0`` suffix). -* Update release date and description in ``HISTORY.rst``. -* ``make docs`` and review changelog. -* ``git add HISTORY.rst pulsar/__init__.py; git commit -m "Version <version>"`` +* ``python tools/commit_version.py <new_version>`` * ``make release`` * Review `Test PyPI site <https://testpypi.python.org/pypi/pulsar-app>`_ for errors. * Test intall ``pip install -i https://testpypi.python.org/pypi pulsar-app``. -* ``git tag <release>`` -* Update version info in ``pulsar/__init__.py`` (n+1.dev0) and create new entry in HISTORY.rst. -* ``git add HISTORY.rst pulsar/__init__.py; git commit -m "Start work on new version"`` -* ``git push origin`` +* ``python scripts/new_version.py <new_version>`` +* ``git push origin master`` * ``git push --tags origin`` diff --git a/tools/commit_version.py b/tools/commit_version.py index e10cc819..c82ce99d 100644 --- a/tools/commit_version.py +++ b/tools/commit_version.py @@ -7,7 +7,9 @@ import subprocess import sys +PROJECT_NAME = "pulsar" PROJECT_DIRECTORY = os.path.join(os.path.dirname(__file__), "..") +MOD_DIRECTORY = os.path.join(PROJECT_DIRECTORY, PROJECT_NAME) def main(argv): @@ -19,14 +21,14 @@ def main(argv): history = history.replace(".dev0", " (%s)" % today_str) open(history_path, "w").write(history) - planemo_mod_path = os.path.join(PROJECT_DIRECTORY, "planemo", "__init__.py") - mod = open(planemo_mod_path, "r").read() + mod_path = os.path.join(MOD_DIRECTORY, "__init__.py") + mod = open(mod_path, "r").read() mod = re.sub("__version__ = '[\d\.]*\.dev0'", "__version__ = '%s'" % version, mod) - mod = open(planemo_mod_path, "w").write(mod) + mod = open(mod_path, "w").write(mod) shell(["git", "commit", "-m", "Version %s" % version, - "HISTORY.rst", "planemo/__init__.py"]) + "HISTORY.rst", "%s/__init__.py" % PROJECT_NAME]) shell(["git", "tag", version]) diff --git a/tools/new_version.py b/tools/new_version.py index 6b2b9d9a..8d8515c4 100644 --- a/tools/new_version.py +++ b/tools/new_version.py @@ -6,7 +6,9 @@ import subprocess import sys +PROJECT_NAME = "pulsar" PROJECT_DIRECTORY = os.path.join(os.path.dirname(__file__), "..") +MOD_DIRECTORY = os.path.join(PROJECT_DIRECTORY, PROJECT_NAME) def main(argv): @@ -27,14 +29,14 @@ def main(argv): """ % version) open(history_path, "w").write(history) - planemo_mod_path = os.path.join(PROJECT_DIRECTORY, "planemo", "__init__.py") - mod = open(planemo_mod_path, "r").read() + mod_path = os.path.join(MOD_DIRECTORY, "__init__.py") + mod = open(mod_path, "r").read() mod = re.sub("__version__ = '[\d\.]+'", "__version__ = '%s.dev0'" % version, mod, 1) - mod = open(planemo_mod_path, "w").write(mod) + mod = open(mod_path, "w").write(mod) shell(["git", "commit", "-m", "Starting work on %s" % version, - "HISTORY.rst", "planemo/__init__.py"]) + "HISTORY.rst", "%s/__init__.py" % project_name]) def shell(cmds, **kwds): -- GitLab