build(ci): Provide diff for pre-commit failures #25638
Merged
Conversation
This file contains 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
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
jsoref
requested review from
villebro,
geido,
eschutho,
rusackas,
betodealmeida,
nytai,
mistercrunch,
craig-rueda,
john-bodley and
kgabryje
as code owners
rusackas
approved these changes
Oct 13, 2023
There was a problem hiding this comment.
Thanks! Pinging @craig-rueda to see if he has any objections since he knows more about the helm risks than I do.
rusackas
added
the
review:checkpoint
john-bodley
removed
the
review:checkpoint
john-bodley
reviewed
Oct 17, 2023
| @@ -86,7 +86,12 @@ jobs: | |||
| echo "HOMEBREW_REPOSITORY=$HOMEBREW_REPOSITORY" >>"${GITHUB_ENV}" | |||
| brew install norwoodj/tap/helm-docs | |||
| - name: pre-commit | |||
| run: pre-commit run --all-files | |||
There was a problem hiding this comment.
@jsoref and @craig-rueda would the pre-commit run --show-diff-on-failure flag be suffice?
--show-diff-on-failure When hooks fail, run `git diff` directly afterward.
There was a problem hiding this comment.
Maybe. I don't use this tool. As long as I can apply the diff and get it not to fail going forward.
There was a problem hiding this comment.
Seems like a good idea. I don't know much about pre commit tbh
cccs-rc
pushed a commit
to CybercentreCanada/superset
that referenced
this pull request
Mar 6, 2024
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
mistercrunch
added
🏷️ bot
sfirke
pushed a commit
to sfirke/superset
that referenced
this pull request
Mar 22, 2024
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
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.
SUMMARY
when pre-commit fails, it's typically because of changes made by one of the tools. As it knows what the changes are, this change provides access to people so that they can use
patch -p1to apply the changes instead of just being frustrated by an unhelpful CI.BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Before:
https://github.com/apache/superset/actions/runs/6507284267/job/17674397883
After:
https://github.com/check-spelling-sandbox/superset/actions/runs/6509697746/job/17681762469
TESTING INSTRUCTIONS
ADDITIONAL INFORMATION