Skip to content

Configuration

GitHooks uses a PHP configuration file (githooks.php) that returns an array with three sections: hooks, flows, and jobs.

graph TD
    H["<b>Hooks</b><br/>Map git events to flows/jobs"]
    F["<b>Flows</b><br/>Named groups of jobs<br/>with shared options"]
    J["<b>Jobs</b><br/>Individual QA tasks<br/>with declarative config"]

    H --> F
    H --> J
    F --> J

Structure

<?php
return [
    'hooks' => [
        'pre-commit' => ['lint', 'test'],
    ],

    'flows' => [
        'options' => ['fail-fast' => false, 'processes' => 2],
        'lint'    => ['jobs' => ['phpcs_src', 'phpmd_src']],
        'test'    => ['jobs' => ['phpunit_all']],
    ],

    'jobs' => [
        'phpcs_src' => [
            'type'     => 'phpcs',
            'paths'    => ['src'],
            'standard' => 'PSR12',
        ],
        'phpmd_src' => [
            'type'  => 'phpmd',
            'paths' => ['src'],
            'rules' => 'cleancode,codesize,naming',
        ],
        'phpunit_all' => [
            'type'   => 'phpunit',
            'config' => 'phpunit.xml',
        ],
    ],
];

How it fits together

  1. Git fires an event (e.g. pre-commit).
  2. Hooks resolve the event to one or more flows and/or jobs, applying conditions (branch filters, file patterns).
  3. Flows execute their jobs with shared options (parallel processes, fail-fast).
  4. Jobs build and run the shell command for each QA tool.

Sections

Section Required Description
Hooks No Maps git events to flows/jobs. Supports conditional execution by branch and staged files.
Flows Yes Named groups of jobs with shared execution options.
Jobs Yes Individual QA tasks with type-specific configuration. Supports inheritance via extends.
Options No Global and per-flow execution options (processes, fail-fast, main-branch).
Configuration File — File format, search paths, validation, and migration.

See also