Skip to content

Add Vale #3694

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.

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

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

Add Vale #3694

wants to merge 33 commits into from

Conversation

Blargian
Copy link
Member

@Blargian Blargian commented Apr 17, 2025

Summary

Adds Vale to docs CI, and for running locally.

Workflow description:

  • A user opens a PR.
  • The workflow checks which lines were changed in which files.
  • Vale is run for those files.
  • If Vale picks up issues which are suggestions or warnings it posts them as an annotation on the file in the "Files changed" tab.
  • If Vale has any errors it will fail. (We can choose which rules will error vs just warn)

We can run locally using yarn check-prose (also called as part of check-style). By default it checks only those files which are modified on your branch. If you want to check specific files use yarn check-prose -f 'docs/best-practices/json_type.md'

Checklist

Copy link

vercel bot commented Apr 17, 2025

@Blargian is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

@Blargian Blargian linked an issue Apr 17, 2025 that may be closed by this pull request
@Blargian Blargian marked this pull request as ready for review April 19, 2025 17:33
@Blargian Blargian requested a review from a team as a code owner April 19, 2025 17:33
@Blargian Blargian requested a review from gingerwizard April 19, 2025 17:56
@Blargian
Copy link
Member Author

@gingerwizard can you please review when you get a chance? I've left the error in so you can see how the annotation looks in the "Files changed" tab

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Introduce vale & markdown linter and improve standards
1 participant