cheppers / git-hooks
Provides a bridge between Git hooks and scripts under VCS.
Installs: 6 126
Dependents: 2
Suggesters: 0
Security: 0
Stars: 2
Watchers: 6
Forks: 0
Open Issues: 0
Type:composer-plugin
Requires
- php: >=7.2
- composer-plugin-api: ^1.1
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- codeception/codeception: ^4.1
- codeception/module-asserts: ^1.1
- composer/composer: ^1.10
- consolidation/robo: ^2.0
- squizlabs/php_codesniffer: ^3.5
- sweetchuck/robo-git: ^0.2.0
- sweetchuck/robo-phpcs: ^0.1.0
- webmozart/path-util: ^2.3
README
Triggers custom scripts from Git hooks.
This package provides a bridge between the un-versioned ./.git/hooks/*
scripts
and scripts in your Git repository.
When to use
If you want to put your Git hook scripts under VCS to share them with your teammates then this is the tool you are looking for.
How to use
- Step into you existing package's directory (or create a new one with
git init && composer init
) - Run
composer require --dev 'sweetchuck/git-hooks'
- Then you have two option
- Rely on Git hook scripts which are shipped with this package and implement
the logic in your
./.git-hooks
file. - Or create a
./git-hooks
directory and create Git hook files in it. (eg:./git-hooks/pre-commit
)
- Rely on Git hook scripts which are shipped with this package and implement
the logic in your
- The deployment script will be automatically triggered by the
post-install-cmd
Composer event.
Configuration
Example composer.json file:
{ "extra": { "sweetchuck/git-hooks": { "core.hooksPath": "./git-hooks", "symlink": true } } }
Configuration - core.hooksPath
Type: string
Default value: vendor/sweetchuck/git-hooks/git-hooks
(dynamically detected)
If the Git version is >= v2.9 then this value will be used to set git config core.hooksPath <PATH>
. If Git is older than 2.9 then the content of this
directory will be symbolically linked or copied to ./.git/hooks
directory.
Configuration - symlink
Type: boolean
Default value: false
This configuration option will be used only if Git version is older than v2.9.
Copy or symlink Git hook files from the original location (provided by the
core.hooksPath
configuration) to the ./.git/hooks
.
Example ./.git-hooks file
If you use the Git hooks script from this package
(vendor/sweetchuck/git-hooks/git-hooks
) you will need custom script which
catches Git hooks add triggers something really useful.
Copy the content below into ./.git-hooks
#!/usr/bin/env bash echo "BEGIN Git hook: ${sghHookName}" function sghExit () { echo "END Git hook: ${sghHookName}" exit $1 } # @todo Better detection for executables: php, composer.phar. sghRobo="$(composer config 'bin-dir')/robo" test -s "${sghBridge}.local" && . "${sghBridge}.local" sghTask="githook:${sghHookName}" # Exit without error if "robo" doesn't exists or it has no corresponding task. test -x "$sghRobo" || sghExit 0 "${sghRobo}" help "${sghTask}" 1> /dev/null 2>&1 || sghExit 0 if [ "$sghHasInput" = 'true' ]; then "$sghRobo" "${sghTask}" $@ <<< $(</dev/stdin) || sghExit $? else "$sghRobo" "${sghTask}" $@ || sghExit $? fi sghExit 0
Example ./RoboFile.php
<?php /** * Git hook tasks have to be started with 'githook' prefix. * So the method name format is: githook<GitHookNameInCamelCaseFormat> * Or use the @command annotation. */ class RoboFile extends \Robo\Tasks { /** * Demo pre-commit callback. * * @command githook:pre-commit */ public function githookPreCommit() { $this->say('The Git pre-commit hook is running'); } }