Repository navigation
Pin the Vale style packages instead of committing them - #2545
Merged
Merged
Conversation
The three public packages were committed in one import in September 2023 and never touched since, so the Google style this repo enforces is three years old by accident rather than by choice. `vale sync` fetches them, and the action runs it, so they do not need to be in the tree. Pinning by release URL keeps the behavior fixed: v0.6.3, v0.3.4 and v0.4.1 produce the same 101 alerts in the same 74 pages as the committed copies. Tracking `latest` instead would add four Google rules nobody has reviewed. `Packages` accepts URLs but not name@version, so the pins are full release URLs. Moving them forward is now a one-line change.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This branch was successfully deployed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
styles/Google,styles/proselintandstyles/write-goodwere committed in a single import in September 2023 and never touched since, so the Google style this repo enforces is three years old by accident rather than by choice.They do not need to be in the tree.
vale syncfetches them and the action runs it by default, which is howsprites-docsworks in superfly/sprites-docs#264.Pinning by release URL keeps today's behavior exactly. I ran v0.6.3, v0.3.4 and v0.4.1 against all 532 handwritten pages and got the same 101 alerts in the same 74 files as the committed copies, because the config already disables nearly every Google rule. Tracking
latestwould instead addGoogle.WordListCase,Google.Timeless,Google.AnthropomorphismandGoogle.ExcessiveClaims, none of which anyone has reviewed. Moving the pins forward is now a one-line change.Packagesaccepts URLs but notname@version, so the pins are full release URLs. The three directories go into.gitignoreso a localvale syncdoes not dirty the tree.Independent of #2544 and merges in either order. I test-merged the two:
.vale.iniauto-merges with no conflict, and the combined result is the same 101 alerts.