Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(docs): Add vale style checker #419

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat(docs): Add vale style checker #419

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8990337
feat(docs): Add vale style checker
merkata Sep 24, 2024
781de8d
Merge branch 'main' into feat/add-vale
merkata Sep 24, 2024
689545e
chore(): Use pinned checkout
merkata Sep 24, 2024
c58f49c
chore(): Install tree for github runners
merkata Sep 24, 2024
0c20ada
chore(): Run forrest run
merkata Sep 24, 2024
4c64c17
chore(): Sudo make me a sandwich
merkata Sep 24, 2024
cf3b5f3
chore(): ¯\_(ツ)_/¯
merkata Sep 24, 2024
d34cc01
chore(): Needs rubygems
merkata Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: ./docs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
files: ./docs
files: ${{ inputs.charm-directory }}/docs

This would allow the check to run for paas-app-charmer charms, which usually have the docs living in charm/docs, see https://github.com/canonical/netbox/tree/main/charm/docs and https://github.com/canonical/netbox/blob/main/.github/workflows/test.yaml#L11 .

fail_on_error: false
shellcheck-lint:
name: Shell scripts lint
runs-on: >-
Expand Down
Loading