-
Notifications
You must be signed in to change notification settings - Fork 67
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This patch introduces Vale¹ as a writing style linter, and configures it using Red Hat's styles². It also sets up a corresponding Github Action to run Vale during the CI. If any of the lines introduced by the PR causes an error level linting message, the CI will fail. ¹https://vale.sh/docs ²https://redhat-documentation.github.io/vale-at-red-hat/docs/main/user-guide/introduction/ Signed-off-by: Bruno Pimentel <[email protected]>
- Loading branch information
1 parent
730a792
commit 23c0850
Showing
4 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: Linters | ||
on: | ||
- pull_request | ||
jobs: | ||
vale: | ||
name: vale | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
- name: Install Asciidoctor | ||
run: sudo apt-get install -y asciidoctor | ||
- name: Vale Linter | ||
uses: errata-ai/vale-action@reviewdog | ||
with: | ||
vale_flags: "--minAlertLevel=error" | ||
fail_on_error: true | ||
env: | ||
# Required, set by GitHub actions automatically: | ||
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret | ||
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
StylesPath = .vale/styles | ||
|
||
MinAlertLevel = warning | ||
|
||
IgnoredScopes = code, tt, img, url, a, body.id | ||
|
||
SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock | ||
|
||
Packages = RedHat | ||
|
||
Vocab = konflux | ||
|
||
[*.adoc] | ||
|
||
BasedOnStyles = RedHat |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
lockfile | ||
prefetch | ||
Snyk | ||
Konflux | ||
kubectl |