Add Gitlab documentation
This commit is contained in:
@@ -76,6 +76,11 @@ Documentation
|
|||||||
- [Application settings](docs/application-configuration.markdown)
|
- [Application settings](docs/application-configuration.markdown)
|
||||||
- [Board settings](docs/board-configuration.markdown)
|
- [Board settings](docs/board-configuration.markdown)
|
||||||
|
|
||||||
|
### Integrations
|
||||||
|
|
||||||
|
- [Github webhooks](docs/github-webhooks.markdown)
|
||||||
|
- [Gitlab webhooks](docs/gitlab-webhooks.markdown)
|
||||||
|
|
||||||
#### More
|
#### More
|
||||||
|
|
||||||
- [Syntax guide](docs/syntax-guide.markdown)
|
- [Syntax guide](docs/syntax-guide.markdown)
|
||||||
@@ -107,10 +112,6 @@ Documentation
|
|||||||
- [GitHub authentication](docs/github-authentication.markdown)
|
- [GitHub authentication](docs/github-authentication.markdown)
|
||||||
- [Reverse proxy authentication](docs/reverse-proxy-authentication.markdown)
|
- [Reverse proxy authentication](docs/reverse-proxy-authentication.markdown)
|
||||||
|
|
||||||
### Integration
|
|
||||||
|
|
||||||
- [Github webhooks](docs/github-webhooks.markdown)
|
|
||||||
|
|
||||||
#### Developers and sysadmins
|
#### Developers and sysadmins
|
||||||
|
|
||||||
- [Email configuration](docs/email-configuration.markdown)
|
- [Email configuration](docs/email-configuration.markdown)
|
||||||
|
|||||||
@@ -25,6 +25,8 @@ List of available actions
|
|||||||
- Change the assignee based on an external username
|
- Change the assignee based on an external username
|
||||||
- Change the category based on an external label
|
- Change the category based on an external label
|
||||||
- Create a comment from an external provider
|
- Create a comment from an external provider
|
||||||
|
- Close a task
|
||||||
|
- Open a task
|
||||||
|
|
||||||
Configuration on Github
|
Configuration on Github
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|||||||
55
docs/gitlab-webhooks.markdown
Normal file
55
docs/gitlab-webhooks.markdown
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
Gitlab webhooks
|
||||||
|
===============
|
||||||
|
|
||||||
|
Gitlab events can be connected to Kanboard automatic actions.
|
||||||
|
|
||||||
|
List of supported events
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
- Gitlab commit received
|
||||||
|
- Gitlab issue opened
|
||||||
|
- Gitlab issue closed
|
||||||
|
|
||||||
|
List of supported actions
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
- Create a task from an external provider
|
||||||
|
- Close a task
|
||||||
|
|
||||||
|
Configuration
|
||||||
|
-------------
|
||||||
|
|
||||||
|
[INSERT SCREENSHOT]
|
||||||
|
|
||||||
|
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 the section **Webhooks**
|
||||||
|
4. Check the boxes **Push Events** 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**
|
||||||
Reference in New Issue
Block a user