Skip to content

Latest commit

 

History

History
221 lines (156 loc) · 6.83 KB

git-hooks.rst

File metadata and controls

221 lines (156 loc) · 6.83 KB
Raw

Git hooks

Overview

Toolkit provides a way to activate or deactivate git hooks.

By default, Toolkit provides three hooks:

  • pre-commit: Run the PHPcs against the modified files.
  • commit-msg: Check if the commit message meets the conditions.
  • pre-push: Run a set of linters and checks.

Configuration

The default configurations can be found in the runner configurations under toolkit.hooks.

toolkit:
  hooks:
    # A relative path from the project root where the hooks are located.
    dir: 'resources/git/hooks'
    active:
      # Check for modified files and run PHPcs.
      - pre-commit
      # Check if the commit message is properly formatted.
      - commit-msg
      # Run the PHPcs and linters (configurable).
      - pre-push
    commit-msg:
      example: 'ABC-123: The commit message.'
      conditions:
        - message: "The commit message must start with the JIRA issue number."
          regex: /^[A-Z]+\-\d+/
        - message: "The JIRA issue number must be followed by a colon and space."
          regex: /^[A-Z]+\-\d+:\ /
        - message: "The subject must start with capital letter."
          regex: /^[A-Z]+\-\d+:\ [A-Z]/
        - message: "The commit message must end with a period."
          regex: /\.$/
    pre-push:
      commands:
        - toolkit:test-phpcs
        - toolkit:lint-yaml
        - toolkit:lint-php
        - toolkit:opts-review

How to use

List available hooks

To list the available hooks, execute the following command:

> ./vendor/bin/run toolkit:hooks-list
+----------------------+------------------+-------------+---------------+
| Hook                 | Active by config | Hook exists | Modified file |
+----------------------+------------------+-------------+---------------+
| commit-msg (toolkit) | Yes              | No          | No            |
| pre-commit (toolkit) | Yes              | No          | No            |
| pre-push (toolkit)   | Yes              | No          | No            |
+----------------------+------------------+-------------+---------------+

Labels:

Hook - Represents the name of the hook.

Active by config - Whether the hook is active in configuration.

Hooks exists - Whether the hook is enabled under .git/hooks folder.

Modified file - Whether the hook is not the same as in the resources/git/hooks folder.

Enable all the active hooks

The command toolkit:hooks-enable will read the configuration toolkit.hooks.active and enable these hooks.

Alternatively you can use the option hooks to enable a set of hooks.

Disable all the active hooks

The command toolkit:hooks-disable will read the configuration toolkit.hooks.active and disable these hooks.

Alternatively you can use the option hooks to disable a set of hooks.

Delete all the enabled hooks

The command toolkit:hooks-delete-all will delete all the enabled hooks in the .git/hooks directory.

How it works

Each hook can call directly the command toolkit:hooks-run with the first argument representing the hook name, and you can pass up to 3 extra arguments.

Example of the pre-commit hook (no extra arguments).

#!/bin/sh
./vendor/bin/run toolkit:hooks-run `basename "$0"`

Example of the prepare-commit-msg hook (receives two extra arguments).

#!/bin/sh
./vendor/bin/run toolkit:hooks-run `basename "$0"` $1 $2

The command toolkit:hooks-run will transform the hook name and look for a callback in the format runHookName.

Example for hook prepare-commit-msg, toolkit will look for a callback named runPrepareCommitMsg().

The callback method will receive the ConsoleIO as argument and can get the arguments with $io->input()->getArguments().

For more details check the Commands class at EcEuropa\Toolkit\TaskRunner\Commands\GitHooksCommands

Extending the git hooks

Toolkit allows you to provide your own hooks and callbacks.

To do so, you need to

  • Create the hook under your resources/git/hooks folder.
  • Add the hook name to your active hooks under toolkit.hooks.active.
  • Create a new class extending the AbstractGitHooks class and define the run callback for the hook.

Create the hook

Add the hook that you want to the resources/git/hooks, in this example we will use the hook prepare-commit-msg, so we add the file resources/git/hooks/prepare-commit-msg.

#!/bin/sh
./vendor/bin/run toolkit:hooks-run `basename "$0"` $1 $2

Add the hook to the active hooks

In your runner.yml, extend the Toolkit configuration to add your custom hook.

Do not forget to copy the existing ones (in case you want to use them), otherwise your configuration will override the default provided by Toolkit.

toolkit:
  hooks:
    active:
      - pre-commit
      - commit-msg
      - pre-push
      - prepare-commit-msg

Create a class extending the AbstractGitHooks

Is in this class that you will define the callback for your hook.

In this class you can also override existing hook callbacks.

Add your class under src/TaskRunner/Commands.

<?php

namespace Digit\Qa\TaskRunner\Commands;

use EcEuropa\Toolkit\TaskRunner\AbstractGitHooks;
use Robo\ResultData;
use Robo\Symfony\ConsoleIO;

class QaGitHooksCommands extends AbstractGitHooks
{
    public function runCommitMsg(Console $io)
    {
      $args = $io->input()->getArguments();
      $commit_message = trim(file_get_contents($args['arg1']));
      $io->say("Commit message: $commit_message");
      return ResultData::EXITCODE_OK;
    }
}

Check if your hooks it active

List the available commands, your custom hook should be available.

> ./vendor/bin/run toolkit:hooks-list
+-------------------------------+------------------+-------------+---------------+
| Hook                          | Active by config | Hook exists | Modified file |
+-------------------------------+------------------+-------------+---------------+
| commit-msg (toolkit)          | Yes              | No          | No            |
| pre-commit (toolkit)          | Yes              | No          | No            |
| pre-push (toolkit)            | Yes              | No          | No            |
| prepare-commit-msg (digit-qa) | Yes              | No          | No            |
+-------------------------------+------------------+-------------+---------------+