Add test to render and lint dashboards #106
Merged
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
consideRatio
force-pushed
the
pr/test-dashboard-render
branch
from
ffc2d95
to
9e4ea6e
Compare
consideRatio
changed the title
consideRatio
force-pushed
the
pr/test-dashboard-render
branch
from
9e4ea6e
to
767bafd
Compare
consideRatio
changed the title
consideRatio
changed the title
consideRatio
force-pushed
the
pr/test-dashboard-render
branch
5 times, most recently
from
ef54d03
to
e7e6b2d
Compare
consideRatio
force-pushed
the
pr/test-dashboard-render
branch
from
e7e6b2d
to
6dbaf51
Compare
|
Since this isn't changing anything that could impact the dashboards, I'll go for a merge to retain momentum and use this to inspect things in #90. |
yuvipanda
added a commit
to yuvipanda/grafana-dashboards
that referenced
this pull request
Jul 19, 2024
This was self-merged in jupyterhub#106, and has never passed. I don't think we should have a test that is always expected to fail.
yuvipanda
added a commit
to yuvipanda/grafana-dashboards
that referenced
this pull request
Jul 19, 2024
This was introduced in jupyterhub#106, and has never passed. I don't think we should have a test that is always expected to fail. If it should be re-introduced, it should be done in such a way that whatever changes are needed to make it pass should be part of the PR. This only reverts the linter, but keeps the rendering test - as that would help us catch possible jsonnet syntax issues.
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.
This projects use jsonnet to render grafana dashboard definitions (json). Our pre-commit hooks ensures we have formatted and valid jsonnet files, but until now we haven't done checks on the rendered grafana dashboards.
The only input variable for rendering dashboard definitions is a list of datasource names for the global dashboard. This makes the rendered dashboards very very similar between admins rendering them for their respective deployments, and therefore linting one is to lint them all pretty much.
I've not used grafana/dashboard-linter myself before, and I just searched for a linter as a way to have some kind of test on the validity of the rendered dashboards. I don't know if and what rules make sense etc, but figured this could help us maintain this project.
https://github.com/grafana/dashboard-linter/blob/main/docs/index.md#rules
Future improvement ideas