Modify the pre-push githook to run Tidy on only committed changes. #147084
Conversation
added error handling for git stash and apply fix tidy err abort if stash push fails fix tidy errors... again
|
rustbot has assigned @Mark-Simulacrum. Use |
| if [ -n "$(git status --porcelain)" ]; then | ||
| echo "Stashing local uncommitted changes before running Tidy." | ||
| # Stash uncommitted changes so that tidy only checks what you are going to push. | ||
| git stash push -u -q |
There was a problem hiding this comment.
I think that doing anything with untracked files might be a bit dangerous. I personally wouldn't want these scripts ever touching anything untracked by git.
|
So I think the best way to avoid stashing untracked files would probably be to have I did a little bit of digging anyways, and don't really think stashing untracked is extra dangerous though. Stash is basically all or nothing so on failure the working dir won't be affected. And once stashed it's still a commit under the hood so it's recoverable even if you explicitly drop the stash. But it is still stored locally, so there's always some risk I suppose. Just a note that Another option that could work well is throwing in a prompt asking if you want to stash changes before continuing. So if you're really worried you can back out and handle it manually if you prefer. I think it'd still have to include untracked unless you changed |
|
☔ The latest upstream changes (presumably #147118) made this pull request unmergeable. Please resolve the merge conflicts. |
I think this is a fairly simple solution for #125654. The basic idea is just to stash local changes, run tidy, and then pop the changes back after Tidy runs for the pre-push git hook. It sort of got a bit more complicated with the error handling, but still seems like a reasonable solution.
A few things to note:
I opted to fail the whole check if
git stash push -ufails instead of continuing to run Tidy on the unstashed changes. My thinking isgit stashdoesn't really fail easily so if it does something is probably pretty wrong and this way there's no inconsistency on what is being checked.In general I think it's unlikely for
git stash applyto fail because Tidy does not actually change files during its checks so there shouldn't be any risk of merge conflicts. If it does fail, it's a bit of a pain for the user, but handled and nothing is lost.