Skip to content

Introduce a Git hook to help ensure commits are signed-off #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philipjohn wants to merge 3 commits into
base: release_1.4.0
Choose a base branch
from
+26 −0
Open

Introduce a Git hook to help ensure commits are signed-off #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cc95a5
Add a commit-msg hook to ensure commits are signed-off
philipjohn Jun 24, 2025
6b22581
Add a Git hook installer and handy composer setup script to run it
philipjohn Jun 24, 2025
ea1ad94
Supplement the contributing guidelines with the new Git hook
philipjohn Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .githooks/commit-msg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/bin/sh

# Ensure the commit is signed-off by the author.
if ! grep -q '^Signed-off-by: ' "$1"; then
Copy link

@kasparsd kasparsd Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we rewrite this in NodeJS to remove the Bash dependency? All of the tooling already requires Node so that would work out of the box for everyone consistently.

echo >&2 "Commit message must be signed off by the author."
exit 1
fi

# Catch duplicate Signed-off-by lines.
test "" = "$(grep '^Signed-off-by: ' "$1" |
sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || {
echo >&2 Duplicate Signed-off-by lines.
exit 1
}
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ $ git commit -s -m 'My commit message.'

**Please Note:** This is adding a _sign-off_ to the commit, which is not the same as *signing* your commits (which involves GPG keys).

Alternatively, run `composer run setup` to install a git hook which will automatically reject your commits if they are not signed off.

## Development Environment

This plugin is ready to use with wp-env for local development, with a default configuration included in the repository. `npm run env` is an alias for `wp-env`:
Expand Down
7 changes: 7 additions & 0 deletions bin/install-git-hooks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/bin/bash -e
#
# Create our distribution zips.

# Create a link to our commit-msg hook.
ln -s -f ../../.githooks/commit-msg .git/hooks/commit-msg
echo "Installed commit-msg hook."
3 changes: 3 additions & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
"lock": false
},
"scripts": {
"setup": [
"./bin/install-git-hooks.sh"
Copy link

@kasparsd kasparsd Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I wonder if this would be better suited for package.json since that is the canonical runner of scripts.

  2. There is git config --local core.hooksPath .githooks which would set the hooks directory and avoid the need to symlink files. This makes it work across operating systems and it is the same logic that husky uses behind the scenes. It makes is clear which hooks are available and can be enabled.

],
"test": [
"Composer\\Config::disableProcessTimeout",
"@php ./vendor/phpunit/phpunit/phpunit"
Expand Down