From 49e968e39a771bdbe5675b2764e9a52cc24326f0 Mon Sep 17 00:00:00 2001 From: gknowles Date: Fri, 18 Nov 2022 06:58:47 -0800 Subject: [PATCH] Add merge of dev to master to release howto. --- docs/howto.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/howto.md b/docs/howto.md index 8ce6878..6df2eda 100644 --- a/docs/howto.md +++ b/docs/howto.md @@ -4,19 +4,24 @@ Distributed under the Boost Software License, Version 1.0. --> # Release checklist -1. Make sure tests pass +1. Be on the dev branch. +2. Make sure tests pass. - bin\cli --test -2. Verify code samples in the guide. +3. Verify code samples in the guide. - docgen test -3. Change "Unreleased" section in CHANGELOG.md to the new version. -4. Add new version to docs\docgen.xml. -5. Push to github. -6. Wait for CI to succeed. -7. Draft a new release on github. +4. Change "Unreleased" section in CHANGELOG.md to the new version. +5. Add new version to docs\docgen.xml. +6. Push to github. +7. Wait for CI to succeed. +8. Merge to master. + 1. git fetch origin master # fetch any possible changes from master + 2. git merge master # merge any changes from master back to dev + 2. git push origin dev:master # update master head to same as dev +9. Draft a new release on github. 1. Goto Releases, click on "Draft a new release" 2. Select "Choose a tag" and create the new tag "v{major}.{minor}.{patch}". 3. Write brief description and publish the release. -8. Publish the docs +10. Publish the docs 1. Run "docgen site" 2. Goto vendor\gh-pages directory 3. Review and push the new docs with description of "Update docs"