From 5e6894b6aa12b10aa6ea4108e45b2668a966bd6b Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Wed, 27 Nov 2024 19:47:12 +0000 Subject: [PATCH 1/2] Remove doc-validator workflow (#1815) You can still lint files locally with `make doc-validator`. With the current docs, there are a number of linting errors reported by doc-validator but they are all low priority and the noise from the consistent CI job, interfere with higher priority progress. --- .github/workflows/doc-validator.yml | 28 ---------------------------- 1 file changed, 28 deletions(-) delete mode 100644 .github/workflows/doc-validator.yml diff --git a/.github/workflows/doc-validator.yml b/.github/workflows/doc-validator.yml deleted file mode 100644 index fcc20bd28b..0000000000 --- a/.github/workflows/doc-validator.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Validate documentation -on: - pull_request: - paths: ["docs/sources/k6/**"] - workflow_dispatch: -jobs: - doc-validator: - runs-on: "ubuntu-latest" - container: - image: "grafana/doc-validator:v5.1.0" - steps: - - name: "Checkout code" - uses: "actions/checkout@v4" - - name: "Run doc-validator tool" - run: > - doc-validator - '--skip-checks=^image.+$' - docs/sources/k6 - /docs/k6 - | awk '!/"The '"'"'description'"'"' parameter in the front matter must be present."/' - | reviewdog - -f=rdjsonl - --fail-on-error - --filter-mode=nofilter - --name=doc-validator - --reporter=github-pr-review - env: - REVIEWDOG_GITHUB_API_TOKEN: "${{ secrets.GITHUB_TOKEN }}" From d5ceec37f510a3e5df5bf612a950c1bcf0811dca Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Wed, 27 Nov 2024 19:47:49 +0000 Subject: [PATCH 2/2] Fix path to extension registry output file (#1816) It was moved in https://github.com/grafana/k6-docs/pull/1781 and the script has been failing in https://github.com/grafana/k6-docs/actions/workflows/extension-registry-changed.yml since then. Signed-off-by: Jack Baldry --- scripts/extension-registry-changed | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/extension-registry-changed b/scripts/extension-registry-changed index 177f7afb04..439d70800e 100755 --- a/scripts/extension-registry-changed +++ b/scripts/extension-registry-changed @@ -40,7 +40,7 @@ EOF } scriptdir="$(dirname "$(readlink -f "$0")")" -docfile="$scriptdir/../docs/sources/next/extensions/explore.md" +docfile="$scriptdir/../docs/sources/k6/next/extensions/explore.md" tmpfile="$(mktemp /tmp/extension-registry-changed.XXXXXX)"