Skip to content

Commit 24d790b

Browse files
Timofey Zavrazhnovamaksimovv
authored andcommitted
CS-47169064: Kaiten integration
1 parent 8c08a1c commit 24d790b

10 files changed

Lines changed: 58 additions & 18 deletions
40.9 KB
Loading
43.1 KB
Loading
39.5 KB
Loading
42 KB
Loading
-39.8 KB
Binary file not shown.
-43.9 KB
Binary file not shown.

docs/on-premise/how-to/notifications.en.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ hide:
55

66
# Notification settings
77

8-
For each policy, you can configure additional notifications, in addition to viewing the results in the `Policy Alerts` section. There are currently two notification methods available: via **email** and via the **Jira** task manager.
8+
For each policy, you can configure additional notifications, in addition to viewing the results in the `Policy Alerts` section. There are currently three notification methods available: via **email** and via the **Jira** and **Kaiten** task managers.
99

1010
## Email notifications
1111

@@ -33,33 +33,53 @@ If both groups and projects are specified, alerts will include information for a
3333

3434
The policy results email is sent **after the project** has been scanned. The content of the email depends on the selected template.
3535

36-
## Create tasks in Jira
36+
## Task managers integration
3737

38-
CodeScoring supports integration with the Jira Task Manager to generate tasks for triggered policies. The integration is configured in the `Settings -> Notifications -> Task managers` section.
38+
CodeScoring supports integration with the Jira and Kaiten task managers to generate tasks for triggered policies. The integration is configured in the `Settings -> Notifications -> Task managers` section.
3939

4040
The **Setup new** button form is used to create a new integration.
4141

4242
- **Name** - name of the integration;
43-
- **Type** - type of task manager (by default - Jira Server);
43+
- **Type** - type of task manager;
4444
- **URL** - address where the task manager can be accessed;
4545
- **Auth type** - authentication type (via access token or login and password).
4646

47+
!!! note "Kaiten authentication type"
48+
Kaiten only supports authentication via access token.
49+
4750
After filling in the fields, you can test the connection to the server by clicking **Test it**, or complete the creation by clicking **Setup now**.
4851

4952
![CodeScoring Jira settings example](/assets/img/jira-settings.png)
5053

51-
Once the integration is configured, under `Actions` on the policy page, you can add a Jira server on which to create a task with the policy results:
54+
## Creating tasks in task managers
55+
56+
Once the integration is configured, under `Actions` on the policy page, you can add a Jira or Kaiten server on which to create a task with the policy results:
57+
58+
### Creating tasks in Kaiten
59+
60+
![CodeScoring Kaiten task settings example](/assets/img/policy_actions_kaiten-en.png)
61+
62+
- **Mode** — task sending mode:
63+
- Send all the alerts together;
64+
- Send each alert separately.
65+
- **Groups** — groups of projects to which notification is made. If not specified, all groups are implied;
66+
- **Projects** — the specific projects for which the notification is made. If not specified, all projects are implied.
67+
- **Server** — task manager (in this case Kaiten);
68+
- **Project/Board** — Kaiten-boards;
69+
- **Task type** — card type;
70+
71+
### Creating tasks in Jira
5272

53-
![CodeScoring Jira settings example](/assets/img/policy_actions_task_manager-en.png)
73+
![CodeScoring Jira settings example](/assets/img/policy_actions_jira-en.png)
5474

