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.

Sign up for GitHub

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

Jump to bottom

Create individual release notes source files #85250

Closed
lcawl opened this issue Mar 22, 2022 · 1 comment
Closed

Create individual release notes source files #85250

lcawl opened this issue Mar 22, 2022 · 1 comment
Assignees
@pugnascotia
Labels
:Delivery/Tooling Developer tooliing and automation >enhancement Team:Delivery Meta label for Delivery team

Comments

@lcawl
Copy link
Contributor

lcawl commented Mar 22, 2022

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.
@lcawl lcawl added >enhancement needs:triage Requires assignment of a team area label labels Mar 22, 2022
@lcawl lcawl mentioned this issue Mar 22, 2022
Open
@pugnascotia pugnascotia self-assigned this Mar 23, 2022
pugnascotia added a commit to pugnascotia/elasticsearch that referenced this issue Mar 23, 2022
@pugnascotia
Generate a release notes page per patch version
1e33e5b 
Closes elastic#85250. The approach of generating a single asciidoc page for all
releases in a minor series makes it harder to preserve any manual edits
that we have to make. Instead, generate a page per-version. It should
make little difference to the final documentation that users see.
@pugnascotia pugnascotia mentioned this issue Mar 23, 2022
Merged
@droberts195 droberts195 added :Delivery/Tooling Developer tooliing and automation and removed needs:triage Requires assignment of a team area label labels Mar 23, 2022
@elasticmachine elasticmachine added the Team:Delivery Meta label for Delivery team label Mar 23, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-delivery (Team:Delivery)

pugnascotia added a commit that referenced this issue Mar 23, 2022
@pugnascotia
Generate a release notes page per patch version (#85279)
c693f8c 
Closes #85250. The approach of generating a single asciidoc page for all
releases in a minor series makes it harder to preserve any manual edits
that we have to make. Instead, generate a page per-version. It should
make little difference to the final documentation that users see.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pugnascotia pugnascotia

Labels
:Delivery/Tooling Developer tooliing and automation >enhancement Team:Delivery Meta label for Delivery team
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@droberts195 @pugnascotia @elasticmachine @lcawl