Steps for Releasing New Version

When it is time to release a new version of reference tools (either a minor or major version), you can follow the two procedures below.

Pre-release steps:

1. If necessary, update the copyright year in the following files:
   • apply_license.sh
   • docs/api/footer.html
   • docs/api/header.tex
2. Ensure the license markings are all up-to-date using:

   ./build.sh apply-license

   and if necessary commit and push the updates to the main branch.
3. Verify that all issues and PRs targeting the associated milestone are completed or closed.

Release steps for a new version (e.g., X.Y.Z):

1. From a clone of the repo:
   1. Update the RPM packaging and latest tag for the new release by running the following and then editing the changelog entry.

      tito tag --use-version=X.Y.Z

   2. Commit and push the updates to the main branch.
2. On the repo's main page, click on "Releases" in the right side bar
3. Go to Draft a new release, then under "select a tag", select the version tag (e.g. "vX.Y.Z") for this release
4. Specify the release title "BSL vX.Y.Z", generate release notes for the changelog, set it as the latest release, then publish
5. Close the associated milestone after the release, verifying that there are no open issues or PRs
6. Re-run the RPM-building job in the main branch Packages workflow to produce packages with the new version tag.

Documentation updates for major or minor version releases:

1. Update the titles of Product Guide and User Guide to reflect new version
2. Update the Section 1.1 "Identification" table for both guides to reflect new version
3. Update the Section 1.4 cross-references to other BSL docs for their new title
4. Add a new release item and, if necessary, update the copyright year in the following files:
   • product-guide/docinfo.xml.in
   • user-guide/docinfo.xml.in