feat(doc): add valeCLI github action to automatically lint extension … #88
Conversation
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
lmartella1
force-pushed
the
add-vale-cli
branch
6 times, most recently
from
52b8bb3
to
69b03fa
Compare
rquinio1A
approved these changes
Jun 14, 2024
.github/workflows/lint-with-vale.yml
Outdated
| @@ -0,0 +1,20 @@ | |||
| name: lint-with-vale.yml | |||
| on: [pull_request_target] | |||
There was a problem hiding this comment.
Seems possible to filter on the file paths to not trigger the worlflow at all if no doc is modified ?
cf https://github.com/quarkusio/quarkus/blob/main/.github/workflows/vale.yml#L7
.github/workflows/lint-with-vale.yml
Outdated
| files: ./docs/modules/ROOT/pages/ | ||
| filter_mode: added | ||
| reporter: github-pr-review | ||
| fail_on_error: true |
There was a problem hiding this comment.
Might be a bit risky at the begining (risk of false positives due to vale->adoc bugs) ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new GitHub Action that uses Vale to lint our project's documentation. Vale is a syntax-aware linter for prose that we can use to enforce style and consistency across our documentation.
The new workflow, defined in
.github/workflows/lint-with-vale.yml, is triggered on thepull_request_targetevent. This allows the workflow to post review comments on pull requests from forked repositories, as it runs in the context of the base repository and has the necessary write permissions.The Vale Action is configured to check the files in the
./docs/modules/ROOT/pages/directory. It uses thegithub-pr-reviewreporter to post the linting results as a pull request review. If any issues are found, the workflow will fail, ensuring that we maintain a high standard of quality for our documentation.