summaryrefslogtreecommitdiff
path: root/doc/automatic-actions.markdown
blob: 71dfa90ac62c903b8e9d89c933b3eec6dde00fcf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
Automatic Actions
=================

To minimize the user interaction, Kanboard support automated actions.

Each automatic action is defined like that:

- An event to listen
- An action linked to this event
- Eventually there is some parameters to define

Each project have a different set of automatic actions, the configuration panel is located on the project listing page, just click on the link **Automatic actions**.

Add a new action
----------------

### Choose an action

![Choose an action](http://kanboard.net/screenshots/documentation/project-automatic-action-step1.png)

### Choose an event

![Choose an event](http://kanboard.net/screenshots/documentation/project-automatic-action-step2.png)

### Define action parameters

![Define parameters](http://kanboard.net/screenshots/documentation/project-automatic-action-step3.png)

List of available events
------------------------

- Move a task to another column
- Move a task to another position in the same column
- Task modification
- Task creation
- Reopen a task
- Closing a task
- Task creation or modification
- Task assignee change
- Task link created or updated
- Github commit received
- Github issue opened
- Github issue closed
- Github issue reopened
- Github issue assignee change
- Github issue label change
- Github issue comment created
- Gitlab issue opened
- Gitlab issue closed
- Gitlab commit received
- Bitbucket commit received
- Bitbucket issue opened
- Bitbucket issue closed
- Bitbucket issue reopened
- Bitbucket issue assignee change
- Bitbucket issue comment created

List of available actions
-------------------------

- Close the task
- Open a task
- Assign the task to a specific user
- Assign the task to the person who does the action
- Duplicate the task to another project
- Move the task to another project
- Move the task to another column when assigned to a user
- Move the task to another column when assignee is cleared
- Assign a color when the task is moved to a specific column
- Assign a color to a specific user
- Assign automatically a color based on a category
- Assign automatically a category based on a color
- Create a comment from an external provider
- Create a task from an external provider
- Add a comment log when moving the task between columns
- Change the assignee based on an external username
- Change the category based on an external label
- Automatically update the start date
- Move the task to another column when the category is changed
- Send a task by email to someone
- Change task color when using a specific task link

Examples
--------

Here are some examples used in the real life:

### When I move a task to the column "Done", automatically close this task

- Choose the action: **Close the task**
- Choose the event: **Move a task to another column**
- Define the action parameter: **Column = Done** (this is the destination column)

### When I move a task to the column "To be validated", assign this task to a specific user

- Choose the action: **Assign the task to a specific user**
- Choose the event: **Move a task to another column**
- Define the action parameters: **Column = To be validated** and **User = Bob** (Bob is our tester)

### When I move a task to the column "Work in progress", assign this task to the current user

- Choose the action: **Assign the task to the person who does the action**
- Choose the event: **Move a task to another column**
- Define the action parameter: **Column = Work in progress**

### When a task is completed, duplicate this task to another project

Let's say we have two projects "Customer orders" and "Production", once the order is validated, swap it to the "Production" project.

- Choose the action: **Duplicate the task to another project**
- Choose the event: **Closing a task**
- Define the action parameters: **Column = Validated** and **Project = Production**

### When a task is moved to the last column, move the exact same task to another project

Let's say we have two projects "Ideas" and "Development", once the idea is validated, swap it to the "Development" project.

- Choose the action: **Move the task to another project**
- Choose the event: **Move a task to another column**
- Define the action parameters: **Column = Validated** and **Project = Development**

### I want to assign automatically a color to the user Bob

- Choose the action: **Assign a color to a specific user**
- Choose the event: **Task assignee change**
- Define the action parameters: **Color = Green** and **Assignee = Bob**

### I want to assign automatically a color to the defined category "Feature Request"

- Choose the action: **Assign automatically a color based on a category**
- Choose the event: **Task creation or modification**
- Define the action parameters: **Color = Blue** and **Category = Feature Request**

### I want to set the start date automatically when the task is moved to the column "Work in progress"

- Choose the action: **Automatically update the start date**
- Choose the event: **Move a task to another column**
- Define the action parameters: **Column = Work in progress**