Skip to content

Commit 7ad72b6

Browse files
lrknoxchristian-wojek
authored andcommitted
Semantic versioning update (HDFGroup#5944)
* Add instruction to verify library version compliance with sematic versioning with link to semantic versioning wiki page. Update H5.c and version tests for move of major and minor versions to 1st and 2nd version numbers. * WILL_FAIL for the tcheck_version doesn't need changing for release branches - removed that instruction from RELEASE_PROCESS. Change release version instructions to use x.y.z.1 for pre-release instead of x.y.z-1 as for develop snapshots.
1 parent fd38b5a commit 7ad72b6

File tree

4 files changed

+93
-39
lines changed

4 files changed

+93
-39
lines changed

release_docs/RELEASE_PROCESS.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ For more information on the HDF5 versioning and backward and forward compatibili
4949
7. Review and update all INSTALL_* files in [release_docs][u4], if needed.
5050
- [INSTALL][u5] should be general info and not require extensive changes
5151
- [INSTALL_CMake.txt][u7] are the instructions for building under CMake.
52+
8. Verify that [API Compatibility Macros][u13] are up to date for the release version.
5253

5354
### 4. Freeze Code (Release Manager | Test Automation Team)
5455
1. Transition from performing maintenance on software to preparing for its delivery.
@@ -57,7 +58,7 @@ For more information on the HDF5 versioning and backward and forward compatibili
5758
3. Be sure to complete all four steps to update so numbers for each deployed lib file in the process described in config/lt_vers.am and check that the .so numbers for lib files in binaries correctly indicate compatibility status with the previous release.
5859
4. Move all unresolved Milestone issues to the next release version in GitHub.
5960
5. Verify that frozen code branch satisfies all existing regression test cases, and give the 'OK' to the release coordinator once all daily test configurations are passing as expected after the date of the code freeze. If there are failing tests after the code freeze date, coordinate with maintainers responsible for the failures to ensure that either the changes causing the failures are corrected or reverted.
60-
6. Verify release branches for third-party software used: SZIP, ZLIB, and Plugins; and announce release versions to hdf5lib@hdfgroup.org.
61+
6. Verify released versions (latest) of third-party software used: SZIP, ZLIB, and Plugins; and announce release versions to hdf5lib@hdfgroup.org.
6162

6263
### 5. Update Interface Version (Release Manager | Product Manager)
6364
1. Verify interface additions, changes, and removals, and update the shared library interface version number.
@@ -71,9 +72,11 @@ For more information on the HDF5 versioning and backward and forward compatibili
7172
6. Confirm the necessity of and approve of any interface-breaking changes. If any changes need to be reverted, task the developer who made the change to do so as soon as possible. If a change is reverted, return to the previous step and regenerate the compatibility report after the changes is made. Otherwise, continue to the next step.
7273
7. Update the .so version numbers in the [config/lt_vers.am][u9] file in the support branch according to [libtool's library interface version](https://www.gnu.org/software/libtool/manual/libtool.html#Versioning) scheme.
7374
- See [Updating version info (Libtool)](https://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html#Updating-version-info) for rules to help update library version numbers.
74-
8. After the release branch has been created, run `./autogen.sh` to regenerate build system files on the release branch and commit the changes.
75+
8. After the release branch has been created, run bin/process_source.sh on the release branch to regenerate/update the H5E header files, H5ARG_TRACE macros, API version macros, and macros for detecting overflows for type conversion, then commit the changes.
7576

76-
### 6. Prepare Release Branch (Release Manager)
77+
### 6. Verify that HDF5 library version has been updated from the previous release according to [HDF5 versioning policy][u16], consistent with semantic versioning rules.
78+
79+
### 7. Prepare Release Branch (Release Manager)
7780
1. Get the release branch ready for pre-release testing and packaging.
7881
2. For all release preparation operations, the release coordinator will clone and push directly to canonical HDF5:
7982
- `$ git clone ​https://github.com/HDFGroup/hdf5.git`
@@ -83,15 +86,15 @@ For more information on the HDF5 versioning and backward and forward compatibili
8386
- or create the new branch in GitHub GUI.
8487
4. Check that required CMake files point to the specific versions of the third-party software (szip, zlib and plugins) that they depend on.
8588
- Update as needed.
86-
5. Change the **support** branch to X.Y.{Z+1}-1 using the [bin/h5vers][u10] script:
89+
5. Change the **support** branch to X.Y.{Z+1}-1 (\<dash>1) using the [bin/h5vers][u10] script:
8790
- `$ git checkout hdf5_X_Y`
8891
- `$ bin/h5vers -s X.Y.{Z+1}-1;`
8992
- `$ git commit -m "Updated support branch version number to X.Y.{Z+1}-1"`
9093
- `$ git push`
91-
6. Change the **release preparation branch**'s version number to X.Y.Z-{SR+1} using the [bin/h5vers][u10]/bin/h5vers script:
94+
6. Change the **release preparation branch**'s version number to X.Y.Z.1 using the [bin/h5vers][u10]/bin/h5vers script:
9295
- `$ git checkout hdf5_X_Y_Z;`
93-
- `$ bin/h5vers -s X.Y.Z-{SR+1};`
94-
- `$ git commit -m "Updated release preparation branch version number to X.Y.Z-{SR+1}"`
96+
- `$ bin/h5vers -s X.Y.Z.1;`
97+
- `$ git commit -m "Updated release preparation branch version number to X.Y.Z.1"`
9598
- `$ git push`
9699
7. ** OBSOLETE CURRENTLY **
97100
Update default configuration mode
@@ -102,17 +105,18 @@ For more information on the HDF5 versioning and backward and forward compatibili
102105
** END OBSOLETE CURRENTLY **
103106
8. E-mail hdf5lib@hdfgroup.org to indicate that the code freeze on the release support branch (i.e. hdf5_X_Y) has been lifted and development on the next maintenance release can resume. The code freeze will remain in place on the release preparation branch (i.e. hdf5_X_Y_Z) indefinitely.
104107

105-
### 7. Perform Release Testing (Test Automation Team | Release Manager | Project Leads)
108+
### 8. Perform Release Testing (Test Automation Team | Release Manager | Project Leads)
106109
1. Verify that source and binary distributions of HDF5 are acceptable on all target operating environments.
107110
2. Create a page on Confluence as a sub-page of the current release version's project collaboration page (see HDF5 Maintenance Releases) to document release testing results.
108111
3. Document the test procedure that will be used for this release on the new sub-page.
109112
4. Schedule daily stand-up meetings or other regular checkpoints to assure progress on testing tasks, and inform testing team of your expectations.
110113
5. Schedule and enable daily automated regression testing of the release preparation branch (i.e. hdf5_X_Y_Z). Give the 'OK' to proceed once all required tests have verified that HDF5 is functioning as intended on all target operating environments.
111114
6. Select release build from workflow.
112115
7. Choose the release branch
113-
8. Change ‘Release version tag’ name to 'hdf5_X.Y.Z.P'
114-
- P is some pre-release number.
115-
9. Send a message to the HDF forum indicating that a pre-release source package is available for testing at <e.g., <github.com releases URL>/{hdf5-X.Y.Z-P}> and that feedback from the user community on their test results is being accepted.
116+
8. Change ‘Release version tag’ name to 'X.Y.Z.P'
117+
- P is a pre-release number, starting at 1 for first pre-release.
118+
This will create a new tag 'vX.Y.Z.P'. The tag for the final release will be 'vX.Y.Z'
119+
9. Send a message to the HDF forum indicating that a pre-release source package is available for testing at <e.g., <github.com releases URL>/{hdf5-X.Y.Z.P}> and that feedback from the user community on their test results is being accepted.
116120
10. Contact paying clients who are interested in testing the pre-release source package and inform them that it is available for testing and that feedback on their test results of the pre-release is appreciated.
117121
11. This should be automated and currently github binaries are not signed.
118122
- Follow the [How to sign binaries with digital certificates(this is missing)]() work instructions to sign each Windows and Mac binary package with a digital certificate.
@@ -164,7 +168,7 @@ For more information on the HDF5 versioning and backward and forward compatibili
164168
19. Decide if another cycle of pre-release testing should occur based on the issue reports received and the actions taken during this cycle. If another round of testing is required (i.e. there were significant issues in pre-release testing which resulted in code changes), increment the subrelease version number and go back to step 7.2. If no further testing is required (i.e. no code changes were made and issues were documented as known issues, or code changes were trivial, unit tested, and exhaustive testing is unneeded), then proceed.
165169

166170

167-
### 8. Finalize Release Notes (Release Manager)
171+
### 9. Finalize Release Notes (Release Manager)
168172
1. Perform a final review of release notes and ensure that any new changes made to the source, any new known issues discovered, and any additional tests run since the code freeze have been reflected in CHANGELOG.md and other appropriate in-source documentation files (INSTALL_*, etc.). (Refer to the sub-steps of step 3 for what to check).
169173
2. Update the [CHANGELOG.md][u1] in the **support** branch (i.e. hdf5_X_Y) to remove entries in “Bugs fixed” and “New Features” sections and increment the version number for the following release (“Bug fixes since X.Y.Z” - occurs twice).
170174
- `$ git checkout hdf5_X_Y`
@@ -173,7 +177,7 @@ For more information on the HDF5 versioning and backward and forward compatibili
173177
- `$ git push`
174178
3. Update Release Notes in **release** branch (Release Manager)
175179

176-
### 9. Package and Distribute Release (Release Manager)
180+
### 10. Package and Distribute Release (Release Manager)
177181
1. h5vers could run genparser, which can change the generated files if certain code files have been changed since the files generated by genparser were committed on the release branch. This should be checked by running `git status --ignored;`, then running genparser, then repeating `git status --ignored;`. If there are modified files from either git status command, they should be committed (or deleted if there are backup files or an autom4te.cache directory), and at least minimal testing should be done to see that the software is still good with the changes.
178182
2. Set version for release, removing the subrelease string, initially `$ bin/h5vers -s X.Y.Z;`. Any subsequent patch releases will need the subrelease number.
179183
3. Run `bin/release` (similar to 8.2) and commit all the changed files.
@@ -192,9 +196,9 @@ For more information on the HDF5 versioning and backward and forward compatibili
192196
- Press "Run Workflow"
193197
8. Release hdf5_plugins following the same steps.
194198

195-
### 10. Add the contents of the CHANGELOG.md file in the release code to the HISTORY-X_Y file in the **support** branch, just below the introductory lines at the top of the HISTORY file.
199+
### 11. Add the contents of the CHANGELOG.md file in the release code to the HISTORY-X_Y file in the **support** branch, just below the introductory lines at the top of the HISTORY file.
196200

197-
### 11. Conduct Release Retrospective (Release Manager)
201+
### 12. Conduct Release Retrospective (Release Manager)
198202
1. Schedule time and solicit comments from retrospective
199203
2. Identify issues and document them
200204

@@ -212,3 +216,4 @@ For more information on the HDF5 versioning and backward and forward compatibili
212216
[u13]: https://support.hdfgroup.org/documentation/hdf5/latest/api-compat-macros.html
213217
[u14]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot-1.14
214218
[u15]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot
219+
[u16]: https://github.com/HDFGroup/hdf5/wiki/HDF5-Version-Numbers-and-Branch-Strategy

0 commit comments

Comments
 (0)