linted release page
This commit is contained in:
parent
b5bb04b8a2
commit
d1908694c4
17
RELEASE.md
17
RELEASE.md
|
@ -1,15 +1,16 @@
|
||||||
# Solaar releases
|
# 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
|
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.
|
candidates (ex. `1.0.0rc1`). Release candidates must have a `rcX` suffix.
|
||||||
|
|
||||||
Release routine:
|
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`
|
- Update ChangeLog, setup.py, lib/solaar/__init__.py, and docs/_config.yml to the new version
|
||||||
- Push commit to Solaar repository
|
- Create a commit that starts with `release VERSION`
|
||||||
- Invoke `./release.sh`
|
- Push commit to Solaar repository
|
||||||
- Git tags are signed so you must have GPG set up
|
- Invoke `./release.sh`
|
||||||
- You are required to have a have a github token with `public_repo` access
|
- Git tags are signed so you must have GPG set up
|
||||||
in `~/.github-token`
|
- You are required to have a github token with `public_repo` access
|
||||||
|
in `~/.github-token`
|
||||||
|
|
Loading…
Reference in New Issue