Back to Elasticsearch

Elasticsearch breaking changes [elasticsearch-breaking-changes]

build-tools-internal/src/main/resources/templates/breaking-changes.md

9.4.02.1 KB
Original Source

Elasticsearch breaking changes [elasticsearch-breaking-changes]

Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the Elasticsearch breaking changes and take the necessary steps to mitigate any issues.

If you are migrating from a version prior to version 9.0, you must first upgrade to the last 8.x version available. To learn how to upgrade, check out Upgrade.

% ## Next version [elasticsearch-nextversion-breaking-changes] <% for(bundle in changelogBundles) { def version = bundle.version def versionForIds = bundle.version.toString().equals('9.0.0') ? bundle.versionWithoutSeparator : bundle.version def changelogsByTypeByArea = bundle.changelogsByTypeByArea def unqualifiedVersion = bundle.unqualifiedVersion def coming = !bundle.bundle.released

if (coming) {
    print "\n"
    print "```{applies_to}\n"
    print "stack: ga ${version}\n"
    print "```"
}

%>

${unqualifiedVersion} [elasticsearch-${versionForIds}-breaking-changes]

<% if (!changelogsByTypeByArea['breaking']) { print "There are no breaking changes associated with this release.\n" } else { for (team in (changelogsByTypeByArea['breaking'] ?: [:]).keySet()) { print "${team}:\n";

        for (change in changelogsByTypeByArea['breaking'][team]) {
            if (!change.entryOverride) {
                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 { "[#${it}](https://github.com/elastic/elasticsearch/issues/${it})" }.join(", ")
                    print ")"
                }
            } else {
                print change.entryOverride;
            }
            print "\n"
        }
        print "\n"
    }

    print "\n"
}

}