From 4dc1a757818f547ecbd163e23622ca75536dfa57 Mon Sep 17 00:00:00 2001 From: Chi Wai Chan Date: Thu, 12 Feb 2026 15:10:56 +0800 Subject: [PATCH 1/2] feat: support vale flags --- .github/workflows/docs.yaml | 8 +++++++- docs/changelog.md | 4 ++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 42d296eea..e60dc1244 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -11,6 +11,11 @@ on: description: Where Vale will look for files to lint default: '["README.md","CONTRIBUTING.md","docs/"]' required: false + vale-flags: + type: string + description: Space-delimited list of flags for the Vale CLI. + default: "" + required: false vale-fail-on-error: description: Exit with 1 when at least one error was reported. type: boolean @@ -43,6 +48,7 @@ jobs: uses: errata-ai/vale-action@v2.1.1 with: files: ${{ inputs.vale-files }} + vale_flags: ${{ inputs.vale-flags }} fail_on_error: ${{ inputs.vale-fail-on-error }} env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -87,7 +93,7 @@ jobs: --exclude terraform.io --exclude hashicorp.com ${{ inputs.linkcheck-files }} - + - name: Save lychee cache uses: actions/cache/save@v5.0.3 if: always() diff --git a/docs/changelog.md b/docs/changelog.md index fca34c300..6ba2b8b04 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). Each revision is versioned by the date of the revision. +## 2026-02-12 + +- Support "vale-flags" input parameter for the `docs` workflow to allow passing additional flags to the Vale CLI. + ## 2026-02-11 - Add "terraform-lint" step in the "test" workflow. From 9ae5f8f1c91b8238cfac5446104b91965ae5170c Mon Sep 17 00:00:00 2001 From: Chi Wai Chan Date: Thu, 12 Feb 2026 15:22:54 +0800 Subject: [PATCH 2/2] feat: default to glob *.md --- .github/workflows/docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index e60dc1244..e76beae2f 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -14,7 +14,7 @@ on: vale-flags: type: string description: Space-delimited list of flags for the Vale CLI. - default: "" + default: "--glob=*.md" required: false vale-fail-on-error: description: Exit with 1 when at least one error was reported.