Skip to content

Conversation

@s4kh
Copy link
Contributor

@s4kh s4kh commented Jan 14, 2026

What this PR does / why we need it:

plugin.json routes[].path should be defined, otherwise it won't be proxied. Updated the description for the 'path' property to include a warning about empty strings and marked it as required.

Which issue(s) this PR fixes:

Fixes https://github.com/grafana/grafana-community-team/issues/715

Special notes for your reviewer:

@s4kh s4kh requested a review from a team as a code owner January 14, 2026 18:06
Copilot AI review requested due to automatic review settings January 14, 2026 18:06
@s4kh s4kh requested a review from a team as a code owner January 14, 2026 18:06
@s4kh s4kh requested a review from oshirohugo January 14, 2026 18:06
@github-actions
Copy link
Contributor

github-actions bot commented Jan 14, 2026

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

@s4kh s4kh requested a review from urbiz-grafana January 14, 2026 18:06
@s4kh s4kh self-assigned this Jan 14, 2026
@s4kh s4kh added the no-changelog Don't include in changelog and version calculations label Jan 14, 2026
@s4kh s4kh moved this from 📬 Triage to 🔬 In review in Plugins Platform / Grafana Community Jan 14, 2026
@s4kh s4kh requested a review from wbrowne January 14, 2026 18:07
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the documentation for the path property in routes[] configuration for data source plugins to clarify that it cannot be an empty string and marks it as required.

Changes:

  • Updated the path property description to include a warning that it cannot be an empty string
  • Marked the path property as required in the routes configuration table

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@hugohaggmark hugohaggmark left a comment

Choose a reason for hiding this comment

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

Hi @s4kh , this file is autogenerated from https://github.com/grafana/grafana/blob/main/docs/sources/developers/plugins/plugin.schema.json so you need to add the comment there first and then run npm -w website run prebuild in the root of this branch and it should update this file automatically

@github-project-automation github-project-automation bot moved this from 🔬 In review to 🧑‍💻 In development in Plugins Platform / Grafana Community Jan 15, 2026
@hugohaggmark
Copy link
Contributor

hugohaggmark commented Jan 15, 2026

Opened this PR so this shouldn't happen again: #2396

@s4kh s4kh requested a review from hugohaggmark January 15, 2026 18:57
@s4kh s4kh moved this from 🧑‍💻 In development to 🔬 In review in Plugins Platform / Grafana Community Jan 16, 2026
@s4kh
Copy link
Contributor Author

s4kh commented Jan 16, 2026

@hugohaggmark ran npm -w website run prebuild

@hugohaggmark
Copy link
Contributor

No changes you can close this PR @s4kh 🙌

@s4kh s4kh closed this Jan 16, 2026
@github-project-automation github-project-automation bot moved this from 🔬 In review to 🚀 Shipped in Plugins Platform / Grafana Community Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog Don't include in changelog and version calculations

Projects

Status: 🚀 Shipped

Development

Successfully merging this pull request may close these issues.

2 participants