diff options
| author | Marcus Müller <marcus.mueller@ettus.com> | 2018-06-13 03:07:39 +0200 |
|---|---|---|
| committer | Marcus Müller <marcus@hostalia.de> | 2018-06-25 15:29:36 +0200 |
| commit | 92e1e161ec6aad2cd998a003de2317167f058d2f (patch) | |
| tree | 8ecbc4b672ae34d8a51a7e9c87c926c37e314236 /docs/doxygen | |
| parent | 1fbfe152e13ee694e8fbd120b3a0022dfb6a87cb (diff) | |
adding documentation on how to release
Diffstat (limited to 'docs/doxygen')
| -rw-r--r-- | docs/doxygen/other/releasing.dox | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/doxygen/other/releasing.dox b/docs/doxygen/other/releasing.dox new file mode 100644 index 0000000000..1ed3c37ad5 --- /dev/null +++ b/docs/doxygen/other/releasing.dox @@ -0,0 +1,25 @@ +/*! \page page_releasing Release Process Documentation + +\section Preparation + +\li make sure a clean build works +\li Check whether all significant changes are in CHANGELOG +\li List of contributors `git log --format="* %aN <%aE>" vLASTRELEASE..HEAD | sort -u > /tmp/authors.txt` +\li Check for ABI / API break, determine Version (MAJOR.MINOR.ABI.PATCH) +\li Change [unreleased] to [MAJOR.MINOR.ABI.PATCH] in CHANGELOG +\li Update version in CMakeList +\li Commit with message: `git commit -m "Release MAJOR.MINOR.ABI.PATCH" CMakeLists.txt CHANGELOG.md +\li prepare release statement / tag annotation file: copy last Tag's annotation format (basically, contributors top, new Changelog bottom + +\section Release Tagging + +\li `git tag --annotate --sign -F /path/to/release_statement.md vMAJOR.MINOR.ABI.PATCH` +\li `git push yourrepo vMAJOR.MINOR.ABI.PATCH && hub pull-request -b {master|maint-MAJOR.MINOR}` +\li let CI do its thing; if that's OK: +\li `git push origin {master|maint-MAJOR.MINOR} vMAJOR.MINOR.ABI.PATCH` +\li on github, mark release + +\section Creation Of Archives + +\li `git checkout vMAJOR.MINOR.ABI.PATCH; git submodule update` should be clean +\li `gnuradio/dtools/bin/roll-tarball.sh` |