Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct doxygen GH pages folder for release #4395

Merged
merged 10 commits into from
Apr 12, 2024

Conversation

byrnHDF
Copy link
Contributor

@byrnHDF byrnHDF commented Apr 12, 2024

No description provided.

@byrnHDF byrnHDF added Priority - 0. Blocker ⛔ This MUST be merged for the release to happen Component - Documentation Doxygen, markdown, etc. Type - Bug / Bugfix Please report security issues to help@hdfgroup.org instead of creating an issue on GitHub labels Apr 12, 2024
@byrnHDF byrnHDF self-assigned this Apr 12, 2024
@byrnHDF byrnHDF closed this Apr 12, 2024
@byrnHDF byrnHDF reopened this Apr 12, 2024
@lrknox
Copy link
Collaborator

lrknox commented Apr 12, 2024

We realized that the links in the code to doxygen documentation all point to doxygen files in a directory that will be updated as soon as there is a daily build for the hdf5_1_14 branch, and those doxygen pages will show HDF5 version 1.14.5-1. Also documentation will be updated for any hdf5 1.14.5 code changes as soon as they are committed. This PR will create a dedicated and static v1_14_4 directory in github pages for the 1.14.4 documentation.

The changes to be made are exclusively documentation. Since the 1.14.4 release files were public since yesterday and there are documentation changes in the code (links), we believe will need to create a 1.14.4.1 release from hdf5_1.14.4.1 tag. The hdf5_1.14.4 tag remains, and will not be affected by these changes. The changes for the 1.14.4.1 release will remain a choice to be made until the release workflow is run.

The Check Markdown links test will fail until the release workflow creates the new directory.

@byrnHDF byrnHDF requested a review from epourmal as a code owner April 12, 2024 14:15
@lrknox lrknox merged commit a5ebb82 into HDFGroup:hdf5_1_14_4 Apr 12, 2024
56 of 57 checks passed
@byrnHDF byrnHDF deleted the hdf5_1_14_4-doxy-fix branch April 15, 2024 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 0. Blocker ⛔ This MUST be merged for the release to happen Type - Bug / Bugfix Please report security issues to help@hdfgroup.org instead of creating an issue on GitHub
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants