From 6f9399327e476510f00538969db0afd61e3828cd Mon Sep 17 00:00:00 2001 From: sfan5 Date: Sat, 26 Oct 2019 11:09:35 +0200 Subject: DOCS/release-policy.md: clarify a few details --- DOCS/release-policy.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/DOCS/release-policy.md b/DOCS/release-policy.md index 507f4c440e..9fb6255cc6 100644 --- a/DOCS/release-policy.md +++ b/DOCS/release-policy.md @@ -20,24 +20,28 @@ Release procedure While on master: -- Update the `RELEASE_NOTES` file. +- Update the `RELEASE_NOTES` file, replacing the previous release notes. - Update the `VERSION` file. - Update `DOCS/client-api-changes.rst` and `DOCS/interface-changes.rst` (in particular, update the last version numbers if necessary) -- Commit changes. +- Create signed commit with changes. - Create signed tag v0.X.Y. - Add -UNKNOWN suffix to version in `VERSION` file. -- Commit changes, push branch and tag to GitHub. +- Commit changes, push release branch (`release/0.X`) and tag to GitHub. - Create a new GitHub release using the content of `RELEASE_NOTES` related to the new version. +If necessary (to e.g. exclude commits already on master), the release can +be done on a branch with different commit history. The release branch **must** +then be merged to master so `git describe` will pick up the tag. + Release notes template ---------------------- -- cgit v1.2.3