chore: split release notes into separate files - #2861
Open
wpbonelli wants to merge 3 commits into
Open
Conversation
wpbonelli
marked this pull request as ready for review
June 28, 2026 12:02
mjr-deltares
approved these changes
Jul 1, 2026
mjr-deltares
left a comment
mjr-deltares
left a comment
Contributor
There was a problem hiding this comment.
I had no real problems merging, but no objections against this method either.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Instead of keeping release notes in a single file
doc/ReleaseNotes/develop.toml, store them as separate files in a directorydoc/ReleaseNotes/changes/, to be merged when generating the latex for PDF docs. This will avoid merge conflicts when notes are added to the bottom of a single file.