feat: build plugin docs as part of package-plugin when docsPath is set#219
Draft
feat: build plugin docs as part of package-plugin when docsPath is set#219
Conversation
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 "Build plugin documentation" step to
package-plugin/action.ymlthat runs after the frontend build. WhendocsPathis set in the plugin'splugin.json, it invokes@grafana/plugin-docs-cli buildto generatedist/docs/— containing the docs manifest and all markdown and image files — before the ZIP is created. This means docs files are included in the release archive automatically, making them available for CDN sync and the GCOM docs API.Plugins without
docsPathare entirely unaffected: the step readsdist/plugin.jsonafter the webpack build and exits immediately if the field is absent.Which issue(s) this PR fixes:
No issue — part of the multi-page plugin docs initiative.
Special notes for your reviewer:
plugin-docs-clirequires Node >=24. Callers using multi-page docs must passnode-version: 24to the action (most already do; the docstest plugin does).build-plugin/action.ymlchange (pointingpackage-pluginat this branch) is temporary for testing only and must be reverted to@mainbefore merging.plugin-validatorstep, which already invokesplugin-docs-cli validate --strictinternally. Docs errors fail the release there.