5575
- **Mode** — task sending mode:
5676
- Send all the alerts together;
5777
- Send each alert separately.
5878
- **Groups** — groups of projects to which notification is made. If not specified, all groups are implied;
5979
- **Projects** — the specific projects for which the notification is made. If not specified, all projects are implied.
6080
- **Server** — task manager (in this case Jira);
61-
- **Project** — Jira-project;
62-
- **Task** — card type: *Task*, *Story* or *Bug*;
81+
- **Project/Board** — Jira-project;
82+
- **Task type** — card type: *Task*, *Story* or *Bug*;
6383
- **Task priority** - card priority. If not specified the default Jira task priority would be used;
6484
- **Template** - [template](#template-management) name. If not specified the default template would be used.
6585

docs/on-premise/how-to/notifications.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ hide:
55

66
# Настройка уведомлений
77

8-
Для каждой политики можно настроить дополнительные уведомления о срабатывании политик, помимо просмотра результатов в разделе `Алерты`. На данный момент доступно два способа оповещения: через **email** и через таск-менеджер **Jira**.
8+
Для каждой политики можно настроить дополнительные уведомления о срабатывании политик, помимо просмотра результатов в разделе `Алерты`. На данный момент доступно три способа оповещения: через **email** и через таск-менеджеры **Jira** и **Kaiten**.
99

1010
## Уведомления через email
1111

@@ -33,33 +33,53 @@ hide:
3333

3434
Письмо с результатами работы политики отправляется **по завершении сканирования проекта**. Содержимое письма зависит от выбранного шаблона.
3535

36-
## Создание задач в Jira
36+
## Интеграция с таск-менеджерами
3737

38-
CodeScoring поддерживает интеграцию с таск-менеджером Jira для формирования задач по сработавшим политикам. Настройка интеграции происходит в разделе `Настройки -> Уведомления -> Менеджеры задач`.
38+
CodeScoring поддерживает интеграцию с таск-менеджерами Jira и Kaiten для формирования задач по сработавшим политикам. Настройка интеграции происходит в разделе `Настройки -> Уведомления -> Менеджеры задач`.
3939

4040
Для создания новой интеграции используется форма по кнопке **Добавить**.
4141

4242
- **Название** - название интеграции;
43-
- **Тип** - тип таск-менеджера (по умолчанию – Jira Server);
43+
- **Тип** - тип таск-менеджера;
4444
- **URL** - адрес, по которому доступен таск-менеджер;
4545
- **Тип аутентификации** - аутентификация через токен доступа или логин и пароль.
4646

47+
!!! note "Тип аутентификации для Kaiten"
48+
Kaiten поддерживает аутентификацию только через токен доступа.
49+
4750
После заполнения полей можно проверить соединение с сервером по кнопке **Проверить подключение**, или завершить создание по кнопке **Добавить**.
4851

4952
![CodeScoring Jira settings example](/assets/img/ru-jira-settings.png)
5053

51-
После настройки интеграции на вкладке `Действия` на странице политики можно добавить сервер Jira, на котором будет создаваться задача с результатами работы политики:
54+
## Создание задач в таск-менеджерах
55+
56+
После настройки интеграции на вкладке `Действия` на странице политики можно добавить сервер Jira или Kaiten, на котором будет создаваться задача с результатами работы политики:
57+
58+
### Создание задач в Kaiten
59+
60+
![CodeScoring Kaiten task settings example](/assets/img/policy_actions_kaiten.png)
61+
62+
- **Режим** — режим отправки:
63+
- Отправить каждое оповещение отдельно;
64+
- Отправить все оповещения вместе.
65+
- **Группы** — группы проектов, на которые делается оповещение. Если не указано, подразумеваются все группы;
66+
- **Проекты** — конкретные проекты, на которые делается оповещение. Если не указано, подразумеваются все проекты;
67+
- **Сервер** — таск-менеджер (в данном случае Kaiten);
68+
- **Проект/Доска** — доска в Kaiten;
69+
- **Тип задачи** — тип карточки доступный в Kaiten;
70+
71+
### Создание задач в Jira
5272

53-
![CodeScoring Jira settings example](/assets/img/policy_actions_task_manager.png)
73+
![CodeScoring Jira task settings example](/assets/img/policy_actions_jira.png)
5474

5575
- **Режим** — режим отправки:
5676
- Отправить каждое оповещение отдельно;
5777
- Отправить все оповещения вместе.
5878
- **Группы** — группы проектов, на которые делается оповещение. Если не указано, подразумеваются все группы;
5979
- **Проекты** — конкретные проекты, на которые делается оповещение. Если не указано, подразумеваются все проекты;
6080
- **Сервер** — таск-менеджер (в данном случае Jira);
61-
- **Проект** — проект в Jira;
62-
- **Задача** — тип карточки: *Task*, *Story* или *Bug*;
81+
- **Проект/Доска** — проект в Jira;
82+
- **Тип задачи** — тип карточки: *Task*, *Story* или *Bug*;
6383
- **Приоритет задачи** - приоритет карточки. Если не указан, будет использован приоритет по умолчанию на стороне Jira;
6484
- **Шаблон** - название [шаблона](#template-management). Если не указано, будет использован стандартный шаблон.
6585

docs/on-premise/how-to/policies.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ To create such a policy, you need to add two groups united by the **OR** express
185185

186186
![Policy example](/assets/img/policy-example-en.png)
187187

188-
The policy becomes active immediately after creation by clicking the **Create** button. For the created policy, you can configure actions when it is triggered: [email notification](/on-premise/how-to/notifications.en/#email-notifications) or [creation of a task in Jira](/on-premise/how-to/notifications.en/#create-tasks-in-jira).
188+
The policy becomes active immediately after creation by clicking the **Create** button. For the created policy, you can configure actions when it is triggered: [email notification](/on-premise/how-to/notifications.en/#email-notifications) or [creation of a task in Jira or Kaiten](/on-premise/how-to/notifications.en/#creating-tasks-in-kaiten).
189189

190190
**Important**: policies are triggered during analysis, so it is important to create them before running the analysis.
191191

docs/on-premise/how-to/policies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ hide:
185185

186186
![Policy example](/assets/img/policy-example.png)
187187

188-
Политика становится активной сразу после создания по нажатию кнопки **Создать**. Для созданной политики можно настроить действия при ее срабатывании: [уведомление на почту](/on-premise/how-to/notifications/#email) или [создание задачи в Jira](/on-premise/how-to/notifications/#jira).
188+
Политика становится активной сразу после создания по нажатию кнопки **Создать**. Для созданной политики можно настроить действия при ее срабатывании: [уведомление на почту](/on-premise/how-to/notifications/#email) или [создание задачи в Jira или Kaiten](/on-premise/how-to/notifications/#kaiten).
189189

190190
**Важно**: политики срабатывают во время анализа, поэтому важно их создать до запуска анализа.
191191

0 commit comments

Comments
 (0)