Skip to content

Commit

Permalink
Update files based on issues discovered during release
Browse files Browse the repository at this point in the history
  • Loading branch information
byrnHDF committed Feb 5, 2025
1 parent e9ab45f commit b6c2df1
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 20 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/publish-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ jobs:
run: |
aws s3 sync ./${{ inputs.file_name }}.doxygen s3://${{ secrets.AWS_S3_BUCKET }}/${{ vars.TARGET_PATH }}/${{ inputs.target_dir }}/documentation/doxygen --delete
- name: Uncompress compatability reports (Linux)

Check failure on line 61 in .github/workflows/publish-release.yml

View workflow job for this annotation

GitHub Actions / Check for spelling errors

compatability ==> compatibility
run: unzip ${{ github.workspace }}/HDF5/${{ inputs.file_name }}.html.abi.reports.tar.gz

- name: Sync compatability reports to S3 bucket

Check failure on line 64 in .github/workflows/publish-release.yml

View workflow job for this annotation

GitHub Actions / Check for spelling errors

compatability ==> compatibility
run: |
aws s3 sync ./hdf5 s3://${{ secrets.AWS_S3_BUCKET }}/${{ vars.TARGET_PATH }}/${{ inputs.target_dir }}/compat_report --delete
- name: Sync userguide to latest S3 bucket
run: |
aws s3 sync ./${{ inputs.file_name }}.doxygen s3://${{ secrets.AWS_S3_BUCKET }}/documentation/hdf5/latest --delete
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/release-files.yml
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,8 @@ jobs:
if: ${{ (inputs.use_environ == 'release') }}
uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1
with:
tag_name: "${{ inputs.use_tag }}"
tag_name: "v${{ inputs.use_tag }}"
name: "HDF5 Release ${{ inputs.use_tag }}"
prerelease: false
body_path: description.txt
files: |
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/tarball.yml
Original file line number Diff line number Diff line change
Expand Up @@ -145,16 +145,16 @@ jobs:
id: ren-basename
if: ${{ (inputs.use_environ == 'release') && (inputs.use_tag == 'snapshot') }}
run: |
mv hdf5-${{ steps.version.outputs.SOURCE_TAG }}.tar.gz ${{ inputs.use_tag }}.tar.gz
mv hdf5-${{ steps.version.outputs.SOURCE_TAG }}.zip ${{ inputs.use_tag }}.zip
mv hdf5-${{ steps.version.outputs.SOURCE_TAG }}.tar.gz hdf5-${{ inputs.use_tag }}.tar.gz
mv hdf5-${{ steps.version.outputs.SOURCE_TAG }}.zip hdf5-${{ inputs.use_tag }}.zip
shell: bash

- name: Copy the release file source to a non-versioned file name
id: cp-to-non-versioned
if: ${{ (inputs.use_environ == 'release') }}
run: |
cp ${{ inputs.use_tag }}.tar.gz hdf5.tar.gz
cp ${{ inputs.use_tag }}.zip hdf5.zip
cp hdf5-${{ inputs.use_tag }}.tar.gz hdf5.tar.gz
cp hdf5-${{ inputs.use_tag }}.zip hdf5.zip
shell: bash

- name: List files in the repository
Expand Down
14 changes: 8 additions & 6 deletions config/cmake/examples/HDF5_Examples.cmake.in
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,14 @@ if(DEFINED CTEST_SCRIPT_ARG)
endforeach()
endif()

if(${CTEST_VSVERS} STREQUAL "64_VS2022") # 64-bit Visual Studio 2022
set(CTEST_CMAKE_GENERATOR "Visual Studio 17 2022")
set(CMAKE_GENERATOR_ARCHITECTURE "x64")
elseif(${VS_VERS} STREQUAL "64_VS2019") # 64-bit Visual Studio 2019
set(CTEST_CMAKE_GENERATOR "Visual Studio 16 2019")
set(CMAKE_GENERATOR_ARCHITECTURE "x64")
if(DEFINED CTEST_VSVERS)
if(${CTEST_VSVERS} STREQUAL "64_VS2022") # 64-bit Visual Studio 2022
set(CTEST_CMAKE_GENERATOR "Visual Studio 17 2022")
set(CMAKE_GENERATOR_ARCHITECTURE "x64")
elseif(${VS_VERS} STREQUAL "64_VS2019") # 64-bit Visual Studio 2019
set(CTEST_CMAKE_GENERATOR "Visual Studio 16 2019")
set(CMAKE_GENERATOR_ARCHITECTURE "x64")
endif()
endif()

###################################################################
Expand Down
15 changes: 8 additions & 7 deletions release_docs/RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,22 +180,23 @@ For more information on the HDF5 versioning and backward and forward compatibili
3. Update Release Notes in **release** branch (Release Manager)

### 9. Package and Distribute Release (Release Manager)
1. h5vers will run autogen.sh, which can change the generated files if certain code files have been changed since the files generated by autogen.sh were committed on the release branch. This should be checked by running `git status --ignored;`, then running autogen.sh, 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.
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.
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.
3. Run `bin/release` (similar to 8.2) and commit all the changed files.
4. Select release build from workflow.
4. Select the actions tab and the release build workflow, then click the 'Run workflow' drop-down.
- Choose the release branch
- Change ‘Release version tag’ name to 'hdf5_X.Y.Z'
- Enter the ‘Release version tag’ name as 'X.Y.Z'
- Press "Run Workflow"
5. Review the release files in Github
6. Edit the Github Release and change status to Release
- Change status from Pre-release to Release
7. Select publish-release build from workflow.
7. Select publish-release build from workflow, then click the 'Run workflow' drop-down.
- Choose the release branch
- Change ‘HDF5 Release version tag’ name to 'hdf5_X.Y.Z'
- Change 'HDF5 Release file name base' to 'hdf5-X.Y.Z'
- Change 'HDF5 target bucket directory' to 'vX_Y/vX_Y_Z'
- Enter the ‘HDF5 Release version tag’ name as 'X.Y.Z'
- Enter the 'HDF5 Release file name base' as 'hdf5-X.Y.Z'
- Enter the 'HDF5 target bucket directory' as 'vX_Y/vX_Y_Z'
- Press "Run Workflow"
8. Release hdf5_plugins following the same steps.

### 10. Add the contents of the RELEASE.txt 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.

Expand Down
4 changes: 2 additions & 2 deletions release_docs/USING_CMake_Examples.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ Default installation process:
HDF5_Examples_options.cmake file.

If the defaults are okay, execute from this directory:
ctest -S HDF5_Examples.cmake -C Release -V -O test.log
ctest -S HDF5_Examples.cmake -C Release -VV -O test.log
If the defaults need change, execute from this directory:
ctest -S HDF5_Examples.cmake,CTEST_SOURCE_NAME=MyExamples,INSTALLDIR=MyLocation -C Release -V -O test.log
ctest -S HDF5_Examples.cmake,CTEST_SOURCE_NAME=MyExamples,INSTALLDIR=MyLocation -C Release -VV -O test.log

When executed, the ctest script will save the results to the log file, test.log, as
indicated by the ctest command. If you wish to see more build and test information,
Expand Down

0 comments on commit b6c2df1

Please sign in to comment.