Skip to content

Commit

Permalink
Add merge of dev to master to release howto.
Browse files Browse the repository at this point in the history
  • Loading branch information
gknowles committed Nov 18, 2022
1 parent 2270e46 commit 49e968e
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions docs/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

0 comments on commit 49e968e

Please sign in to comment.