Skip to content

Commit

Permalink
Add workflow for vale
Browse files Browse the repository at this point in the history
Signed-off-by: Mirjam Aulbach <[email protected]>
  • Loading branch information
programmiri committed Sep 25, 2023
1 parent e2a3a4f commit c59fcd7
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/vale.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: "Vale spelling and prose check"
on:
push:
branches: [ "main" ]
paths:
- "**.md"
pull_request:
branches: [ "main" ]
paths:
- "**.md"

jobs:
link-checker:
name: Check internal and external links in markdown files
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac #v4.0.0
with:
ref: ${{ github.ref }}
fetch-depth: 0

- name: Run vale
uses: errata-ai/vale-action@c4213d4de3d5f718b8497bd86161531c78992084 #v2.0.1
with:
fail_on_error: true
vale_flags: "--minAlertLevel=error"
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## About

TEST CHANGE.

This is the Klaw documentation repository. Welcome 👋 🎉
You can find source code and all content for our ([klaw-project.io](https://www.klaw-project.io/) site here.

Expand Down Expand Up @@ -41,8 +43,8 @@ Here are the important ones you're likely to use:
- `npm run build`: will build the documentation site and generate all static files in "build". After `build` you can
run `npm run serve` to test your build locally
- `lint`: runs a format check and if no error is found, lints code and markdown files in the project.
- the linting script does not mutate your code. See [Linting and code formatting](#linting-and-code-formatting) for
more info.
- the linting script does not mutate your code. See [Linting and code formatting](#linting-and-code-formatting) for
more info.
- `reformat`: runs the code formatter (prettier) as well as the markdown linter in fix mode. This will mutate you code.

ℹ️ We are using a custom hook path for enabling pre-commit hooks. This path is set in the local git configuration when
Expand Down

0 comments on commit c59fcd7

Please sign in to comment.