build: Add vale configuration and demonstrate usage #24252
Conversation
github-actions
bot
added
changeset-present
dependencies
| !.vale/config/vocabularies/ | ||
|
|
||
| .vale/config/vocabularies/* | ||
| !.vale/config/vocabularies/fluid/ |
There was a problem hiding this comment.
Isn't it enough to have .vale/** and this last line?
There was a problem hiding this comment.
For reasons I don't understand, no. If you do that, and add a new file under .vale/config/vocabularies/fluid/, it will
still be ignored. My hunch is that it has something to do with precedence of negation and how it works with folder
paths, but I didn't dig into it. FWIW the vale docs follow this pattern and I thought it was unnecssary too.
…on (#24251) Our custom changeset metadata is in its own separate front-matter section. However, most tools do not recognize more than one front-matter section, so this has not been an ideal solution when we want to use other tools on our changesets (e.g. review tools, formatters, linting tools, etc.). This change condenses the fron matter into a single section, using `__` to prefix fluid-specific properties. We already have to remove custom metadata when producing changelogs so that process has just been updated to remove the custom properties rather than the second front matter section. The motivator for this change is to make it easier to use markdown-aware tools with our changesets. See #24252 for an example.
Co-authored-by: Alex Villarreal <716334+alexvy86@users.noreply.github.com>
I think that's an old comment related to the old changeset format. It interpreted ---
section: tree
---As a heading becasue of the underlining - it didn't treat it as a front-matter section. With the new format it treats it as front matter. |
Vale is a lint-like tool for prose. It helps enforce style guidelines and other rules on natural-language text. The idea is to use Vale during the changeset review process to help find possible problems earlier. This will reduce the likelihood that we need to make changeset changes during a release, which can slow the release down.
This change adds a Vale config that uses the Microsoft style guide, plus some custom terms for our team to demonstrate those features.
This change also includes a GitHub Actions workflow that runs Vale on any changesets in PRs and adds comments for any issues it finds. It seems that suggestion-level issues are not added as comments. As we identify types of issues that should be caught, we can update the vale config much like we do with our linter config.
Example
To see example comments generated by the workflow, see tylerbutler#31