IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Use doc-validator v3.0.0 (#69544)

Browse Source 
- Structured output for use with [`reviewdog`](https://github.com/reviewdog/reviewdog).
  You can achieve the original error output by piping the output to the following `jq` expression: `jq -r '"ERROR: \(.location.path):\(.location.range.start.line):\(.location.range.start.column): \(.message)"'`.
- Suggestions for simple link fixes.
  In GitHub, [`reviewdog`](https://github.com/reviewdog/reviewdog) comments these suggestions for convenient replacement.
- Support for anchors referring to repeated headings.
  In the case that a page has multiple headings that share the same text, a zero indexed, the renderer appends a numbered suffix to the identifier.
  For example, when there are two headings that are both "Heading text", the first anchor identifier is `heading-text` and the second is `heading-text-1`.- Error when running `doc-validator` on no files.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Jack Baldry
2023-06-06 07:40:05 +01:00
committed by GitHub
parent 09eca5981b
commit c46395ad88
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/doc-validator.yml vendored
View File

@@ -7,7 +7,7 @@ jobs:
doc-validator: doc-validator:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
container: container:
image: "grafana/doc-validator:c2a784f" image: "grafana/doc-validator:v3.0.0"
steps: steps:
- name: "Checkout code" - name: "Checkout code"
uses: "actions/checkout@v3" uses: "actions/checkout@v3"
@@ -20,7 +20,7 @@ jobs:
./docs/sources ./docs/sources
/docs/grafana/latest /docs/grafana/latest
| reviewdog | reviewdog
'--efm=ERROR: %f:%l:%c %m' -f=rdjsonl
--fail-on-error --fail-on-error
--filter-mode=nofilter --filter-mode=nofilter
--name=doc-validator --name=doc-validator