Plugins: Improve levitate / breaking changes report in grafana/grafana #89822
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oshirohugo
force-pushed
the
improve-levitate-report
branch
from
081588b to
9f6562d
Compare
oshirohugo
force-pushed
the
improve-levitate-report
branch
from
9f6562d to
f0193b9
Compare
oshirohugo
changed the title
academo
reviewed
Jul 10, 2024
| markdown += createLinks(changes, affectingProperties).join('<br>\n'); | ||
| } | ||
| } else { | ||
| markdown += '<h4>No affected plugins found</h4>'; |
There was a problem hiding this comment.
What if we don't print this part and instead just output a blank report?
My concern is that this line can give a false feeling that nothing is broken and you can go ahead and merge but in truth our database of dependency usage is not 100% reliable so we can't reliable say "nothing is affected"
There was a problem hiding this comment.
Thanks for your review. It makes sense. I'll change that :D
academo
approved these changes
Jul 11, 2024
Co-authored-by: Levente Balogh <[email protected]>
ryantxu
pushed a commit
that referenced
this pull request
Jul 11, 2024
#89822) * Plugins: Add gcloud auth and usage to levitate workflow --------- Co-authored-by: Levente Balogh <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this feature?
This PR is adding more details to the report generated by the levitate pipeline:
Special notes for your reviewerWhy do we need this feature?
This feature is necessary to give developers a better way to analyse and react to possible breaking changes.
Who is this feature for?
Grafana developers
Which issue(s) does this PR fix?:
Fixes https://github.com/grafana/grafana-community-team/issues/137
Special notes for your reviewer:
In this feature we choose to go with links instead of showing the info directly to avoid showing info of private plugins.
This is an example of the new report:
##################
Changes
useTheme2/tmp/@grafana/[email protected]/package/dist/index.d.ts
GrafanaTheme2.spacing
/tmp/@grafana/[email protected]/package/dist/index.d.ts
Number of affected plugins: 22
To check the plugin affected by each import, click on the links below.
Changes
@grafana/ui/useTheme2@grafana/data/GrafanaTheme2.spacing
##################
Please check that: