Add Vale linter to CI #201
Conversation
|
🚀 Preview is available at https://pr-201--konflux-docs.netlify.app |
|
🚀 Preview is available at https://pr-201--konflux-docs.netlify.app |
brunoapimentel
force-pushed
the
vale-linter
branch
from
acf33ef to
b5e33c0
Compare
|
🚀 Preview is available at https://pr-201--konflux-docs.netlify.app |
brunoapimentel
force-pushed
the
vale-linter
branch
from
b5e33c0 to
7a81b18
Compare
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]>
brunoapimentel
force-pushed
the
vale-linter
branch
from
7a81b18 to
23c0850
Compare
|
🚀 Preview is available at https://pr-201--konflux-docs.netlify.app |
1 similar comment
|
🚀 Preview is available at https://pr-201--konflux-docs.netlify.app |
|
@arewm @ralphbean thoughts on the direction here? |
It is run only against the differential. I had a commit to force errors at some point, take a look the CI run for it here. |
|
Should we run the linter against the content as we have it today? |
If you look at the vale linter output here, you'll see that it does check the whole content, but it only triggers a CI failure for errors that belong to the diff. |
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.