Skip to content

Conversation

@l-trotta
Copy link
Contributor

@l-trotta l-trotta commented Dec 9, 2025

Backporting #5683

* Configure UpdateForV10 tag with eslint-plugin-jsdoc

We sometimes want to make breaking changes but have to wait until the next
major version. To not forget about those, this commit introduces an
UpdateForV10 JSDoc tag that can be used in any commment. There are a few
benefits of using JSDoc instead of a simple TODO comment:

 * With the allowlist of tags in our eslint config, we can't make typos
 * We enforce a proper description to explain why the breaking change needs to
   be made

Note that this tag has the same name as the Elasticsearch UpdateForV10 annotation, as
we'll migrate to Elasticsearch in the future.

* Run make spec-format-fix
@l-trotta l-trotta requested review from a team as code owners December 9, 2025 13:11
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2025

Following you can find the validation changes against the target branch for the APIs.

No changes detected.

You can validate these APIs yourself by using the make validate target.

@l-trotta l-trotta merged commit 328a1a4 into 9.2 Dec 9, 2025
9 checks passed
@l-trotta l-trotta deleted the backport-5683-to-9.2 branch December 9, 2025 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants