From d1908694c4337444f97d26abb62633c619fc4f19 Mon Sep 17 00:00:00 2001 From: John Erling Blad Date: Sun, 2 Aug 2020 18:53:29 +0200 Subject: [PATCH] linted release page --- RELEASE.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 6781a815..8b6ab467 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -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` - - 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 - in `~/.github-token` + +- 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 github token with `public_repo` access + in `~/.github-token`