release.sh: document release process
Signed-off-by: Filipe Laíns <lains@archlinux.org>
This commit is contained in:
parent
79be4b20d7
commit
442a7d18a5
|
@ -0,0 +1,14 @@
|
||||||
|
# Solaar releases
|
||||||
|
|
||||||
|
###### Please read before making a 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.
|
||||||
|
|
||||||
|
Release routine:
|
||||||
|
- Update the ChangeLog and setup.py to the new version and create a commit
|
||||||
|
- Release commits must start with `release VERSION`
|
||||||
|
- 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`
|
|
@ -74,7 +74,8 @@ else
|
||||||
echo "Local branch: $branch"
|
echo "Local branch: $branch"
|
||||||
echo "Remote branch: $remote_branch"
|
echo "Remote branch: $remote_branch"
|
||||||
fi
|
fi
|
||||||
echo
|
|
||||||
|
echo -e '\nPlease read RELEASE.md before continuing.\n'
|
||||||
|
|
||||||
read -p 'Are you sure you want to proceed? (y/n) ' -n 1 -r < /dev/tty
|
read -p 'Are you sure you want to proceed? (y/n) ' -n 1 -r < /dev/tty
|
||||||
echo
|
echo
|
||||||
|
|
Loading…
Reference in New Issue