Create individual release notes source files #85250
Labels
:Delivery/Tooling
Developer tooliing and automation
>enhancement
Team:Delivery
Meta label for Delivery team
Description
Per elastic/ml-cpp#2217 (comment), there have been some issues with the release notes that are generated by the
./gradlew generateReleaseNotes
command. In particular, if there are changes that were manually added to the release notes (either during the PR review or via subsequent edits), it seems easy to accidentally overwrite/lose those edits the next time there's a release that touches the same file.IMO one simple solution would be to generate a new output file for each release. For example,
https://www.elastic.co/guide/en/elasticsearch/reference/8.1/release-notes-8.1.1.html and https://www.elastic.co/guide/en/elasticsearch/reference/8.1/release-notes-8.1.0.html are currently being generated from a single source file (https://github.com/elastic/elasticsearch/blob/8.1/docs/reference/release-notes/8.1.asciidoc), but there's no reason why they can't be generated from individual files (e.g. 8.1.1.asciidoc and 8.1.0.asciidoc) instead.
It would mean the need to add a new "include" statement in https://github.com/elastic/elasticsearch/blob/master/docs/reference/release-notes.asciidoc every time, but since you're already adding a new link to that file anyway (e.g. <<release-notes-8.1.1>>) that doesn't seem like it should be too taxing.
The text was updated successfully, but these errors were encountered: