feat(docs): Add vale style checker (#419)

* feat(docs): Add vale style checker * chore(): Use pinned checkout * chore(): Install tree for github runners * chore(): Run forrest run * chore(): Sudo make me a sandwich * chore(): ¯\_(ツ)_/¯ * chore(): Needs rubygems * Update test.yaml Co-authored-by: Christopher Bartz <[email protected]> Signed-off-by: Mariyan Dimitrov <[email protected]> --------- Signed-off-by: Mariyan Dimitrov <[email protected]> Co-authored-by: Christopher Bartz <[email protected]>
canonical · Nov 21, 2024 · e61bc10 · e61bc10
1 parent f776f16
commit e61bc10
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -93,6 +93,31 @@ jobs:
           filter-mode: nofilter
           workdir: ${{ inputs.working-directory }}
           woke-version: latest
+  vale:
+    name: Style checker
+    runs-on: >-
+      ${{
+        inputs.self-hosted-runner &&
+        fromJson(format('[''self-hosted'', ''{0}'', ''{1}'', ''{2}'']',
+          inputs.self-hosted-runner-arch, inputs.self-hosted-runner-label, inputs.self-hosted-runner-image
+        )) || 'ubuntu-22.04'
+      }}
+    defaults:
+      run:
+        shell: bash
+        working-directory: ${{ inputs.working-directory }}
+    steps:
+      - name: Checkout repo to runner
+        uses: actions/[email protected]
+      - run: |
+          sudo apt-get update -y && sudo apt-get install -y tree ruby-rubygems
+      - name: Install styles
+        uses: canonical/praecepta@main
+      - name: Run Vale tests
+        uses: errata-ai/vale-action@reviewdog
+        with:
+          files: ${{ inputs.charm-directory }}/docs
+          fail_on_error: false
   shellcheck-lint:
     name: Shell scripts lint
     runs-on: >-