linted release page

This commit is contained in:
John Erling Blad 2020-08-02 18:53:29 +02:00 committed by Peter F. Patel-Schneider
parent b5bb04b8a2
commit d1908694c4
1 changed files with 9 additions and 8 deletions

View File

@ -1,15 +1,16 @@
# Solaar releases
###### 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
candidates (ex. `1.0.0rc1`). Release candidates must have a `rcX` suffix.
Release routine:
- Update ChangeLog, setup.py, lib/solaar/__init__.py, and docs/_config.yml to the new version
- Create a commit that starts with `release VERSION`
- Push commit to Solaar repository
- Invoke `./release.sh`
- Update ChangeLog, setup.py, lib/solaar/__init__.py, and docs/_config.yml to the new version
- Create a commit that starts with `release VERSION`
- Push commit to Solaar repository
- Invoke `./release.sh`
- 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 github token with `public_repo` access
in `~/.github-token`