diff --git a/docs/devel.adoc b/docs/devel.adoc index dddde9924..a56064f68 100644 --- a/docs/devel.adoc +++ b/docs/devel.adoc @@ -2,25 +2,27 @@ == Making a release -// TODO +NOTE: This is a work in progress -. Update the changelog -** Generate author list with: +.Update the changelog +* You can generate author list with where `` is replaced with previous release's tag: + git log .. --format="%aN" --reverse | perl -e 'my %dedupe; while () { print unless $dedupe{$_}++}' | sort -+ -** linkify issues with vim's: `%s/#\(\d\d\)/{uri-issue}\1[#\1]/gc` -. Prepare release commit -** commit msg: Prepare %version% release -** release commit (--allow-empty) msg: Release %version% +.Prepare release commit +* Update version in `setup.py` +* commit msg: Prepare %version% release +* You can optionally do a release commit (with `--allow-empty` if needed) msg: Release %version% + +.Tag the release commit +* Annotated Tag msg: Version %version% -. Tag the release commit -** Annotated Tag msg: Version %version% +.Push your changes (don't forget the tag!) -. Push your changes (including the tag) -. Make a release on github (from changelog and copy from previous releases) +.Make a release on github (from changelog and copy sections themes from previous releases) +* linkify issues with vim's: `%s/{uri-issue}\d\+\[#\(\d\+\)\]/#\1/gc` -. Update version in `setup.py` (+1 bugfix, append 'dev') and commit -** commit msg: Begin development on next release +.Post-release +* Update version in `setup.py` (+1 bugfix, append 'dev') and commit +* commit msg: Begin development on next release