https://github.com/amansilla/git-hooks-composer-installer

This composer plugin helps you automate the installation git side hooks.
https://github.com/amansilla/git-hooks-composer-installer

automation composer git git-hooks hook-manager hooks plugin

Last synced: about 1 year ago
JSON representation

This composer plugin helps you automate the installation git side hooks.

• Host: GitHub
• URL: https://github.com/amansilla/git-hooks-composer-installer
• Owner: amansilla
• License: mit
• Created: 2016-06-21T09:51:23.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-04-16T22:57:14.000Z (about 8 years ago)
• Last Synced: 2025-03-23T23:11:47.516Z (over 1 year ago)
• Topics: automation, composer, git, git-hooks, hook-manager, hooks, plugin
• Language: PHP
• Homepage:
• Size: 40 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Git Hooks Composer Installer

===========================

[![Build Status](https://travis-ci.org/amansilla/git-hooks-composer-installer.svg?branch=master)](https://travis-ci.org/amansilla/git-hooks-composer-installer)

[![Build status](https://ci.appveyor.com/api/projects/status/j8x3uj96yeajf7qj/branch/master?svg=true)](https://ci.appveyor.com/project/amansilla/git-hooks-composer-installer/branch/master)

[![Latest Stable Version](https://poser.pugx.org/ams/git-hooks-installer/v/stable)](https://packagist.org/packages/ams/git-hooks-installer)

[![Total Downloads](https://poser.pugx.org/ams/git-hooks-installer/downloads)](https://packagist.org/packages/ams/git-hooks-installer)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/amansilla/git-hooks-composer-installer/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/amansilla/git-hooks-composer-installer/?branch=master)

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/c1015283-d2e4-49b6-8094-b3187873e50e/mini.png)](https://insight.sensiolabs.com/projects/c1015283-d2e4-49b6-8094-b3187873e50e)

[![License](https://poser.pugx.org/ams/git-hooks-installer/license)](https://packagist.org/packages/ams/git-hooks-installer)

Latest release: [1.0.0](https://packagist.org/packages/ams/git-hooks-installer#1.0.0)

This plugin helps you automate the installation git hooks using [composer](https://getcomposer.org/).

Installation

------------

Just run the following command:

    $ composer require --dev ams/git-hooks-installer

or if you prefer add the following to the `composer.json` file:

    {

        "require-dev": {

            "ams/git-hooks-installer": "^1.0"

        },

        "extra": {

            "git-root-dir": "."

        }

    }

Usage

-----

When the git-hooks-composer installer is run, it only looks for git-hooks among your project dependencies. If your package

is a git hook and you want it to be installed with composer automatically you'll need to define a `composer.json` as follows:

    {

        "type": "git-hook"

    }

    

The git hooks scripts should be located in the package root directory.

Currently are the following git hooks supported:

* `applypatch-msg`

* `pre-applypatch`

* `post-applypatch`

* `pre-commit`

* `prepare-commit-msg`

* `commit-msg`

* `post-commit`

* `pre-rebase`

* `post-checkout`

* `post-merge`

* `pre-push`

* `pre-auto-gc`

* `post-rewrite`

You can find any additional information about the git hooks on the [git documentation] online.

Contribute

----------

Contributions to are very welcome!

* Report any bugs or issues you find on the [issue tracker].

Support

-------

If you are having problems, send a mail to contact@amansilla.com or just write me [@flamingek] on Twitter.

License

-------

All contents of this package are licensed under the [MIT license].

[issue tracker]: https://github.com/amansilla/git-hooks-composer-installer/issues

[MIT license]: LICENSE

[@flamingek]: https://twitter.com/flamingek

[git documentation]: https://git-scm.com/docs/githooks