Skip to content

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

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 1 commit into
base: main
Choose a base branch
from
+43 −0
Draft

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 43 additions & 0 deletions packages/create-plugin/templates/github/workflows/validate-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{{!-- /* This comment is removed after scaffolding */ --}}
name: Validate documentation

on:
push:
branches:
- main
- master
paths:
- 'docs/**'
- 'src/plugin.json'
pull_request:
branches:
- main
- master
paths:
- 'docs/**'
- 'src/plugin.json'

jobs:
validate:
name: Validate plugin docs
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v6
with:
persist-credentials: false

- name: Setup Node.js environment
uses: actions/setup-node@v6
with:
node-version: '24'

- name: Validate plugin documentation
run: |
DOCS_PATH=$(jq -r '.docsPath // empty' src/plugin.json)
if [ -z "$DOCS_PATH" ]; then
echo "docsPath not set in src/plugin.json, skipping"
exit 0
fi
npx --yes @grafana/plugin-docs-cli validate --strict
Loading