Show More
@@ -3,17 +3,12 b'' | |||||
3 | Hipchat integration |
|
3 | Hipchat integration | |
4 | =================== |
|
4 | =================== | |
5 |
|
5 | |||
6 |
In order to set a |
|
6 | In order to set a Hipchat integration up, it is necessary to obtain the Hipchat | |
7 | service url by: |
|
7 | service url by: | |
8 |
|
8 | |||
9 |
1. Login |
|
9 | 1. Log into Hipchat (https://your-hipchat.hipchat.com/) | |
10 |
2. Go |
|
10 | 2. Go to *Integrations* -> *Build your own* | |
11 | 3. Select a room to post notifications to and save it |
|
11 | 3. Select a room to post notifications to and save it | |
12 |
|
12 | |||
13 | Once the integration is setup on hipchat you should have a url of the |
|
13 | Hipchat will create a URL for you to use in your integration as outlined in | |
14 | form: ` |
|
14 | :ref:`creating-integrations`. No newline at end of file | |
15 | which can be used in :ref:`creating-integrations` |
|
|||
16 |
|
||||
17 | Once you have set up a Hipchat webhook integrations url of the form: |
|
|||
18 | ``https://yourapp.hipchat.com/v2/room/123456/notification?auth_token=...``, |
|
|||
19 | create a ``hipchat`` integration in :ref:`creating-integrations`. |
|
@@ -3,10 +3,10 b'' | |||||
3 | Integrations |
|
3 | Integrations | |
4 | ------------ |
|
4 | ------------ | |
5 |
|
5 | |||
6 | Rhodecode supports integrations with external services for various events |
|
6 | Rhodecode supports integrations with external services for various events, | |
7 | such as commit pushes and pull requests. Multiple integrations of the same type |
|
7 | such as commit pushes and pull requests. Multiple integrations of the same type | |
8 |
|
|
8 | can be added at the same time; this is useful for posting different events to | |
9 | different events to different slack channels. |
|
9 | different Slack channels, for example. | |
10 |
|
10 | |||
11 | Supported integrations |
|
11 | Supported integrations | |
12 | ^^^^^^^^^^^^^^^^^^^^^^ |
|
12 | ^^^^^^^^^^^^^^^^^^^^^^ | |
@@ -24,22 +24,24 b' Type/Name |RC| Edi' | |||||
24 |
|
24 | |||
25 | .. _creating-integrations: |
|
25 | .. _creating-integrations: | |
26 |
|
26 | |||
27 |
Creating an |
|
27 | Creating an Integration | |
28 | ^^^^^^^^^^^^^^^^^^^^^^^ |
|
28 | ^^^^^^^^^^^^^^^^^^^^^^^ | |
29 |
|
29 | |||
30 | Integrations can be added globally via the admin UI: |
|
30 | Integrations can be added globally via the admin UI: | |
31 |
|
31 | |||
32 | :menuselection:`Admin --> Integrations` |
|
32 | :menuselection:`Admin --> Integrations` | |
33 |
|
33 | |||
34 |
or per repository in |
|
34 | or per repository in each repository's settings: | |
35 |
|
35 | |||
36 | :menuselection:`Admin --> Repositories --> Edit --> Integrations` |
|
36 | :menuselection:`Admin --> Repositories --> Edit --> Integrations` | |
37 |
|
37 | |||
38 |
To create an integration, select the type from the list |
|
38 | To create an integration, select the type from the list in the *Create New | |
39 |
|
|
39 | Integration* section. | |
40 |
|
40 | |||
41 |
The |
|
41 | The *Current Integrations* section shows existing integrations that have been | |
42 |
created along with their type (eg. |
|
42 | created along with their type (eg. Slack) and enabled status. | |
|
43 | ||||
|
44 | See pages specific to each type of integration for more instructions: | |||
43 |
|
45 | |||
44 | .. toctree:: |
|
46 | .. toctree:: | |
45 |
|
47 |
@@ -5,22 +5,23 b' JIRA integration' | |||||
5 |
|
5 | |||
6 | .. important:: |
|
6 | .. important:: | |
7 |
|
7 | |||
8 | In order to make issue numbers clickable in commit messages see the |
|
8 | JIRA integration is only available in |RCEE|. | |
9 | :ref:`rhodecode-issue-trackers-ref` section. The JIRA integration |
|
9 | ||
10 | only deals with altering JIRA issues. |
|
|||
11 |
|
10 | |||
12 | .. important:: |
|
11 | .. important:: | |
13 |
|
12 | |||
14 | JIRA integration is only available in |RCEE|. |
|
13 | In order to make issue numbers clickable in commit messages, see the | |
|
14 | :ref:`rhodecode-issue-trackers-ref` section. The JIRA integration | |||
|
15 | only deals with altering JIRA issues. | |||
15 |
|
16 | |||
16 |
|
17 | |||
17 | The JIRA integration allows you to reference and change issue statuses in |
|
18 | The JIRA integration allows you to reference and change issue statuses in | |
18 | JIRA directly from commit messages using commit message patterns such as |
|
19 | JIRA directly from commit messages using commit message patterns such as | |
19 | ``fixes #JIRA-235`` in order to change the status of issue JIRA-235 to |
|
20 | ``fixes #JIRA-235`` in order to change the status of issue JIRA-235 to | |
20 |
eg. |
|
21 | eg. "Resolved". | |
21 |
|
22 | |||
22 |
In order to apply a status to a JIRA issue it is necessary to find |
|
23 | In order to apply a status to a JIRA issue, it is necessary to find the | |
23 |
transition status id |
|
24 | transition status id in the *Workflow* section of JIRA. | |
24 |
|
25 | |||
25 |
Once you have the transition status id, create a |
|
26 | Once you have the transition status id, you can create a JIRA integration | |
26 | :ref:`creating-integrations`. |
|
27 | as outlined in :ref:`creating-integrations`. |
@@ -5,21 +5,24 b' Redmine integration' | |||||
5 |
|
5 | |||
6 | .. important:: |
|
6 | .. important:: | |
7 |
|
7 | |||
8 | In order to make issue numbers clickable in commit messages see the |
|
8 | Redmine integration is only available in |RCEE|. | |
9 | :ref:`rhodecode-issue-trackers-ref` section. The Redmine integration |
|
9 | ||
10 | only deals with altering Redmine issues. |
|
|||
11 |
|
10 | |||
12 | .. important:: |
|
11 | .. important:: | |
13 |
|
12 | |||
14 | Redmine integration is only available in |RCEE|. |
|
13 | In order to make issue numbers clickable in commit messages, see the section | |
|
14 | :ref:`rhodecode-issue-trackers-ref`. Redmine integration is specifically for | |||
|
15 | altering Redmine issues. | |||
15 |
|
16 | |||
16 | The Redmine integration allows you to reference and change issue statuses in |
|
|||
17 | Redmine directly from commit messages using commit message patterns such as |
|
|||
18 | ``fixes #235`` in order to change the status of issue 235 to eg. ``Resolved`` |
|
|||
19 |
|
17 | |||
20 | To set a Redmine integration up it is first necessary to obtain a Redmine api |
|
18 | Redmine integration allows you to reference and change issue statuses in | |
21 | key. This can be found in ``My Account`` in the Redmine application. |
|
19 | Redmine directly from commit messages, using commit message patterns such as | |
22 | If it is not there, you may have to enable API Access in Redmine settings. |
|
20 | ``fixes #235`` in order to change the status of issue 235 to eg. "Resolved". | |
23 |
|
21 | |||
24 | Once you have the api key, create a ``redmine`` integration in |
|
22 | To set a Redmine integration up, it is first necessary to obtain a Redmine API | |
|
23 | key. This can be found under *My Account* in the Redmine application. | |||
|
24 | You may have to enable API Access in Redmine settings if it is not already | |||
|
25 | available. | |||
|
26 | ||||
|
27 | Once you have the API key, create a Redmine integration as outlined in | |||
25 | :ref:`creating-integrations`. |
|
28 | :ref:`creating-integrations`. |
@@ -3,11 +3,19 b'' | |||||
3 | Slack integration |
|
3 | Slack integration | |
4 | ================= |
|
4 | ================= | |
5 |
|
5 | |||
6 |
To set a Slack integration up it is first necessary to set up a Slack webhook |
|
6 | To set a Slack integration up, it is first necessary to set up a Slack webhook | |
7 |
endpoint for your |
|
7 | API endpoint for your Slack channel. This can be done at: | |
8 |
|
8 | |||
9 | https://my.slack.com/services/new/incoming-webhook/ |
|
9 | https://my.slack.com/services/new/incoming-webhook/ | |
10 |
|
10 | |||
11 | Once you have set up a Slack webhook integrations url of the |
|
11 | Select the channel you would like to use, and Slack will provide you with the | |
12 | form: ``https://hooks.slack.com/services/...``, create a ``slack`` integration |
|
12 | webhook URL for configuration. | |
13 | in :ref:`creating-integrations`. |
|
13 | ||
|
14 | You can now create a Slack integration as outlined in | |||
|
15 | :ref:`creating-integrations`. | |||
|
16 | ||||
|
17 | .. note:: | |||
|
18 | Some settings in the RhodeCode admin are identical to the options within the | |||
|
19 | Slack integration. For example, if notifications are to be sent in a private | |||
|
20 | chat, leave the "Channel" field blank. Likewise, the Emoji option within | |||
|
21 | RhodeCode can override the one set in the Slack admin. No newline at end of file |
@@ -7,4 +7,6 b' The Webhook integration allows you to PO' | |||||
7 | or pull requests to a custom http endpoint as a json dict with details of the |
|
7 | or pull requests to a custom http endpoint as a json dict with details of the | |
8 | event. |
|
8 | event. | |
9 |
|
9 | |||
10 |
To create a webhook integration select |
|
10 | To create a webhook integration, select "webhook" in the integration settings | |
|
11 | and use the url and key from your custom webhook. See | |||
|
12 | :ref:`creating-integrations` for additional instructions. No newline at end of file |
@@ -5,12 +5,12 b' Issue Tracker Integration' | |||||
5 |
|
5 | |||
6 | You can set an issue tracker connection in two ways with |RCE|. |
|
6 | You can set an issue tracker connection in two ways with |RCE|. | |
7 |
|
7 | |||
8 | * At instance level you can set a default issue tracker. |
|
8 | * At the instance level, you can set a default issue tracker. | |
9 | * At |repo| level you can configure an integration with a different issue |
|
9 | * At the |repo| level, you can configure an integration with a different issue | |
10 | tracker. |
|
10 | tracker. | |
11 |
|
11 | |||
12 | To integrate |RCM| with an issue tracker you need to define a regular |
|
12 | To integrate |RCM| with an issue tracker, you need to define a regular | |
13 | expression that will fetch the issue ID stored in commit messages and replace |
|
13 | expression that will fetch the issue ID stored in commit messages, and replace | |
14 | it with a URL. This enables |RCE| to generate a link matching each issue to the |
|
14 | it with a URL. This enables |RCE| to generate a link matching each issue to the | |
15 | target |repo|. |
|
15 | target |repo|. | |
16 |
|
16 | |||
@@ -33,9 +33,8 b' 3. Select **Add** so save the rule to yo' | |||||
33 | Repository Issue Tracker Configuration |
|
33 | Repository Issue Tracker Configuration | |
34 | -------------------------------------- |
|
34 | -------------------------------------- | |
35 |
|
35 | |||
36 |
You can configure specific |repos| to use a different issue tracker |
|
36 | You can configure specific |repos| to use a different issue tracker than the | |
37 |
|
|
37 | default one. See the instructions in :ref:`repo-it` | |
38 | :ref:`repo-it` |
|
|||
39 |
|
38 | |||
40 | .. _issue-tr-eg-ref: |
|
39 | .. _issue-tr-eg-ref: | |
41 |
|
40 |
General Comments 0
You need to be logged in to leave comments.
Login now