From 903856aa6c385a90cea52e6b9cdd9b93e09b602b Mon Sep 17 00:00:00 2001 From: "Grot (@grafanabot)" <43478413+grafanabot@users.noreply.github.com> Date: Tue, 6 Jun 2023 08:33:06 +0100 Subject: [PATCH] [v10.0.x] Use doc-validator v3.0.0 (#69594) Use doc-validator v3.0.0 (#69544) - 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 (cherry picked from commit c46395ad88bd0d88ceb5ad53acf3d25365432188) Co-authored-by: Jack Baldry --- .github/workflows/doc-validator.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc-validator.yml b/.github/workflows/doc-validator.yml index e84f4e4cc31..792506ff46d 100644 --- a/.github/workflows/doc-validator.yml +++ b/.github/workflows/doc-validator.yml @@ -7,7 +7,7 @@ jobs: doc-validator: runs-on: "ubuntu-latest" container: - image: "grafana/doc-validator:c2a784f" + image: "grafana/doc-validator:v3.0.0" steps: - name: "Checkout code" uses: "actions/checkout@v3" @@ -20,7 +20,7 @@ jobs: ./docs/sources /docs/grafana/latest | reviewdog - '--efm=ERROR: %f:%l:%c %m' + -f=rdjsonl --fail-on-error --filter-mode=nofilter --name=doc-validator