Skip to content

Commit

Permalink
Document release process
Browse files Browse the repository at this point in the history
  • Loading branch information
walles committed Aug 3, 2021
1 parent 6e1f84f commit 2c56575
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/nutti/fake-bpy-module/issues/92> 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
22 changes: 22 additions & 0 deletions release.sh
Original file line number Diff line number Diff line change
@@ -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 > "

0 comments on commit 2c56575

Please sign in to comment.