Skip to content

[release-notes] Update automation to use new markdown format #124161

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

Merged
merged 53 commits into from
May 28, 2025
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
e570274
wip - update release notes automation to use new markdown format
brianseeders Mar 5, 2025
0213a71
[CI] Auto commit changes from spotless
elasticsearchmachine Mar 5, 2025
ca352dd
More work on moving release notes automation to markdown
brianseeders Mar 6, 2025
a014db7
Merge branch 'docs-automation-md' of github.com:brianseeders/elastics…
brianseeders Mar 6, 2025
2b1a140
[CI] Auto commit changes from spotless
elasticsearchmachine Mar 6, 2025
30a1c61
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders Mar 11, 2025
364a306
Organizational changes based on direction from docs team, cleanup and…
brianseeders Mar 11, 2025
c153bcc
Merge branch 'docs-automation-md' of github.com:brianseeders/elastics…
brianseeders Mar 11, 2025
5a0b964
Update tests for release notes generation
brianseeders Mar 12, 2025
ac01289
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders Mar 12, 2025
8b1c3b8
Updated release notes and missed file
brianseeders Mar 12, 2025
a53b29a
wip adding release highlights
brianseeders Mar 13, 2025
e579524
Merge branch 'main' into docs-automation-md
brianseeders Mar 20, 2025
54873b4
Fix up release highlights, add tests
brianseeders Mar 20, 2025
7e398e7
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders Mar 21, 2025
0565295
Remove now unused release notes stuff
brianseeders Mar 21, 2025
1828db6
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders Mar 27, 2025
3ccb2f9
WIP changelog bundles for release notes
brianseeders Apr 1, 2025
b364002
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders Apr 1, 2025
674b441
[CI] Auto commit changes from spotless
elasticsearchmachine Apr 1, 2025
72e5313
Generate breaking-changes and deprecations as well
brianseeders Apr 7, 2025
4585378
Fixing 9.0.0 release notes
brianseeders Apr 7, 2025
c37ac17
Remove 9.1.0 bundle for now
brianseeders Apr 7, 2025
65413dd
Remove 9.1.0 release notes from 9.0.0
brianseeders Apr 14, 2025
21b6e83
Fix issue links
brianseeders Apr 14, 2025
51215d0
Fix more issue links
brianseeders Apr 14, 2025
6d6567a
Merge branch 'docs-automation-md' of github.com:brianseeders/elastics…
brianseeders Apr 28, 2025
2d40872
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders Apr 28, 2025
622bed4
Add prelim 9.0.1 release notes
brianseeders Apr 28, 2025
801ad68
Update 9.0.0 docs with changes from main
brianseeders Apr 29, 2025
b7915d0
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders Apr 29, 2025
b642cc5
Fix template
brianseeders Apr 29, 2025
80d16ec
WIP handling multiple releases in the docs, and update release notes …
brianseeders May 2, 2025
b5fa9e8
Fix the non-index pages
brianseeders May 2, 2025
0141be1
[CI] Auto commit changes from spotless
elasticsearchmachine May 2, 2025
71d5879
Fix template and add --bc-ref support
brianseeders May 5, 2025
8c3fe7d
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders May 5, 2025
d64b594
Merge branch 'docs-automation-md' of github.com:brianseeders/elastics…
brianseeders May 5, 2025
580f37d
Formatting
brianseeders May 6, 2025
ef8421f
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders May 6, 2025
5413020
Finalize 9.0.1 release notes
brianseeders May 6, 2025
99043b5
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders May 16, 2025
87ede2f
Tests for release note generation via bundles
brianseeders May 19, 2025
e6755ab
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders May 19, 2025
8efc0ea
[CI] Auto commit changes from spotless
elasticsearchmachine May 19, 2025
09f1810
Fixes
brianseeders May 20, 2025
c6e9c53
Merge branch 'docs-automation-md' of github.com:brianseeders/elastics…
brianseeders May 20, 2025
af7bd0a
Merge remote-tracking branch 'upstream/main' into docs-automation-md
brianseeders May 22, 2025
79dd5e6
Generate 9.0.2 release notes
brianseeders May 22, 2025
27a612f
Cleanup/etc
brianseeders May 22, 2025
d422d09
[CI] Auto commit changes from spotless
elasticsearchmachine May 22, 2025
8ff6ba1
Cleanup and comments
brianseeders May 22, 2025
47d8bfe
Merge branch 'docs-automation-md' of github.com:brianseeders/elastics…
brianseeders May 22, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public BundleChangelogsTask(ObjectFactory objectFactory, ExecOperations execOper
public void executeTask() throws IOException {
final String upstreamRemote = gitWrapper.getUpstream();

String ref = "main";
String ref = "9.0-fix-release-notes";
try {
checkoutChangelogs(gitWrapper, upstreamRemote, ref);
Properties props = new Properties();
Expand All @@ -101,6 +101,7 @@ public void executeTask() throws IOException {
private static void checkoutChangelogs(GitWrapper gitWrapper, String upstream, String ref) {
gitWrapper.updateRemote(upstream);
// TODO check for changes first
gitWrapper.runCommand("rm", "-rf", "docs/changelog");
gitWrapper.runCommand("git", "checkout", ref, "--", "docs/changelog");
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ public void executeTask() throws IOException {

LOGGER.info("Generating release notes...");
ReleaseNotesGenerator.update(this.releaseNotesTemplate.get().getAsFile(), this.releaseNotesFile.get().getAsFile(), bundles);
ReleaseNotesGenerator.update(this.breakingChangesTemplate.get().getAsFile(), this.breakingChangesFile.get().getAsFile(), bundles);
ReleaseNotesGenerator.update(this.deprecationsTemplate.get().getAsFile(), this.deprecationsFile.get().getAsFile(), bundles);

// Only update breaking changes and deprecations for new minors
// if (qualifiedVersion.revision() == 0) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,13 @@ If you are migrating from a version prior to version 9.0, you must first upgrade
To learn how to upgrade, check out <upgrade docs>.

% ## Next version [elasticsearch-nextversion-breaking-changes]

<%
for(bundle in changelogBundles) {
def version = bundle.version
def versionWithoutSeparator = bundle.versionWithoutSeparator
def changelogsByTypeByArea = bundle.changelogsByTypeByArea
def unqualifiedVersion = bundle.unqualifiedVersion
%>
## ${unqualifiedVersion} [elasticsearch-${versionWithoutSeparator}-breaking-changes]
<%
if (!changelogsByTypeByArea['breaking']) {
Expand All @@ -26,7 +32,7 @@ To learn how to upgrade, check out <upgrade docs>.
print "* ${change.summary} [#${change.pr}](https://github.com/elastic/elasticsearch/pull/${change.pr})"
if (change.issues != null && change.issues.empty == false) {
print change.issues.size() == 1 ? " (issue: " : " (issues: "
print change.issues.collect { "{es-issue}${it}[#${it}]" }.join(", ")
print change.issues.collect { "[#${it}](https://github.com/elastic/elasticsearch/issues/${it})" }.join(", ")
print ")"
}
print "\n"
Expand All @@ -35,3 +41,4 @@ To learn how to upgrade, check out <upgrade docs>.

print "\n\n"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ To give you insight into what deprecated features you’re using, {{es}}:
* [Provides a deprecation info API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-migration-deprecations) that scans a cluster’s configuration and mappings for deprecated functionality.

% ## Next version [elasticsearch-nextversion-deprecations]

<%
for(bundle in changelogBundles) {
def version = bundle.version
def versionWithoutSeparator = bundle.versionWithoutSeparator
def changelogsByTypeByArea = bundle.changelogsByTypeByArea
def unqualifiedVersion = bundle.unqualifiedVersion
%>
## ${unqualifiedVersion} [elasticsearch-${versionWithoutSeparator}-deprecations]
<%
if (!changelogsByTypeByArea['deprecation']) {
Expand All @@ -28,11 +34,12 @@ To give you insight into what deprecated features you’re using, {{es}}:
print "* ${change.summary} [#${change.pr}](https://github.com/elastic/elasticsearch/pull/${change.pr})"
if (change.issues != null && change.issues.empty == false) {
print change.issues.size() == 1 ? " (issue: " : " (issues: "
print change.issues.collect { "{es-issue}${it}[#${it}]" }.join(", ")
print change.issues.collect { "[#${it}](https://github.com/elastic/elasticsearch/issues/${it})" }.join(", ")
print ")"
}
print "\n"
}
}
print "\n\n"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ for (highlights in [notableHighlights, nonNotableHighlights]) {
for (highlight in highlights) { %>
::::{dropdown} ${highlight.title}
${highlight.body.trim()}

For more information, check [PR #${highlight.pr}](https://github.com/elastic/elasticsearch/pull/${highlight.pr}).
::::
<% }
}
Expand All @@ -60,7 +58,7 @@ for (changeType in ['features-enhancements', 'fixes', 'regression']) {
print "* ${change.summary} [#${change.pr}](https://github.com/elastic/elasticsearch/pull/${change.pr})"
if (change.issues != null && change.issues.empty == false) {
print change.issues.size() == 1 ? " (issue: " : " (issues: "
print change.issues.collect { "[#${change.pr}](https://github.com/elastic/elasticsearch/pull/${change.pr})" }.join(", ")
print change.issues.collect { "[#${it}](https://github.com/elastic/elasticsearch/issues/${it})" }.join(", ")
print ")"
}
print "\n"
Expand Down
92 changes: 87 additions & 5 deletions docs/release-notes/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,97 @@ To learn how to upgrade, check out <upgrade docs>.

% ## Next version [elasticsearch-nextversion-breaking-changes]

## 9.1.0 [elasticsearch-910-breaking-changes]
## 9.0.1 [elasticsearch-901-breaking-changes]

Discovery-Plugins:
* Upgrade `discovery-ec2` to AWS SDK v2 [#122062](https://github.com/elastic/elasticsearch/pull/122062)
No breaking changes in this version.

Infra/Logging:
* Rename deprecation index template [#125606](https://github.com/elastic/elasticsearch/pull/125606) (issue: {es-issue}125445[#125445])
## 9.0.0 [elasticsearch-900-breaking-changes]

Aggregations:
* Remove date histogram boolean support [#118484](https://github.com/elastic/elasticsearch/pull/118484)

Allocation:
* Increase minimum threshold in shard balancer [#115831](https://github.com/elastic/elasticsearch/pull/115831)
* Remove `cluster.routing.allocation.disk.watermark.enable_for_single_data_node` setting [#114207](https://github.com/elastic/elasticsearch/pull/114207)
* Remove cluster state from `/_cluster/reroute` response [#114231](https://github.com/elastic/elasticsearch/pull/114231) (issue: [#88978](https://github.com/elastic/elasticsearch/issues/88978))

Analysis:
* Snowball stemmers have been upgraded [#114146](https://github.com/elastic/elasticsearch/pull/114146)
* The 'german2' stemmer is now an alias for the 'german' snowball stemmer [#113614](https://github.com/elastic/elasticsearch/pull/113614)
* The 'persian' analyzer has stemmer by default [#113482](https://github.com/elastic/elasticsearch/pull/113482) (issue: [#113050](https://github.com/elastic/elasticsearch/issues/113050))
* The Korean dictionary for Nori has been updated [#114124](https://github.com/elastic/elasticsearch/pull/114124)

Authentication:
* Configuring a bind DN in an LDAP or Active Directory (AD) realm without a corresponding bind password
will prevent node from starting [#118366](https://github.com/elastic/elasticsearch/pull/118366)

Cluster Coordination:
* Remove unsupported legacy value for `discovery.type` [#112903](https://github.com/elastic/elasticsearch/pull/112903)

EQL:
* Set allow_partial_search_results=true by default [#120267](https://github.com/elastic/elasticsearch/pull/120267)

Extract&Transform:
* Restrict Connector APIs to manage/monitor_connector privileges [#119863](https://github.com/elastic/elasticsearch/pull/119863)

Highlighting:
* Remove support for deprecated `force_source` highlighting parameter [#116943](https://github.com/elastic/elasticsearch/pull/116943)

Indices APIs:
* Apply more strict parsing of actions in bulk API [#115923](https://github.com/elastic/elasticsearch/pull/115923)
* Remove deprecated local attribute from alias APIs [#115393](https://github.com/elastic/elasticsearch/pull/115393)
* Remove the ability to read frozen indices [#120108](https://github.com/elastic/elasticsearch/pull/120108)
* Remove unfreeze REST endpoint [#119227](https://github.com/elastic/elasticsearch/pull/119227)

Infra/Core:
* Change Elasticsearch timeouts to 429 response instead of 5xx [#116026](https://github.com/elastic/elasticsearch/pull/116026)
* Limit `ByteSizeUnit` to 2 decimals [#120142](https://github.com/elastic/elasticsearch/pull/120142)
* Remove `client.type` setting [#118192](https://github.com/elastic/elasticsearch/pull/118192) (issue: [#104574](https://github.com/elastic/elasticsearch/issues/104574))
* Remove any references to org.elasticsearch.core.RestApiVersion#V_7 [#118103](https://github.com/elastic/elasticsearch/pull/118103)

Infra/Logging:
* Change `deprecation.elasticsearch` keyword to `elasticsearch.deprecation` [#117933](https://github.com/elastic/elasticsearch/pull/117933) (issue: [#83251](https://github.com/elastic/elasticsearch/issues/83251))
* Rename deprecation index template [#125606](https://github.com/elastic/elasticsearch/pull/125606) (issue: [#125445](https://github.com/elastic/elasticsearch/issues/125445))

Infra/Metrics:
* Deprecated tracing.apm.* settings got removed. [#119926](https://github.com/elastic/elasticsearch/pull/119926)

Infra/REST API:
* Output a consistent format when generating error json [#90529](https://github.com/elastic/elasticsearch/pull/90529) (issue: [#89387](https://github.com/elastic/elasticsearch/issues/89387))

Ingest Node:
* Remove `ecs` option on `user_agent` processor [#116077](https://github.com/elastic/elasticsearch/pull/116077)
* Remove ignored fallback option on GeoIP processor [#116112](https://github.com/elastic/elasticsearch/pull/116112)

Logs:
* Conditionally enable logsdb by default for data streams matching with logs-*-* pattern. [#121049](https://github.com/elastic/elasticsearch/pull/121049) (issue: [#106489](https://github.com/elastic/elasticsearch/issues/106489))

Machine Learning:
* Disable machine learning on macOS x86_64 [#104125](https://github.com/elastic/elasticsearch/pull/104125)

Mapping:
* Remove support for type, fields, `copy_to` and boost in metadata field definition [#118825](https://github.com/elastic/elasticsearch/pull/118825)
* Turn `_source` meta fieldmapper's mode attribute into a no-op [#119072](https://github.com/elastic/elasticsearch/pull/119072) (issue: [#118596](https://github.com/elastic/elasticsearch/issues/118596))

Search:
* Adjust `random_score` default field to `_seq_no` field [#118671](https://github.com/elastic/elasticsearch/pull/118671)
* Change Semantic Text To Act Like A Normal Text Field [#120813](https://github.com/elastic/elasticsearch/pull/120813)
* Remove legacy params from range query [#116970](https://github.com/elastic/elasticsearch/pull/116970)

Snapshot/Restore:
* Remove deprecated `xpack.searchable.snapshot.allocate_on_rolling_restart` setting [#114202](https://github.com/elastic/elasticsearch/pull/114202)

TLS:
* Drop `TLS_RSA` cipher support for JDK 24 [#123600](https://github.com/elastic/elasticsearch/pull/123600)
* Remove TLSv1.1 from default protocols [#121731](https://github.com/elastic/elasticsearch/pull/121731)

Transform:
* Remove `data_frame_transforms` roles [#117519](https://github.com/elastic/elasticsearch/pull/117519)

Vector Search:
* Remove old `_knn_search` tech preview API in v9 [#118104](https://github.com/elastic/elasticsearch/pull/118104)

Watcher:
* Removing support for types field in watcher search [#120748](https://github.com/elastic/elasticsearch/pull/120748)


Loading
Loading