summaryrefslogtreecommitdiff
path: root/docs/github-webhooks.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
committerFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
commit6c711f696f73bc59813f6834ec241aef3b626cbd (patch)
treeded4f0e8c7f8c672414ff3f2f84eac0f6d9073e5 /docs/github-webhooks.markdown
parentef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff)
Include documentation in the application
Diffstat (limited to 'docs/github-webhooks.markdown')
-rw-r--r--docs/github-webhooks.markdown99
1 files changed, 0 insertions, 99 deletions
diff --git a/docs/github-webhooks.markdown b/docs/github-webhooks.markdown
deleted file mode 100644
index a20b5a18..00000000
--- a/docs/github-webhooks.markdown
+++ /dev/null
@@ -1,99 +0,0 @@
-Github webhooks integration
-===========================
-
-Kanboard can be synchronized with Github.
-Currently, it's only a one-way synchronization: Github to Kanboard.
-
-Github webhooks are plugged to Kanboard automatic actions.
-When an event occurs on Github, an action can be performed on Kanboard.
-
-List of available events
-------------------------
-
-- Github commit received
-- Github issue opened
-- Github issue closed
-- Github issue reopened
-- Github issue assignee change
-- Github issue label change
-- Github issue comment created
-
-List of available actions
--------------------------
-
-- Create a task from an external provider
-- Change the assignee based on an external username
-- Change the category based on an external label
-- Create a comment from an external provider
-- Close a task
-- Open a task
-
-Configuration on Github
------------------------
-
-Go to your project settings page, on the left choose "Webhooks & Services", then click on the button "Add webhook".
-
-![Github configuration](http://kanboard.net/screenshots/documentation/github-webhooks.png)
-
-- **Payload url**: Copy and paste the link from the Kanboard project settings (section **Integrations > Github**).
-- Select **"Send me everything"**
-
-![Github webhook](http://kanboard.net/screenshots/documentation/kanboard-github-webhooks.png)
-
-Each time an event happens, Github will send an event to Kanboard now.
-The Kanboard webhook url is protected by a random token.
-
-Everything else is handled by automatic actions in your Kanboard project settings.
-
-Examples
---------
-
-### Close a Kanboard task when a commit pushed to Github
-
-- Choose the event: **Github commit received**
-- Choose the action: **Close the task**
-
-When one or more commits are sent to Github, 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 Github
-
-- Choose the event: **Github issue opened**
-- Choose the action: **Create a task from an external provider**
-
-When a task is created from a Github issue, the link to the issue is added to the description and the task have a new field named "Reference" (this is the Github ticket number).
-
-### Close a Kanboard task when an issue is closed on Github
-
-- Choose the event: **Github issue closed**
-- Choose the action: **Close the task**
-
-### Reopen a Kanboard task when an issue is reopened on Github
-
-- Choose the event: **Github issue reopened**
-- Choose the action: **Open the task**
-
-### Assign a task to a Kanboard user when an issue is assigned on Github
-
-- Choose the event: **Github issue assignee change**
-- Choose the action: **Change the assignee based on an external username**
-
-Note: The username must be the same between Github and Kanboard and the user must be member of the project.
-
-### Assign a category when an issue is tagged on Github
-
-- Choose the event: **Github issue label change**
-- Choose the action: **Change the category based on an external label**
-- Define the label and the category
-
-### Create a comment on Kanboard when an issue is commented on Github
-
-- Choose the event: **Github issue comment created**
-- Choose the action: **Create a comment from an external provider**
-
-If the username is the same between Github 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.