Skip to content

Commit

Permalink
doc: improved release doc
Browse files Browse the repository at this point in the history
  • Loading branch information
obilodeau committed Nov 7, 2019
1 parent 4f6ef51 commit 300a541
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions docs/devel.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<tag>` is replaced with previous release's tag:
+
git log <tag>.. --format="%aN" --reverse | perl -e 'my %dedupe; while (<STDIN>) { 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

0 comments on commit 300a541

Please sign in to comment.