-
Notifications
You must be signed in to change notification settings - Fork 82
Update release notes ID format for automated URL generation #1152
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
Comments
Warning If the following aren't updated, GitHub release pages and their auto-generated emails will 404, which happened for 9.0.0. This is time sensitive for the following products as they have these autogenerated links:
But it would make sense for everybody to align here going forward ASAP :) |
Thanks for filing this, @leemthompo. I'm updating Security's release notes templates to enforce this new versioning format moving forward. |
For future release notes, section IDs should follow a specific pattern. This PR updates the ID template in related files. Rel: elastic/docs-content#1152
For future release notes, section IDs should follow a specific pattern. This PR updates the ID template in related files. Rel: elastic/docs-content#1152 (cherry picked from commit 9e082dd)
Updates release notes ID format following [docs-content#1152](elastic/docs-content#1152)
Updates release notes ID format following [docs-content#1152](elastic/docs-content#1152)
Updates release notes ID format following [docs-content#1152](elastic/docs-content#1152)
Updates release notes ID format following [docs-content#1152](elastic/docs-content#1152)
I believe elasticsearch-js is all fixed up with the right IDs now. |
@belimawr would you know who handles this for Beats? |
Will be ok for Kibana ✅ |
thanks to @kaisecheng for jumping on a hot fix for logstash before 9.0.1 release :) |
@leemthompo Thanks so much for taking care of Logstash doc release. This is the PR to update the ID format of release note auto generation |
change the format of release version from `900` to `9.0.0` for automated URL generation Relates: elastic/docs-content#1152
change the format of release version from `900` to `9.0.0` for automated URL generation Relates: elastic/docs-content#1152 (cherry picked from commit b9381af)
APM Server ID format should be covered by elastic/apm-server#16817 However, I don't think the apm server id change will have any effect at all because https://github.com/elastic/unified-release/pull/2364 links to observability changelog instead of elastic apm changelog . Is it expected? |
change the format of release version from `900` to `9.0.0` for automated URL generation Relates: elastic/docs-content#1152 (cherry picked from commit b9381af) Co-authored-by: kaisecheng <69120390+kaisecheng@users.noreply.github.com>
Right, judging by the current structure and the new ID format, 9.0.1 will be at |
@leemthompo, I was on PTO, I'm only seeing it now. It seems Beats is already done, but let me know if more help is needed. |
Summary
We need to update the format of IDs in our release notes to support automated URL generation in GitHub release pages.
Description
We learned that automated URLs in GitHub release pages (such as https://github.com/elastic/elasticsearch/releases/tag/v9.0.0) require our IDs to be of the form
X.x.x
.See https://github.com/elastic/unified-release/pull/2364 for the format required by the release team.
Required changes
#foo-901-release-notes
to#foo-9.0.1-release-notes
<MINOR_VERSION>
variableExample
Current format:
#elasticsearch-901-release-notes
New format:
#elasticsearch-9.0.1-release-notes
Priority
This should be implemented for the upcoming 9.0.1 release and all future releases.
Note
We don't need to retroactively update the 900 ids
Folks concerned
Borrowed from docs release 😝
The text was updated successfully, but these errors were encountered: