-
Notifications
You must be signed in to change notification settings - Fork 115
Configure UpdateForV10 tag with eslint-plugin-jsdoc #5683
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
Conversation
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.
|
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 |
JoshMock
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.1 9.1
# Navigate to the new working tree
cd .worktrees/backport-9.1
# Create a new branch
git switch --create backport-5683-to-9.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a4e1fac4c3abb948fedf2815690db3e62fba00c5
# Push it to GitHub
git push --set-upstream origin backport-5683-to-9.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.1Then, create a pull request where the |
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.2 9.2
# Navigate to the new working tree
cd .worktrees/backport-9.2
# Create a new branch
git switch --create backport-5683-to-9.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a4e1fac4c3abb948fedf2815690db3e62fba00c5
# Push it to GitHub
git push --set-upstream origin backport-5683-to-9.2
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.2Then, create a pull request where the |
* 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
* 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
* 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
* Configure UpdateForV10 tag with eslint-plugin-jsdoc (#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 * fix merge * fix merge * fix merge
* Configure UpdateForV10 tag with eslint-plugin-jsdoc (#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 * fix merge * fix merge * fix merge * fix merge
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
UpdateForV10JSDoc tag that can be used in any comment. There are a few benefits of using JSDoc instead of a simple TODO comment:Note that this tag has the same name as the Elasticsearch UpdateForV10 annotation, which will prove useful when the Elasticsearch specification becomes part of the Elasticsearch repository in the future.
Since we're now using https://github.com/gajus/eslint-plugin-jsdoc, this pull request also applies a number of useful fixes.