Do not try to lint deleted files #53
Merged
Conversation
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
jmikell821
approved these changes
Nov 21, 2025
Collaborator
jmikell821
left a comment
jmikell821
left a comment
There was a problem hiding this comment.
On my end, this LGTM, but will wait for a double confirmation from Fabri. Thanks for opening! ❤️
There was a problem hiding this comment.
Pull request overview
This PR fixes an error in the Vale linting workflow that occurs when files are deleted in a pull request. The issue manifests as an unhandled error when attempting to lint non-existent files, causing the issues variable to become non-iterable.
Key Changes:
- Added
--diff-filter=dflag togit diffcommands to exclude deleted files from linting - Applied the fix to both the file discovery step and the line range detection step
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
|
Thanks for the catch, @colleenmcginnis! Very elegant fix, too! Applying this ASAP. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In elastic/docs-content#3756 we're removing two Markdown files. When the Vale check runs, it errors out because
issuesis not iterable.I think this happens because when it tries to find the lines that were changed in the deleted files, it results in an error that messes up the content in the
vale_output.jsonfile. I added--diff-filter=dtogit diffto filter out deleted files when getting a list of files that have changed and need to be linted.I tested this locally and it seems to work, but I'm open to other suggestions!