Add release script

README.rst

@@ -117,20 +117,7 @@ Publishing Release
 Release Script
 --------------
 
-The full release recipe (for local running) looks like this:
-
-..  code-block:: bash
-
-   PUNCOVER_VERSION=x.y.z
-   # little sed magic to update the version in the code
-   sed -i -r 's/(.*__version_info__ = )\(.*\)/\1\('"$(echo ${PUNCOVER_VERSION} | sed 's/\./, /g')"'\)/g' puncover/version.py
-   git add . && git commit -m "Bump version to ${PUNCOVER_VERSION}"
-   git tag -a {-m=,}${PUNCOVER_VERSION}
-   git push && git push --tags
-   python setup.py sdist bdist_wheel
-   twine upload dist/*
-   gh release create --generate-notes ${PUNCOVER_VERSION}
-   gh release upload ${PUNCOVER_VERSION} dist/*
+See ``scripts/release.sh`` for a script that automates the above steps.
 
 Contributing
 ============

release.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# Script used to execute a puncover release:
+#
+# 1. Update the version in the code
+# 2. Commit the change
+# 3. Tag the commit
+# 4. Push the commit and the tag
+# 5. Build the package
+# 6. Upload the package to PyPI
+# 7. Create a release on GitHub
+# 8. Upload the package to the release on GitHub
+#
+# It can be run for example like so:
+#
+# PUNCOVER_VERSION=0.1.0 ./release.sh
+
+set -euo pipefail
+
+if [[ -z "${PUNCOVER_VERSION:-}" ]]; then
+    echo "PUNCOVER_VERSION must be set"
+    exit 1
+fi
+
+# check if tag already exists
+if git rev-parse -q --verify "refs/tags/${PUNCOVER_VERSION}"; then
+    echo "Tag ${PUNCOVER_VERSION} already exists"
+    exit 1
+fi
+
+PUNCOVER_VERSION_COMMA_DELIMITED=$(echo ${PUNCOVER_VERSION} | sed 's/\./, /g')
+
+if grep -q "${PUNCOVER_VERSION_COMMA_DELIMITED}" puncover/version.py; then
+    echo "Version ${PUNCOVER_VERSION} already set in puncover/version.py"
+    exit 1
+fi
+
+# little sed magic to update the version in the code
+sed -i -r 's/(.*__version_info__ = )\(.*\)/\1\('"${PUNCOVER_VERSION_COMMA_DELIMITED}"'\)/g' puncover/version.py
+git add . && git commit -m "Bump version to ${PUNCOVER_VERSION}"
+git tag -a {-m=,}${PUNCOVER_VERSION}
+python setup.py sdist bdist_wheel
+
+read -p "Ready to push to GitHub and publish to PyPi? " -n 1 -r
+echo    # move to a new line
+if [[ $REPLY =~ ^[Yy]$ ]]
+then
+    git push && git push --tags
+    twine upload dist/*
+    gh release create --generate-notes ${PUNCOVER_VERSION}
+    gh release upload ${PUNCOVER_VERSION} dist/*
+fi