From 2c565754fcc2646e2046e872eca8aadc52cf028f Mon Sep 17 00:00:00 2001 From: Johan Walles Date: Tue, 3 Aug 2021 07:30:45 +0200 Subject: [PATCH] Document release process --- README.md | 20 ++++++++++++++------ release.sh | 22 ++++++++++++++++++++++ 2 files changed, 36 insertions(+), 6 deletions(-) create mode 100755 release.sh diff --git a/README.md b/README.md index 4c8fd99..737e9ec 100644 --- a/README.md +++ b/README.md @@ -56,19 +56,27 @@ I have developed this with: - The [Fake Blender Python API module collection](https://github.com/nutti/fake-bpy-module) in a virtualenv - Blender 2.93.1 +## Making a New Release + +Run `release.sh` and follow instructions. + ## TODO -- Document a release process +- Make an initial release - Document install instructions higher up in this document +- Announce on BlenderNation +- Fix user reported issues +- Publish on Blender Market +- Profile and see what can easily be sped up - Fix the tracks list tooltip, the current text makes no sense: "Active Bad Track / Double click to rename." -- Profile and see what can easily be sped up -- Ignore locked tracks, assumng they have been manually vetted? +- Ignore locked tracks, assuming they have been manually vetted? - Add a `tox.ini` with: - `mypy` after gets fixed - `pylint` - `black` code formatting, format locally and verify in CI - Add a `tox` Github action for PRs and pushes -- Announce on BlenderNation -- Fix user reported issues -- Publish on Blender Market + +### DONE + +- Document a release process diff --git a/release.sh b/release.sh new file mode 100755 index 0000000..f7cad0b --- /dev/null +++ b/release.sh @@ -0,0 +1,22 @@ +#!/bin/bash + +# https://sipb.mit.edu/doc/safe-shell/ +set -euf -o pipefail + +echo "Please decide on a new version number in 1.2.3 format" +read -r -p "Press RETURN > " + +echo "Please make an annotated tag with git tag --annotate VERSION" +read -r -p "Press RETURN > " + +echo "Please: cp __init__.py find_bad_tracks-VERSION.py" +read -r -p "Press RETURN > " + +echo "Please update the version number in find_bad_tracks-VERSION.py" +read -r -p "Press RETURN > " + +echo "Please: git push --tags" +read -r -p "Press RETURN > " + +echo "Please upload find_bad_tracks-VERSION.py to the Github release page" +read -r -p "Press RETURN > "