Skip to content

Commit bfdb894

Browse files
committed
WILL_FAIL for the tcheck_version test doesn't need changing for release
branches - removed that instruction fromRELEASE_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 3f90c2e commit bfdb894

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

release_docs/RELEASE_PROCESS.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -85,25 +85,24 @@ For more information on the HDF5 versioning and backward and forward compatibili
8585
- or create the new branch in GitHub GUI.
8686
4. Check that required CMake files point to the specific versions of the third-party software (szip, zlib and plugins) that they depend on.
8787
- Update as needed.
88-
5. Change the **support** branch to X.Y.{Z+1}-1 using the [bin/h5vers][u10] script:
88+
5. Change the **support** branch to X.Y.{Z+1}-1 (<dash>1) using the [bin/h5vers][u10] script:
8989
- `$ git checkout hdf5_X_Y`
9090
- `$ bin/h5vers -s X.Y.{Z+1}-1;`
9191
- `$ git commit -m "Updated support branch version number to X.Y.{Z+1}-1"`
9292
- `$ git push`
93-
6. Change the **release preparation branch**'s version number to X.Y.Z-{SR+1} using the [bin/h5vers][u10]/bin/h5vers script:
93+
6. Change the **release preparation branch**'s version number to X.Y.Z.1 using the [bin/h5vers][u10]/bin/h5vers script:
9494
- `$ git checkout hdf5_X_Y_Z;`
95-
- `$ bin/h5vers -s X.Y.Z-{SR+1};`
96-
- `$ git commit -m "Updated release preparation branch version number to X.Y.Z-{SR+1}"`
95+
- `$ bin/h5vers -s X.Y.Z.1;`
96+
- `$ git commit -m "Updated release preparation branch version number to X.Y.Z.1"`
9797
- `$ git push`
98-
7. Remove 'WILL_FAIL "true"' line for minor version check in test/CMakeTests.cmake (currently line 662). Minor branches are considered incompatible for develop, but not for release branches.
99-
8. ** OBSOLETE CURRENTLY **
98+
7. ** OBSOLETE CURRENTLY **
10099
Update default configuration mode
101100
- `$ git checkout hdf5_X_Y_Z;`.
102101
- Need to set option `HDF5_GENERATE_HEADERS` to `OFF`, currently in line 996 of [src/CMakeLists.txt][u11].
103102
- (use `git status --ignored` to see the changes and `git add -f` to add all files. First delete any new files not to be committed, notably `src/H5public.h~`.)
104103
- `$ git push with commit message listing change steps for creating release branch`
105104
** END OBSOLETE CURRENTLY **
106-
9. E-mail [email protected] 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.
105+
8. E-mail [email protected] 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.
107106

108107
### 8. Perform Release Testing (Test Automation Team | Release Manager | Project Leads)
109108
1. Verify that source and binary distributions of HDF5 are acceptable on all target operating environments.
@@ -113,9 +112,10 @@ For more information on the HDF5 versioning and backward and forward compatibili
113112
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.
114113
6. Select release build from workflow.
115114
7. Choose the release branch
116-
8. Change ‘Release version tag’ name to 'hdf5_X.Y.Z.P'
117-
- P is some pre-release number.
118-
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.
115+
8. Change ‘Release version tag’ name to 'X.Y.Z.P'
116+
- P is a pre-release number, starting at 1 for first pre-release.
117+
This will create a new tag 'vX.Y.Z.P'. The tag for the final release will be 'vX.Y.Z'
118+
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.
119119
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.
120120
11. This should be automated and currently github binaries are not signed.
121121
- 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.
@@ -210,7 +210,7 @@ For more information on the HDF5 versioning and backward and forward compatibili
210210
[u8]: https://github.com/HDFGroup/hdf5/blob/develop/.github/workflows/release.yml
211211
[u9]: https://github.com/HDFGroup/hdf5/blob/develop/config/lt_vers.am
212212
[u10]: https://github.com/HDFGroup/hdf5/blob/develop/bin/h5vers
213-
[u11]: https://github.com/HDFGroup/hdf5/blob/develop/src/CMakeLists.txt
213+
[u11]: https://github.com/HDFGroup/hdf5/blob/desvelop/src/CMakeLists.txt
214214
[u12]: https://github.com/HDFGroup/hdf5/blob/develop/configure.ac
215215
[u13]: https://support.hdfgroup.org/documentation/hdf5/latest/api-compat-macros.html
216216
[u14]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot-1.14

0 commit comments

Comments
 (0)