Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 1.67 KB

README.md

File metadata and controls

41 lines (33 loc) · 1.67 KB
Raw

Git hooks for integration with Kanboard

Developed by Gene Pavlovsky [email protected]

Description

Provides git hooks for integration with Kanboard. Automatically post comments and optionally close Kanboard tasks by referencing them in git commit messages, similar to GitHub. 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.

  • 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

Installation

  1. Copy the contents of hooks directory to .git/hooks inside your repository.
  2. In hooks/kanboard, install 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.