Process for updating release notes after a release

Our newish process for creating release notes is working well: https://guides.dataverse.org/en/5.5/developers/making-releases.html#write-release-notes

However, updating release notes after a release can be problematic. There is drift between the live release notes and the version in git.

Here are the failure scenarios:

• A pull request updates the version in git but the change doesn't make it to the live notes.
• The live notes are edited and the change is not propogated back to git. (This is less of a problem for end users and impossible for 4.15 and below where release notes aren't even in git.)

Possible solutions:

• Delete the version from git as part of the release process. No syncing to worry about. Only one source of truth. This is how the release notes are pre 4.16 anyway.
• As part of the merge process, copy the content from the updated file in git to the live release note.
• Write scripts to check if the files in git and the live release notes are in sync.
• Automate pushing content from the files in git to the live release notes.

Questions:

• With millions of projects on GitHub, we aren't the only one with this problem, are we? What do other projects do?
• Having the files in git makes it easier for contributors to edit the release notes. Should we keep this?

Start with the release-note process described in the linked making-releases guide and compare the version stored in git with the live release notes. Review the listed synchronization and single-source-of-truth options, then define a concrete process and how completion would verify that both versions remain consistent.