Skip to content
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

Ensure deprecation documentationUrl's point to correct doc branch #114264

Merged
merged 1 commit into from
Oct 7, 2021

Conversation

watson
Copy link
Contributor

@watson watson commented Oct 7, 2021

This was made possible via PR #113600.

This PR does not do anything about the documenationUrl usage in the following files as they do not currently have access to ConfigDeprecationContext:

This PR will not be backported to the 7.x branch. In regards to deprecation messages there's too many differences between master and 7.x to warrant a single PR to master that's then backported to 7.x. I've made another PR specifically for 7.x: #114263.

@watson watson added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting labels Oct 7, 2021
@watson watson self-assigned this Oct 7, 2021
@watson watson requested a review from a team as a code owner October 7, 2021 11:50
Copy link
Member

@azasypkin azasypkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM

@watson watson enabled auto-merge (squash) October 7, 2021 12:09
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @watson

@watson watson merged commit 2eff6d0 into elastic:master Oct 7, 2021
@watson watson deleted the deprecation-url-branch branch October 7, 2021 13:59
@tsullivan
Copy link
Member

This PR does not do anything about the documenationUrl usage in the following files as they do not currently have access to ConfigDeprecationContext:

Hi @watson and @pgayvallet, it looks like the common thing with all the files that do not have access to ConfigDeprecationContext is that those deprecations are not declared within a PluginConfigDescriptor object. Instead, the deprecations are declared with core.deprecations.registerDeprecations.

Am I understanding correctly? Is there a plan to expose ConfigDeprecationContext for deprecations registered with core.deprecations.registerDeprecations?

@pgayvallet
Copy link
Contributor

it looks like the common thing with all the files that do not have access to ConfigDeprecationContext is that those deprecations are not declared within a PluginConfigDescriptor object. Instead, the deprecations are declared with core.deprecations.registerDeprecations.

Yea, the common thing is that they're not registered directly using the plugin's configuration descriptor (PluginConfigDescriptor), and instead are registered via core.deprecations.registerDeprecations during their respective plugin's setup lifecycle.

Given that, it's possible for the deprecation owner to leverage the PluginInitializerContext passed down to plugins to access the branch via initContext.env.packageInfo.branch, therefor this was not considered a blocker as it was for pure config deprecations.

Is there a plan to expose ConfigDeprecationContext for deprecations registered with core.deprecations.registerDeprecations?

That's #114065. But it will very likely not be done for 7.16

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants