release: fix up RELEASE.md

This commit is contained in:
Peter F. Patel-Schneider 2020-05-09 09:51:12 -04:00 committed by Filipe Laíns
parent 67b7d46844
commit 3a2593798e
1 changed files with 4 additions and 3 deletions

View File

@ -3,11 +3,12 @@
###### Please read before making a release. ###### Please read before making a release.
We support two type of releases: normal releases (ex. `1.0.0`) and release We support two type of releases: normal releases (ex. `1.0.0`) and release
candidates (ex. `1.0.0-rc1`). Release candidates must have a `-rcX` prefix. candidates (ex. `1.0.0rc1`). Release candidates must have a `rcX` suffix.
Release routine: Release routine:
- Update the ChangeLog and setup.py to the new version and create a commit - Update ChangeLog, setup.py, lib/solaar/__init__.py, and docs/_config.yml to the new version
- Release commits must start with `release VERSION` - Create a commit that starts with `release VERSION`
- Push commit to Solaar repository
- Invoke `./release.sh` - Invoke `./release.sh`
- Git tags are signed so you must have GPG set up - Git tags are signed so you must have GPG set up
- You are required to have a have a github token with `public_repo` access - You are required to have a have a github token with `public_repo` access