Creating Releases

This document gives information on releases and in particular, how to create them.

General Information

Releases in XBraid are assigned a number of the form MAJOR.MINOR.PATCH, where an increment in one of the digits denotes the following (in general):

• MAJOR - major changes, note that this must be incremented if backward incompatible (API changes)
• MINOR - new features
• PATCH - bug fixes or other trivial changes

This approach is based loosely on Semantic Versioning, but ultimately the decision about any particular release name is subjective.

Creating New Releases

1. Decide on a version number, per above, and change the following text-strings to the correct value:

   • braid/docs/developer_manual_header.tex ... & {\Large Version 2.0.0} \
   • braid/docs/user_manual_header.tex ... & {\Large Version 2.0.0} \

2. Update CHANGELOG to reflect important changes reflected in the commit history

3. Make sure that the regression tests pass cleanly (see Testing).

4. Review documentation, especially braid/docs/user_manual.pdf

5. Commit and push any final changes for release

6. Create release tag with the command

   git tag -a vMAJOR.MINOR.PATCH -m "XBraid version MAJOR.MINOR.PATCH"

7. Commit your new tag with the commit message

   git push origin --tags

8. Go to the Releases-->Tags Page, and edit the release notes.

   • Drag and drop the user_manual.pdf and developer_manual.pdf into the release notes to upload them, or they can be added as separate assets.
   • Add this string "See CHANGELOG for details of new features."

9. Double check the links for the manuals and tar-balls