From 4f9b2081ca5a978a49ed464dbee36522ae29c44f Mon Sep 17 00:00:00 2001 From: Romain Dorgueil Date: Mon, 1 May 2017 19:03:56 +0200 Subject: [PATCH] draft of release manual --- docs/contribute/release.rst | 38 +++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/contribute/release.rst diff --git a/docs/contribute/release.rst b/docs/contribute/release.rst new file mode 100644 index 0000000..8e40f08 --- /dev/null +++ b/docs/contribute/release.rst @@ -0,0 +1,38 @@ +Releases +======== + +WORK IN PROGRESS, THIS DOC IS UNFINISHED AND JUST RAW NOTES TO HELP ME RELEASING STUFF. + +How to make a patch release? +:::::::::::::::::::::::::::: + +For now, reference at http://rdc.li/r + +Additional checklist: + +* make format + +How to make a minor or major release? +::::::::::::::::::::::::::::::::::::: + +Releases above patch level are more complex, because we did not find a way not to hardcode the version number in a bunch +of files, and because a few dependant services (source control, continuous integration, code coverage, documentation +builder ...) also depends on version numbers. + +Checklist: + +* Files +* Github + + +Recipes +::::::: + +Get current minor:: + + git semver | python -c 'import sys; print(".".join(sys.stdin.read().strip().split(".")[0:2]))' + +Open git with all files containing current minor:: + + ack `git semver | python -c 'import sys; print("\\\\.".join(sys.stdin.read().strip().split(".")[0:2]))'` | vim - +