Pre-receive hooks are scripts that run on the GitHub Enterprise server that you can use to implement quality checks.
When a push occurs, each script runs in an isolated environment and can perform checks on the content of the push. The scripts will cause the push to be accepted if the exit status is 0, or rejected if the exit status is non-zero.
Use pre-receive hooks to satisfy business rules, enforce regulatory compliance, and prevent certain common mistakes.
Examples of how you can use pre-receive hooks:
- Require commit messages to follow a specific pattern or format, such as including a valid ticket number or being over a certain length.
- Lock a branch or repository by rejecting all pushes.
- Prevent sensitive data from being added to the repository by blocking keywords, patterns or filetypes.
- Prevent a PR author from merging their own changes.
Impact on performance and workflows
Impact to developers and their workflows can be significant and must be considered carefully. Pre-receive hooks that are based on business needs and implemented thoughtfully will provide the most benefit to the organization as a whole.
Pre-receive hooks can have unintended effects on the performance of your GitHub Enterprise instance and should be carefully implemented and reviewed.