Adding vale#1716
Conversation
|
@mcclowes is attempting to deploy a commit to the Codat Team on Vercel. A member of the Team first needs to authorize it. |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
This is the final PR Bugbot will review for you during this billing cycle
Your free Bugbot reviews will reset on December 20
Details
Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
| - name: Vale Linter | ||
| uses: errata-ai/vale-action@reviewdog | ||
| with: | ||
| files: docs |
There was a problem hiding this comment.
Bug: Workflow triggers on blog but only lints docs
The workflow triggers on changes to blog/** in the paths section, but the files: docs parameter only lints the docs directory. When someone modifies blog content, the workflow runs but the blog files are never actually checked by Vale, defeating the purpose of having the trigger path. The files parameter likely needs to include both directories.
Additional Locations (2)
| "format:mdx:check": "prettier --check \"**/*.{md,mdx}\"", | ||
| "vale:sync": "vale sync", | ||
| "vale": "vale docs/", | ||
| "vale:check": "vale --minAlertLevel=warning docs/" |
There was a problem hiding this comment.
Bug: NPM vale scripts also exclude blog directory
The vale and vale:check npm scripts only lint the docs/ directory, excluding the blog/ directory. This is inconsistent with the workflow trigger paths which include both directories. When running Vale locally via npm scripts, blog content won't be checked, even though the repository has a blog/ directory used for documentation content.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
2 participants
@pzaichkina better than the readability scoring action from before. You can use https://vale.sh/ to validate against an actual styleguide
Note
Introduce Vale-based docs linting via GitHub Action, custom configuration, vocabulary, and npm scripts.
/.github/workflows/check-vale.ymlto runerrata-ai/vale-actionondocs/**andblog/**for pushes/PRs, reporting viagithub-pr-review..vale.iniwith Google package, rule adjustments, and ignore patterns for MD/MDX..vale/styles/config/vocabularies/Codat/(accept.txt,reject.txt).vale:sync,vale, andvale:checknpm scripts inpackage.json.Written by Cursor Bugbot for commit 4d8e092. This will update automatically on new commits. Configure here.