Open
Description
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 | ✅ |
Beats | @kilfoyle | ✅ |
Elasticsearch | @brianseeders | ✅ |
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 | ✅ |
Observability | @KOTungseth | ✅ |
Security | @nastasha-solomon | ✅ |