Skip to content

Conversation

@brtnfld
Copy link
Collaborator

@brtnfld brtnfld commented Jan 7, 2026

Also, derived all the version information for H5public.h


Important

Update version to 2.1 and derive version information from H5public.h, removing h5vers script and updating CMake and Java configurations.

  • Versioning:
    • Update version to 2.1 in H5public.h.
    • Derive version strings in H5public.h using macros.
  • CMake:
    • Extract version from H5public.h in HDF5config.cmake and HDF5AsSubdirMacros.cmake.
    • Configure README.md and CHANGELOG.md using CMakeLists.txt.
  • Java:
    • Generate H5Version.java from H5public.h for version consistency.
    • Update H5.java to use H5Version for version constants.
  • Removals:
    • Delete bin/h5vers script, previously used for version management.

This description was created by Ellipsis for 0127f3a. You can customize this summary. It will automatically update as commits are pushed.

Java Version Synchronization
Self-Contained version information for CMake Files
bin/h5vers no longer needed for version updates
@brtnfld
Copy link
Collaborator Author

brtnfld commented Jan 8, 2026

Remove the use of .in files for docs. Update the README.md file, updated the timeline chart.
Added a progress badge for blocker and must do

@brtnfld
Copy link
Collaborator Author

brtnfld commented Jan 8, 2026

@loricooperhdf, please review the README.md, https://github.com/brtnfld/hdf5/tree/vers

I'm not sure the JAVA section needs to be called out; it should probably be handled like the other subtopics

This commit adds the shared files that were referenced in commit e401a86
but were accidentally not included:

- config/cmake/HDF5VersionParsing.cmake: Shared version parsing module
- config/cmake/templates/H5Version.java.in: Single Java version template

Also adds documentation for the code quality improvements:
- CODE_QUALITY_IMPROVEMENTS.md: Comprehensive documentation
- DRY_IMPROVEMENTS.md: DRY-specific documentation

These files are required by the changes in commit e401a86.
Added two dynamic badges that track release blocker progress:
- Release Blockers badge (links to Project HDFGroup#39)
- Release Must Do badge (links to Project HDFGroup#39)

Badges are updated automatically by the update-progress workflow
and display completion percentage with color coding.
Wrapped the example #define statements in @code blocks to prevent
Doxygen from treating them as link references.

Fixes errors:
- error: explicit link request to 'define' could not be resolved
Moved detailed Maven configuration (XML snippets, platforms, repositories)
to the dedicated documentation file HDF5Examples/JAVA/README-MAVEN.md.

The main README now has a concise section with a link to the detailed guide,
following the principle of keeping the main README focused and scannable.
Changed from Zenodo's badge format to shields.io static badge format
to ensure reliable rendering. The DOI link still points to the correct
Zenodo record.
@loricooperhdf
Copy link
Contributor

@loricooperhdf, please review the README.md, https://github.com/brtnfld/hdf5/tree/vers

I'm not sure the JAVA section needs to be called out; it should probably be handled like the other subtopics

This readme is nice and clean. I like it and find no issues. I don't know any way to reduce the significance of the JAVEA text, I think it's fine.

@brtnfld
Copy link
Collaborator Author

brtnfld commented Jan 8, 2026

I moved the Java blurb to another file and just referenced that.

Moved H5Version.java.in from config/cmake/templates/ to java/templates/
for better organization. Java code should live in the java/ directory tree,
not in config/cmake/.

Changes:
- Created java/templates/ directory
- Moved H5Version.java.in to java/templates/
- Updated both CMakeLists.txt files to reference new location
- Removed empty config/cmake/templates/ directory

This maintains the single source of truth for the Java version template
while placing it in a more logical location.
Replaced emoji characters (📖 🚀 ⚡) with standard markdown bullet points
for a more professional appearance in the Quick Start section.
@hyoklee
Copy link
Member

hyoklee commented Jan 10, 2026

Copy link
Member

@hyoklee hyoklee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HDF5Examples/JAVA/README-MAVEN.md needs update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To be triaged

Development

Successfully merging this pull request may close these issues.

5 participants