-
Notifications
You must be signed in to change notification settings - Fork 75
Release Steps
These are the specific steps to publish a release once all enhancements and updates have been merged to the main branch.
-
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.
-
Update
version.txt
to the new version number. -
Update latest version in
releasenotes.md
to the new version number. -
Update version number in each
submit.json
reference unit test result for each test case (e.g. in the filetesting/references/bestest_air/submit.json
. -
Add any new contributors to
contributors.md
. -
Make PR to main branch and pass unit tests.
-
Update date on
releasenotes.md
and merge PR. -
Create new release with tag based on main branch with version number and link to release notes in comment area.
-
Create a branch from the main called issue#_vXYZ_post
-
Update
version.txt
to<new version number>-dev
as appropriate. -
Update
releasenotes.md
to add new header with<new version number>-dev
and xx/xx/xxxx date. -
Update version number to
<new version number>-dev
in eachsubmit.json
reference unit test result for each test case (e.g. in the filetesting/references/bestest_air/submit.json
. Also updater_dev
intest_get_version()
intesting/utilities.py
to<new version number>-dev
. -
Make PR to main branch, pass unit tests, merge PR, and close issue #.
-
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.
-
TBD
-
Update text on
Software
page to reflect latest version number and release date. -
Update menu text on
Test Cases
page to reflect test cases included in latest version. -
Add new contributors to
Contributors
page. -
Add new news post and link to GitHub release highlights and release notes.
-
Update user guide to reflect latest version, including text and sphinx configuration file.
-
Update design documentation to reflect latest version.