Skip to content

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.

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
Open
leemthompo opened this issue Apr 15, 2025 · 6 comments
Open

Update release notes ID format for automated URL generation #1152

leemthompo opened this issue Apr 15, 2025 · 6 comments
Labels
release-notes Team:DocsEng Issues owned by the Docs Engineering Team Team:Obs Issues owned by the Observability Docs Team Team:Platform Issues owned by the Platform Docs Team Team:Projects Issues owned by the Docs Org Team:Search Issues owned by the Search Docs Team Team:Security Issues owned by the Security Docs Team

Comments

@leemthompo
Copy link
Contributor

leemthompo commented Apr 15, 2025 •
edited by KOTungseth
Loading

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

  • Update the ID format in release notes from #foo-901-release-notes to #foo-9.0.1-release-notes
  • This change enables the release team to auto-generate URLs with each commit using their <MINOR_VERSION> variable

Example

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 😝

Product Assignees Updated
Docs eng @elastic/docs-engineering TODO
APM Server @elastic/obs-ds-intake-services TODO
Beats @kilfoyle ✅
Elasticsearch @brianseeders TODO
Elasticsearch Hadoop @jbaiera TODO
Elasticsearch Java Client @l-trotta TODO
Elasticsearch JavaScript Client @JoshMock ✅
Elasticsearch .NET Client @flobernd TODO
Elasticsearch PHP Client @ezimuel TODO
Elasticsearch Python Client @pquentin TODO
Elasticsearch Ruby Client @picandocodigo TODO
Fleet & Agent @kilfoyle ✅
Kibana @florent-leborgne @wajihaparvez ✅
Logstash @kaisecheng TODO
Observability @KOTungseth ✅
Security @nastasha-solomon ✅
@leemthompo
Copy link
Contributor Author

leemthompo commented Apr 15, 2025 •
edited
Loading

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:

  • Elasticsearch
  • Kibana
  • APM-Server
  • Beats
  • Elastic-Agent
  • Elasticsearch-Hadoop
  • Logstash

But it would make sense for everybody to align here going forward ASAP :)

@nastasha-solomon nastasha-solomon mentioned this issue Apr 15, 2025
Merged
@nastasha-solomon
Copy link
Contributor

Thanks for filing this, @leemthompo. I'm updating Security's release notes templates to enforce this new versioning format moving forward.

nastasha-solomon added a commit that referenced this issue Apr 15, 2025
@nastasha-solomon
[Security] Update release notes ID format for automated URL generation (
0c97bd6 
#1153)

Updates templates for the Security release notes to enforce the correct
version format in section headers.

Related issue: #1152
@bmorelli25 bmorelli25 added the needs-team Issues pending triage by the Docs Team label Apr 17, 2025
@florent-leborgne florent-leborgne mentioned this issue Apr 22, 2025
Merged
florent-leborgne added a commit to elastic/kibana that referenced this issue Apr 22, 2025
@florent-leborgne
[Docs] Release notes ID structure template (#218782)
9e082dd 
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
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Apr 22, 2025
@florent-leborgne
[Docs] Release notes ID structure template (elastic#218782)
5768163 
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)
@leemthompo leemthompo added Team:Security Issues owned by the Security Docs Team Team:Obs Issues owned by the Observability Docs Team Team:Platform Issues owned by the Platform Docs Team Team:DocsEng Issues owned by the Docs Engineering Team Team:Projects Issues owned by the Docs Org Team:Search Issues owned by the Search Docs Team and removed needs-team Issues pending triage by the Docs Team labels Apr 22, 2025
picandocodigo added a commit to elastic/elasticsearch-ruby that referenced this issue Apr 23, 2025
@picandocodigo
[DOCS] Release notes 9.0.1
044b79c 
Updates release notes ID format following [docs-content#1152](elastic/docs-content#1152)
picandocodigo added a commit to elastic/elasticsearch-ruby that referenced this issue Apr 23, 2025
@picandocodigo
[DOCS] Release notes 9.0.1
9bcfd89 
Updates release notes ID format following [docs-content#1152](elastic/docs-content#1152)
@picandocodigo picandocodigo mentioned this issue Apr 23, 2025
Merged
picandocodigo added a commit to elastic/elasticsearch-ruby that referenced this issue Apr 23, 2025
@picandocodigo
[DOCS] Release notes 9.0.1
1013e03 
Updates release notes ID format following [docs-content#1152](elastic/docs-content#1152)
picandocodigo added a commit to elastic/elasticsearch-ruby that referenced this issue Apr 24, 2025
@picandocodigo
[DOCS] Release notes 9.0.1
a483ed1 
Updates release notes ID format following [docs-content#1152](elastic/docs-content#1152)
@JoshMock
Copy link
Member

I believe elasticsearch-js is all fixed up with the right IDs now.

@leemthompo
Copy link
Contributor Author

@belimawr would you know who handles this for Beats?

@florent-leborgne
Copy link
Contributor

Will be ok for Kibana ✅

@leemthompo leemthompo mentioned this issue Apr 30, 2025
Draft
@leemthompo
Copy link
Contributor Author

thanks to @kaisecheng for jumping on a hot fix for logstash before 9.0.1 release :)

@kaisecheng kaisecheng mentioned this issue May 6, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
release-notes Team:DocsEng Issues owned by the Docs Engineering Team Team:Obs Issues owned by the Observability Docs Team Team:Platform Issues owned by the Platform Docs Team Team:Projects Issues owned by the Docs Org Team:Search Issues owned by the Search Docs Team Team:Security Issues owned by the Security Docs Team
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@JoshMock @bmorelli25 @florent-leborgne @leemthompo @nastasha-solomon