feat: build plugin docs as part of package-plugin when docsPath is set#219
Draft
sunker wants to merge 3 commits into
Draft
feat: build plugin docs as part of package-plugin when docsPath is set#219sunker wants to merge 3 commits into
sunker wants to merge 3 commits into
Conversation
sunker
changed the title
grafana-plugins-platform-bot
Bot
moved this from 📬 Triage
to 🔬 In review
in Grafana Catalog Team
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
1 participant
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-pluginthat runsnpx @grafana/plugin-docs-cli buildwhendocsPathis set indist/plugin.json. The step generatesdist/docs/manifest.jsonand copies the markdown and images, so multi-page docs ride along in the resulting ZIP and reach the CDN through the existing pipeline.Plugins without
docsPathare unaffected - the bash conditional short-circuits before invoking the CLI.Which issue(s) this PR fixes:
No issue - part of the multi-page plugin docs initiative.
Special notes for your reviewer:
The
build-plugin/action.ymldiff currently pinspackage-plugin@eriksundell/plugin-docs-build-stepfor testing. Will flip back to@mainbefore merging.