summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2016-01-07 20:16:05 -0500
committerFrederic Guillot <fred@kanboard.net>2016-01-07 20:16:05 -0500
commit54b3cfe8a14e99ab2372fc5095facc3a2259f077 (patch)
tree3af8286c3bead5ff0a50895b9298a30dc9742b8e /doc
parent1ef6e6c2bf39234993b825d4b974301470c49e83 (diff)
Move bitbucket webhook to an external plugin
Diffstat (limited to 'doc')
-rw-r--r--doc/bitbucket-webhooks.markdown55
-rw-r--r--doc/github-webhooks.markdown99
-rw-r--r--doc/index.markdown1
3 files changed, 0 insertions, 155 deletions
diff --git a/doc/bitbucket-webhooks.markdown b/doc/bitbucket-webhooks.markdown
deleted file mode 100644
index 925615fa..00000000
--- a/doc/bitbucket-webhooks.markdown
+++ /dev/null
@@ -1,55 +0,0 @@
-Bitbucket webhooks
-==================
-
-Bitbucket events can be connected to Kanboard automatic actions.
-
-List of supported events
-------------------------
-
-- Bitbucket commit received
-- Bitbucket issue opened
-- Bitbucket issue closed
-- Bitbucket issue reopened
-- Bitbucket issue assignee change
-- Bitbucket issue comment created
-
-List of supported actions
--------------------------
-
-- Create a task from an external provider
-- Change the assignee based on an external username
-- Create a comment from an external provider
-- Close a task
-- Open a task
-
-Configuration
--------------
-
-![Bitbucket configuration](http://kanboard.net/screenshots/documentation/bitbucket-webhooks.png)
-
-1. On Kanboard, go to the project settings and choose the section **Integrations**
-2. Copy the Bitbucket webhook URL
-3. On Bitbucket, go to the project settings and go to the section **Webhooks**
-4. Choose a title for your webhook and paste the Kanboard URL
-
-Examples
---------
-
-### Close a Kanboard task when a commit pushed to Bitbucket
-
-- Choose the event: **Bitbucket commit received**
-- Choose action: **Close the task**
-
-When one or more commits are sent to Bitbucket, 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
-
-### Add comment when a commit received
-
-- Choose the event: **Bitbucket commit received**
-- Choose action: **Create a comment from an external provider**
-
-The comment will contain the commit message and the URL to the commit.
diff --git a/doc/github-webhooks.markdown b/doc/github-webhooks.markdown
deleted file mode 100644
index a20b5a18..00000000
--- a/doc/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.
diff --git a/doc/index.markdown b/doc/index.markdown
index 0030e6d0..bc3a2fbf 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -68,7 +68,6 @@ Using Kanboard
### Integrations
-- [Bitbucket webhooks](bitbucket-webhooks.markdown)
- [Gitlab webhooks](gitlab-webhooks.markdown)
- [iCalendar subscriptions](ical.markdown)
- [RSS/Atom subscriptions](rss.markdown)