Skip to content

feat: build plugin docs as part of package-plugin when docsPath is set #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sunker wants to merge 2 commits into
base: main
Choose a base branch
from
+9 −1
Draft

feat: build plugin docs as part of package-plugin when docsPath is set #219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ee3cc6
Build plugin docs as part of package-plugin when docsPath is set
sunker May 4, 2026
16d7a36
Point build-plugin at package-plugin branch for testing
sunker May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build-plugin/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ runs:
steps:
- name: Package plugin
id: "package-plugin"
uses: grafana/plugin-actions/package-plugin@main # zizmor: ignore[unpinned-uses]
uses: grafana/plugin-actions/package-plugin@eriksundell/plugin-docs-build-step # zizmor: ignore[unpinned-uses]
with:
policy_token: ${{ inputs.policy_token }}
sign_root_urls: ${{ inputs.sign_root_urls }}
Expand Down
8 changes: 8 additions & 0 deletions package-plugin/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ runs:
run: ${{ github.action_path }}/pm.sh build
shell: bash

- name: Build plugin documentation
shell: bash
run: |
DOCS_PATH=$(cat dist/plugin.json | jq -r '.docsPath // empty')
if [ -n "$DOCS_PATH" ]; then
npx --yes @grafana/plugin-docs-cli build
fi

- name: Check for backend
id: check-for-backend
run: |
Expand Down
Loading