diff options
Diffstat (limited to 'doc/gitlab-webhooks.markdown')
| -rw-r--r-- | doc/gitlab-webhooks.markdown | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/gitlab-webhooks.markdown b/doc/gitlab-webhooks.markdown new file mode 100644 index 00000000..9d9ecaf5 --- /dev/null +++ b/doc/gitlab-webhooks.markdown @@ -0,0 +1,65 @@ +Gitlab webhooks +=============== + +Gitlab events can be connected to Kanboard automatic actions. + +List of supported events +------------------------ + +- Gitlab commit received +- Gitlab issue opened +- Gitlab issue closed +- Gitlab issue comment created + +List of supported actions +------------------------- + +- Create a task from an external provider +- Close a task +- Create a comment from an external provider + +Configuration +------------- + + + +1. On Kanboard, go to the project settings and choose the section **Integrations** +2. Copy the Gitlab webhook url +3. On Gitlab, go to the project settings and go to the section **Webhooks** +4. Check the boxes **Push Events**, **Comments** and **Issues Events** +5. Paste the url and save + +Examples +-------- + +### Close a Kanboard task when a commit pushed to Gitlab + +- Choose the event: **Gitlab commit received** +- Choose the action: **Close the task** + +When one or more commits are sent to Gitlab, Kanboard will receive the information, each commit message with a task number included will be closed. + +Example: + +- Commit message: "Fix bug #1234" +- That will close the Kanboard task #1234 + +### Create a Kanboard task when a new issue is opened on Gitlab + +- Choose the event: **Gitlab issue opened** +- Choose the action: **Create a task from an external provider** + +When a task is created from a Gitlab issue, the link to the issue is added to the description and the task have a new field named "Reference" (this is the Gitlab ticket number). + +### Close a Kanboard task when an issue is closed on Gitlab + +- Choose the event: **Gitlab issue closed** +- Choose the action: **Close the task** + +### Create a comment on Kanboard when an issue is commented on Gitlab + +- Choose the event: **Gitlab issue comment created** +- Choose the action: **Create a comment from an external provider** + +If the username is the same between Gitlab and Kanboard the comment author will be assigned, otherwise there is no author. +The user also have to be member of the project in Kanboard.
\ No newline at end of file |