-
Notifications
You must be signed in to change notification settings - Fork 122
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
Kibana dependency update procedure #583
Labels
meta
...meta issue
Comments
2 tasks
This was referenced Apr 16, 2020
This was referenced Apr 29, 2020
1 task
This was referenced Jul 3, 2020
1 task
Moved to the wiki page |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The
elastic-charts
dependency in Kibana needs to be updated every X weeks/release following is the draft procedure.Kibana dependency upgrade procedure
Kibana use RenovateBot to automatically create a PRs with the updated dependencies. We should use the bot PRs and push any commits that are required to solve any breaking changes issue (the
bot
will stop updating the PR with a newer version if you pushed a commit to that branch).Check if the
RenovateBot
has already created a PR for the newer version here: renovate bot dependencies GH issue or here list of all PRs. If you don't find the PR, create one from scratch using this PR as an example. Please use the following title if we are just upgrading the library:Update dependency @elastic/charts to v19.0.0
If the upgrade fixes a specific issue, then you can use a more specific title like:
[TSVB] Fix wrongly display stacked as percentage charts
Apply, at least, the following labels and any other that may apply:
Feature:ElasticCharts
,dependencies
,release_note:skip
Check the PR description, in particular, the
Release Notes
to see if everything is correctly reported (I've seen sometimes issues with theRelease Notes
not correctly picked up by the bot). Release notes should be germane to fixes to features related to Kibana, not@elastic/charts
.Add a link of this issue in the PR description with the following:
Fixing failures and breaking changes:
minor
or apatch
version and failures appear on the CI, please open an issue in theelastic-chart
repo reporting that failure if directly related to elastic-charts. We should strictly follow the semantic versioning, so if on a minor or a patch release there are issues with the code, maybe something is slipped through the public API and we didn't publish correctly a breaking change release.major
release it's probable that we are getting at least one failure on the CI. Check the failure and it's relation with elastic-charts and try to fix them on the PR branch.from '@elastic/charts
and check the code against the breaking changes of the library (i.e.Lens
,dashboard
,TSVB
, etc.).NOTE: there can be existing code that uses elastic-charts in a js code where you will never get type errors if something is changed. So please check also those codes manually to see if you can spot non-detected breaking changes (here for example ml is using our typing to render a similar tooltip, but the code that generate the tooltip data is under pure js files elastic/kibana@ec82779) . CSS breaking changes, like changing a
classname
can also slip through the CI. Check the library for any of these breaking changes and apply them to Kibana.visual change
, like a different look-and-feel, a different default value on the APIs, etc, please check if the visual change also applies on each chart implementation, describe the visual change on the PR, and ping each chart consumer involved asking to double-check the change, revert that change on the Kibana code if requested. (note: we should write a quick guide on how to test each chart implementation ourselves on a running Kibana instance. Actually it's not that easy due to the need for a different type of dataset on each specific case, but we should find an easy way to check that)backporting guide
. Do not backport amajor
version into a maintenance branch, just merge it intomaster
and the previousminor
versionUpdate the following table with the current dependency version merged in Kibana.
The text was updated successfully, but these errors were encountered: