Make BlitzForge Git hooks portable across contributor environments#30
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
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.
Non-technical summary
This makes BlitzForge's shipped local Git hooks usable across contributor environments instead of only on Windows shells. Contributors can now opt into the repo hooks with one Git config command, and the README explains what those hooks actually do.
Why this matters now: the live
developdocs said the full test suite ran as a local pre-commit hook, but on macOS the hook immediately failed because it hard-calledcmd.exe, and the post-commit cleanup logic depended on GNU-only shell behavior. That made the contributor workflow claim stronger than the implementation.After this change, the system is better because the documented local hook workflow is honest, cross-platform, and reproducible for fresh clones.
Technical summary
.hooks/pre-committo resolve the repo root and dispatch totest.baton Windows shells ortest.shon Unix-like hosts..hooks/post-committo use portable Bash +awkcleanup instead of GNU-specificsed -iandhead -c -1behavior.ReadMe.mdto documentgit config core.hooksPath .hooks, explain the shipped hook behavior, and stop implying hooks are automatic.Additional notes