Module git_branchless::commands::hooks

Callbacks for Git hooks.

Git uses “hooks” to run user-defined scripts after certain events. We extensively use these hooks to track user activity and e.g. decide if a commit should be considered obsolete.

The hooks are installed by the branchless init command. This module contains the implementations for the hooks.

Functions

hook_drop_commit_if_empty

For rebases, detect empty commits (which have probably been applied upstream) and write them to the rewritten-list file, so that they’re later passed to the post-rewrite hook.

hook_post_checkout

Handle Git’s post-checkout hook.

hook_post_commit

Handle Git’s post-commit hook.

hook_post_merge

Handle Git’s post-merge hook. It seems that Git doesn’t invoke the post-commit hook after a merge commit, so we need to handle this case explicitly with another hook.

hook_post_rewrite

Handle Git’s post-rewrite hook.

hook_reference_transaction

Handle Git’s reference-transaction hook.

hook_register_extra_post_rewrite_hook

For rebases, register that extra cleanup actions should be taken when the rebase finishes and calls the post-rewrite hook. We don’t want to change the behavior of git rebase itself, except when called via git-branchless, so that the user’s expectations aren’t unexpectedly subverted.

hook_skip_upstream_applied_commit

For rebases, if a commit is known to have been applied upstream, skip it without attempting to apply it.