Release Steps

These are the specific steps to publish a release once all enhancements and updates have been merged to the main branch.

Software

1. Create a branch from the main one called issue#_vXYZ where # is the number of the issue related to the release preparation and XYZ is the target version number.

2. Update version.txt to the new version number.

3. Update latest version in releasenotes.md to the new version number.

4. Update version number in each submit.json reference unit test result for each test case (e.g. in the file testing/references/bestest_air/submit.json. Also update version tag in OpenAPI spec (currently in PR).

5. Add any new contributors to contributors.md.

6. Make PR to main branch and pass unit tests.

7. Update date on releasenotes.md and merge PR.

8. Create new release with tag based on main branch with version number and link to release notes in comment area.

9. Create a branch from the main called issue#_vXYZ_post

10. Update version.txt to <new version number>-dev as appropriate.

11. Update releasenotes.md to add new header with <new version number>-dev and xx/xx/xxxx date.

12. Update version number to <new version number>-dev in each submit.json reference unit test result for each test case (e.g. in the file testing/references/bestest_air/submit.json. Also update r_dev in test_get_version() in testing/utilities.py to <new version number>-dev. Also update version tag in OpenAPI spec (currently in PR).

13. Make PR to main branch, pass unit tests, merge PR, and close issue #.

Deploy Public Web Service

1. The tag of the new release in the steps above will invoke a GitHub action to build and publish images of web and worker as ibpsa packages with the release tag.

2. TBD

Website

1. Update text on Software page to reflect latest version number and release date.

2. Update menu text on Test Cases page to reflect test cases included in latest version.

3. Add new contributors to Contributors page.

4. Add new news post and link to GitHub release highlights and release notes.

5. Update user guide to reflect latest version, including text and sphinx configuration file.

6. Update design documentation to reflect latest version.