Create Plugin: Add validate-docs workflow to scaffolded plugins#2609
Draft
Create Plugin: Add validate-docs workflow to scaffolded plugins#2609
Conversation
Contributor
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ❌ This PR cannot be merged until the following issues are addressed:
🏷️ More info about which labels to use
|
This file contains hidden or 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
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 this PR does / why we need it:
Adds a
validate-docs.ymlGitHub Actions workflow to thecreate-pluginscaffolding. The workflow runs@grafana/plugin-docs-cli validate --stricton PRs and pushes that touchdocs/**orsrc/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
docsPathset inplugin.json, so all newly scaffolded plugins can safely include it without any impact on existing workflows. Thepaths: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:
docsPathis conventionallydocs. Plugins using a different folder name would need to update thepaths:filter in the workflow file.