2022-07-07 02:58:51 -05:00
|
|
|
name: "doc-validator"
|
|
|
|
|
on:
|
|
|
|
|
pull_request:
|
|
|
|
|
paths: ["docs/sources/**"]
|
|
|
|
|
workflow_dispatch:
|
|
|
|
|
jobs:
|
|
|
|
|
doc-validator:
|
|
|
|
|
runs-on: "ubuntu-latest"
|
|
|
|
|
container:
|
2023-10-24 08:52:41 -05:00
|
|
|
image: "grafana/doc-validator:v4.0.0"
|
2022-07-07 02:58:51 -05:00
|
|
|
steps:
|
|
|
|
|
- name: "Checkout code"
|
2023-09-05 03:10:10 -05:00
|
|
|
uses: "actions/checkout@v4"
|
2022-07-07 02:58:51 -05:00
|
|
|
- name: "Run doc-validator tool"
|
2023-05-18 09:50:20 -05:00
|
|
|
# Only run doc-validator on specific directories.
|
|
|
|
|
run: >
|
|
|
|
|
doc-validator
|
2023-05-24 08:12:30 -05:00
|
|
|
'--include=^docs/sources/(?:alerting|fundamentals|getting-started|introduction|setup-grafana|upgrade-guide|whatsnew/whats-new-in-v(?:9|10))/.+\.md$'
|
|
|
|
|
'--skip-checks=^(?:image.+|canonical-does-not-match-pretty-URL)$'
|
2023-05-18 09:50:20 -05:00
|
|
|
./docs/sources
|
|
|
|
|
/docs/grafana/latest
|
|
|
|
|
| reviewdog
|
2023-06-06 01:40:05 -05:00
|
|
|
-f=rdjsonl
|
2023-05-18 09:50:20 -05:00
|
|
|
--fail-on-error
|
|
|
|
|
--filter-mode=nofilter
|
|
|
|
|
--name=doc-validator
|
|
|
|
|
--reporter=github-pr-review
|
|
|
|
|
env:
|
|
|
|
|
REVIEWDOG_GITHUB_API_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|
