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.

Sign up for GitHub

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

Jump to bottom

Update shields.io guidance following change in API / query unsupported #1157

Closed
2 tasks done
sympatheticmoose opened this issue Oct 1, 2024 · 2 comments · Fixed by #1160
Closed
2 tasks done

Update shields.io guidance following change in API / query unsupported #1157

sympatheticmoose opened this issue Oct 1, 2024 · 2 comments · Fixed by #1160
Assignees
@sympatheticmoose
Labels
released This issue/pull request has been released.

Comments

@sympatheticmoose
Copy link
Contributor

sympatheticmoose commented Oct 1, 2024 •
edited
Loading

It's likely all readmes using dynamic json badges will be broken due to a change in how they're handling JSONpath after a vulnerability was disclosed.

We should:

  • update the sample readme in create-plugin
  • post in community forum and slack

Reference Issue: badges/shields#10553
@tolzhabayev tolzhabayev changed the title update shields.io guidance following change in API Update shields.io guidance following change in API / query unsupported Oct 1, 2024
@tolzhabayev tolzhabayev mentioned this issue Oct 1, 2024
Merged
@tolzhabayev
Copy link
Collaborator

For those finding this issue - until we update the docs:

Example/Reference PR: grafana/grafana-polystat-panel#424

Changes:
url - set to https://grafana.com/api/plugins/<your-plugin-id>
query- set to $.downloads for downloads and $.version for version

make sure the url and query parameter values are urlencoded when used.

@sympatheticmoose sympatheticmoose moved this from 📬 Triage to 📅 Planned in Plugins Platform / Grafana Community Oct 2, 2024
@sympatheticmoose sympatheticmoose self-assigned this Oct 3, 2024
@sympatheticmoose sympatheticmoose mentioned this issue Oct 3, 2024
Merged
@github-project-automation github-project-automation bot moved this from 📅 Planned to 🚀 Shipped in Plugins Platform / Grafana Community Oct 4, 2024
@grafana-plugins-platform-bot
Copy link

🚀 Issue was released in @grafana/[email protected] 🚀

@grafana-plugins-platform-bot grafana-plugins-platform-bot bot added the released This issue/pull request has been released. label Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sympatheticmoose sympatheticmoose

Labels
released This issue/pull request has been released.
Projects
Plugins Platform / Grafana Community
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: update shields.io template grafana/plugin-tools
2 participants
@tolzhabayev @sympatheticmoose