Remove doc-validator requirement to run on all pull requests (#94673)

This commit is contained in:
Jack Baldry
2024-10-14 11:47:26 +01:00
committed by GitHub
parent a69ee676ba
commit 2f3c539d9b
+9 -12
View File
@@ -1,13 +1,18 @@
name: "doc-validator" name: "doc-validator"
on: on:
pull_request:
paths: ["docs/sources/**"]
workflow_dispatch: workflow_dispatch:
inputs:
include:
description: |
Regular expression that matches paths to include in linting.
For example: docs/sources/(?:alerting|fundamentals)/.+\.md
required: true
jobs: jobs:
doc-validator: doc-validator:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
container: container:
image: "grafana/doc-validator:v5.0.0" image: "grafana/doc-validator:v5.2.0"
steps: steps:
- name: "Checkout code" - name: "Checkout code"
uses: "actions/checkout@v4" uses: "actions/checkout@v4"
@@ -15,15 +20,7 @@ jobs:
# Only run doc-validator on specific directories. # Only run doc-validator on specific directories.
run: > run: >
doc-validator doc-validator
'--include=^docs/sources/(?:alerting|fundamentals|getting-started|introduction|setup-grafana|upgrade-guide|whatsnew/whats-new-in-v(?:9|10))/.+\.md$' '--include=${{ inputs.include }}'
'--skip-checks=^(?:image.+|canonical-does-not-match-pretty-URL)$' '--skip-checks=^(?:image.+|canonical-does-not-match-pretty-URL)$'
./docs/sources ./docs/sources
/docs/grafana/latest /docs/grafana/latest
| reviewdog
-f=rdjsonl
--fail-on-error
--filter-mode=nofilter
--name=doc-validator
--reporter=github-pr-review
env:
REVIEWDOG_GITHUB_API_TOKEN: "${{ secrets.GITHUB_TOKEN }}"