https://github.com/gene-pavlovsky/kanboard-git-hooks

Git hooks for integration with Kanboard
https://github.com/gene-pavlovsky/kanboard-git-hooks

Last synced: 5 days ago
JSON representation

Git hooks for integration with Kanboard

• Host: GitHub
• URL: https://github.com/gene-pavlovsky/kanboard-git-hooks
• Owner: gene-pavlovsky
• License: gpl-3.0
• Created: 2016-04-04T00:50:57.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-03-30T08:11:58.000Z (over 6 years ago)
• Last Synced: 2024-08-02T12:43:42.331Z (3 months ago)
• Language: PHP
• Size: 24.4 KB
• Stars: 6
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - gene-pavlovsky/kanboard-git-hooks - Git hooks for integration with Kanboard (others)

README

        
Git hooks for integration with Kanboard

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

Developed by Gene Pavlovsky 

Description

-----------

Provides git hooks for integration with [Kanboard](http://kanboard.net/).

Automatically post comments and optionally close Kanboard tasks by referencing them in git commit messages, similar to [GitHub](https://help.github.com/articles/closing-issues-via-commit-messages/).

Issue numbers can be referenced as `#69`. The following keywords will close an issue via commit message:

- close

- closes

- closed

- fix

- fixes

- fixed

- resolve

- resolves

- resolved

- implement

- implements

- implemented

The hooks are written in `bash`, the Kanboard interface script in `php` using [fguillot/JsonRPC](https://github.com/fguillot/JsonRPC).

- `hooks/commit-msg` detects task IDs in the commit message and checks if they exist in Kanboard and belong to the correct project. If validation fails, commit is aborted.

- `hooks/post-commit` posts comments and optionally closes Kanboard tasks. If commit is amended, attempts to amend the task comment.

Downloads

---------

[Complete ZIP of the repository](https://github.com/gene-pavlovsky/kanboard-git-hooks/archive/master.zip)

Installation

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

1. Copy the contents of `hooks` directory to `.git/hooks` inside your repository.

2. In `hooks/kanboard`, install [fguillot/JsonRPC](https://github.com/fguillot/JsonRPC) using `php composer.phar install`.

3. Edit `hooks/post-commit` to customize the comment format.

4. Edit `hooks/kanboard/config.php` and optionally `hooks/kanboard/config.default.php`.  

Read the comments for explanations, as well as suggested TortoiseGit Issue Tracker Config settings.