Skip to content

Create Plugin: Add validate-docs workflow to scaffolded plugins#2609

Draft
sunker wants to merge 1 commit intomainfrom
eriksundell/plugin-docs-validate-workflow
Draft

Create Plugin: Add validate-docs workflow to scaffolded plugins#2609
sunker wants to merge 1 commit intomainfrom
eriksundell/plugin-docs-validate-workflow

Conversation

@sunker
Copy link
Copy Markdown
Contributor

@sunker sunker commented May 4, 2026

What this PR does / why we need it:

Adds a validate-docs.yml GitHub Actions workflow to the create-plugin scaffolding. The workflow runs @grafana/plugin-docs-cli validate --strict on PRs and pushes that touch docs/** or src/plugin.json, giving plugin authors early feedback on documentation errors before they reach the release pipeline.

The workflow is a no-op for plugins that don't have docsPath set in plugin.json, so all newly scaffolded plugins can safely include it without any impact on existing workflows. The paths: trigger ensures it only runs when docs actually change.

Which issue(s) this PR fixes:

No issue — part of the multi-page plugin docs initiative.

Special notes for your reviewer:

Pair with grafana/plugin-actions#219, which adds the docs build step to the release pipeline.

Assumption: docsPath is conventionally docs. Plugins using a different folder name would need to update the paths: filter in the workflow file.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 4, 2026

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

❌ This PR cannot be merged until the following issues are addressed:

  • This PR is missing one of the following labels: patch, minor, major, no-changelog.
  • Optionally if using a patch, minor or major label also add the release label if you would like this PR to trigger npm package publishing.
🏷️ More info about which labels to use
  • If the changes only affect the docs website, documentation, or this repository's tooling add the no-changelog label.
  • If there are changes to any of the npm packages src files please choose from one of the following labels:
    • 🐛 if this PR fixes a bug add the patch label
    • 🚀 if this PR includes an enhancement add the minor label
    • 💥 if this PR includes a breaking change add the major label
  • Optionally, if you would like this PR to publish new versions of packages when it is merged add the release label.

@sunker sunker changed the title Add validate-docs workflow to create-plugin scaffolding Create Plugin: Add validate-docs workflow to create-plugin scaffolding May 4, 2026
@sunker sunker changed the title Create Plugin: Add validate-docs workflow to create-plugin scaffolding Create Plugin: Add validate-docs workflow to scaffolded plugins May 4, 2026
@grafana-plugins-platform-bot grafana-plugins-platform-bot Bot moved this from 📬 Triage to 🔬 In review in Grafana Catalog Team May 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🔬 In review

Development

Successfully merging this pull request may close these issues.

1 participant