InnerSourceCommons / InnerSourcePatterns

Proven approaches that can guide you through applying open source best practices within your organization
https://patterns.innersourcecommons.org
Creative Commons Attribution Share Alike 4.0 International
728 stars 177 forks source link

vale does not consider the configured exception list #683

Closed spier closed 2 months ago

spier commented 2 months ago

The GitHub Action (GHA) vale.yml reports spelling issues for words like "upvotes" or "downloads", even though we have configured these words to be accepted via custom word lists in isc-styles.

This has worked perfectly fine in the past. Therefore we suspect that this may be a regression of version upgrades of the tool that we use, either vale, or the vale GHA.

Screenshot 2024-04-13 at 08 33 05

spier commented 2 months ago

Last successful run: 325

"successful" as in a vale run that did respect our custom word lists.

First failing run 326

So the issue started between March 8th-11th.

spier commented 2 months ago

vale had a release on March 11th: https://github.com/errata-ai/vale/releases vale-action had no releases since February 8th: https://github.com/errata-ai/vale-action/releases

So suspicion is that the issues is related to the vale release on March 11th.

spier commented 2 months ago

Looking at this further, I assume that the issue stems from the v3.0 upgrade. https://github.com/errata-ai/vale/releases/tag/v3.0.0

The location of vocabularies has moved from $StylesPath/Vocab to $StylesPath/config/vocabularies.

The 3.0 release happened on January 10th, so it does not explain the timing of the issues we saw.

spier commented 2 months ago

Made the required changes to our isc-styles, and released it: https://github.com/InnerSourceCommons/isc-styles/releases/tag/v18

Re-ran the GHA here and confirmed that it works ✅ https://github.com/InnerSourceCommons/InnerSourcePatterns/actions/runs/8647723967

The unexpected vale annotations are now gone from the PR that I tested this on (see screenshot).

Screenshot 2024-04-13 at 10 12 23

spier commented 2 months ago

This has been fixed (by releases outside of this repo. i.e. there are no PRs within this repo related to this).