##// END OF EJS Templates
docs: updated integrations docs fix #4137
lisaq -
r645:c8c27324 default
parent child Browse files
Show More
@@ -1,19 +1,14 b''
1 1 .. _integrations-hipchat:
2 2
3 3 Hipchat integration
4 4 ===================
5 5
6 In order to set a hipchat integration up it is necessary to obtain the Hipchat
6 In order to set a Hipchat integration up, it is necessary to obtain the Hipchat
7 7 service url by:
8 8
9 1. Login to Hipchat (https://www.hipchat.com/)
10 2. Goto `Integrations` -> `Build your own`
9 1. Log into Hipchat (https://your-hipchat.hipchat.com/)
10 2. Go to *Integrations* -> *Build your own*
11 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
14 form: `
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`.
13 Hipchat will create a URL for you to use in your integration as outlined in
14 :ref:`creating-integrations`. No newline at end of file
@@ -1,50 +1,52 b''
1 1 .. _integrations:
2 2
3 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 7 such as commit pushes and pull requests. Multiple integrations of the same type
8 (eg. slack) can be added at the same time which is useful for example to post
9 different events to different slack channels.
8 can be added at the same time; this is useful for posting different events to
9 different Slack channels, for example.
10 10
11 11 Supported integrations
12 12 ^^^^^^^^^^^^^^^^^^^^^^
13 13
14 14 ============================ ============ =====================================
15 15 Type/Name |RC| Edition Description
16 16 ============================ ============ =====================================
17 17 :ref:`integrations-slack` |RCCEshort| https://slack.com/
18 18 :ref:`integrations-hipchat` |RCCEshort| https://www.hipchat.com/
19 19 :ref:`integrations-webhook` |RCCEshort| POST events as `json` to a custom url
20 20 :ref:`integrations-email` |RCEEshort| Send repo push commits by email
21 21 :ref:`integrations-redmine` |RCEEshort| Close/Resolve/Reference redmine issues
22 22 :ref:`integrations-jira` |RCEEshort| Close/Resolve/Reference JIRA issues
23 23 ============================ ============ =====================================
24 24
25 25 .. _creating-integrations:
26 26
27 Creating an integration
27 Creating an Integration
28 28 ^^^^^^^^^^^^^^^^^^^^^^^
29 29
30 30 Integrations can be added globally via the admin UI:
31 31
32 32 :menuselection:`Admin --> Integrations`
33 33
34 or per repository in the repository settings:
34 or per repository in each repository's settings:
35 35
36 36 :menuselection:`Admin --> Repositories --> Edit --> Integrations`
37 37
38 To create an integration, select the type from the list of types in the
39 `Create an integration` section.
38 To create an integration, select the type from the list in the *Create New
39 Integration* section.
40 40
41 The `Current integrations` section shows existing integrations that have been
42 created along with their type (eg. slack) and enabled status.
41 The *Current Integrations* section shows existing integrations that have been
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 46 .. toctree::
45 47
46 48 slack
47 49 hipchat
48 50 redmine
49 51 jira
50 52 webhook
@@ -1,26 +1,27 b''
1 1 .. _integrations-jira:
2 2
3 3 JIRA integration
4 4 ================
5 5
6 6 .. important::
7 7
8 In order to make issue numbers clickable in commit messages see the
9 :ref:`rhodecode-issue-trackers-ref` section. The JIRA integration
10 only deals with altering JIRA issues.
8 JIRA integration is only available in |RCEE|.
9
11 10
12 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 18 The JIRA integration allows you to reference and change issue statuses in
18 19 JIRA directly from commit messages using commit message patterns such as
19 20 ``fixes #JIRA-235`` in order to change the status of issue JIRA-235 to
20 eg. ``Resolved``.
21 eg. "Resolved".
21 22
22 In order to apply a status to a JIRA issue it is necessary to find out the
23 transition status id which can be found in the Workflow section of JIRA.
23 In order to apply a status to a JIRA issue, it is necessary to find the
24 transition status id in the *Workflow* section of JIRA.
24 25
25 Once you have the transition status id, create a ``jira`` integration in
26 :ref:`creating-integrations`.
26 Once you have the transition status id, you can create a JIRA integration
27 as outlined in :ref:`creating-integrations`.
@@ -1,25 +1,28 b''
1 1 .. _integrations-redmine:
2 2
3 3 Redmine integration
4 4 ===================
5 5
6 6 .. important::
7 7
8 In order to make issue numbers clickable in commit messages see the
9 :ref:`rhodecode-issue-trackers-ref` section. The Redmine integration
10 only deals with altering Redmine issues.
8 Redmine integration is only available in |RCEE|.
9
11 10
12 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
21 key. This can be found in ``My Account`` in the Redmine application.
22 If it is not there, you may have to enable API Access in Redmine settings.
18 Redmine integration allows you to reference and change issue statuses in
19 Redmine directly from commit messages, using commit message patterns such as
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 28 :ref:`creating-integrations`.
@@ -1,13 +1,21 b''
1 1 .. _integrations-slack:
2 2
3 3 Slack integration
4 4 =================
5 5
6 To set a Slack integration up it is first necessary to set up a Slack webhook api
7 endpoint for your slack channel, this can be done at:
6 To set a Slack integration up, it is first necessary to set up a Slack webhook
7 API endpoint for your Slack channel. This can be done at:
8 8
9 9 https://my.slack.com/services/new/incoming-webhook/
10 10
11 Once you have set up a Slack webhook integrations url of the
12 form: ``https://hooks.slack.com/services/...``, create a ``slack`` integration
13 in :ref:`creating-integrations`.
11 Select the channel you would like to use, and Slack will provide you with the
12 webhook URL for configuration.
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
@@ -1,10 +1,12 b''
1 1 .. _integrations-webhook:
2 2
3 3 Webhook integration
4 4 ===================
5 5
6 6 The Webhook integration allows you to POST events such as repository pushes
7 7 or pull requests to a custom http endpoint as a json dict with details of the
8 8 event.
9 9
10 To create a webhook integration select ``webhook`` in :ref:`creating-integrations`.
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
@@ -1,82 +1,81 b''
1 1 .. _rhodecode-issue-trackers-ref:
2 2
3 3 Issue Tracker Integration
4 4 =========================
5 5
6 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.
9 * At |repo| level you can configure an integration with a different issue
8 * At the instance level, you can set a default issue tracker.
9 * At the |repo| level, you can configure an integration with a different issue
10 10 tracker.
11 11
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
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
14 14 it with a URL. This enables |RCE| to generate a link matching each issue to the
15 15 target |repo|.
16 16
17 17 Default Issue Tracker Configuration
18 18 -----------------------------------
19 19
20 20 To integrate your issue tracker, use the following steps:
21 21
22 22 1. Open :menuselection:`Admin --> Settings --> Issue Tracker`.
23 23 2. In the new entry field, enter the following information:
24 24
25 25 * :guilabel:`Description`: A name for this set of rules.
26 26 * :guilabel:`Pattern`: The regular expression that will match issues
27 27 tagged in commit messages, or more see :ref:`issue-tr-eg-ref`.
28 28 * :guilabel:`URL`: The URL to your issue tracker.
29 29 * :guilabel:`Prefix`: The prefix with which you want to mark issues.
30 30
31 31 3. Select **Add** so save the rule to your issue tracker configuration.
32 32
33 33 Repository Issue Tracker Configuration
34 34 --------------------------------------
35 35
36 You can configure specific |repos| to use a different issue tracker if
37 you need to connect to a non-default one. See the instructions in
38 :ref:`repo-it`
36 You can configure specific |repos| to use a different issue tracker than the
37 default one. See the instructions in :ref:`repo-it`
39 38
40 39 .. _issue-tr-eg-ref:
41 40
42 41 Jira Integration
43 42 ----------------
44 43
45 44 * Regex = ``(?:^#|\s#)(\w+-\d+)``
46 45 * URL = ``https://myissueserver.com/issue/${id}``
47 46 * Issue Prefix = ``#``
48 47
49 48 Confluence (Wiki)
50 49 -----------------
51 50
52 51 * Regex = ``(?:conf-)([A-Z0-9]+)``
53 52 * URL = ``https://example.atlassian.net/display/wiki/${id}/${repo_name}``
54 53 * issue prefix = ``CONF-``
55 54
56 55 Redmine Integration
57 56 -------------------
58 57
59 58 * Regex = ``(issue-+\d+)``
60 59 * URL = ``https://myissueserver.com/redmine/issue/${id}``
61 60 * Issue Prefix = ``issue-``
62 61
63 62 Redmine (wiki)
64 63 --------------
65 64
66 65 * Regex = ``(?:wiki-)([a-zA-Z0-9]+)``
67 66 * URL = ``https://example.com/redmine/projects/wiki/${repo_name}``
68 67 * Issue prefix = ``Issue-``
69 68
70 69 Pivotal Tracker
71 70 ---------------
72 71
73 72 * Regex = ``(?:pivot-)(?<project_id>\d+)-(?<story>\d+)``
74 73 * URL = ``https://www.pivotaltracker.com/s/projects/${project_id}/stories/${story}``
75 74 * Issue prefix = ``Piv-``
76 75
77 76 Trello
78 77 ------
79 78
80 79 * Regex = ``(?:trello-)(?<card_id>[a-zA-Z0-9]+)``
81 80 * URL = ``https://trello.com/example.com/${card_id}``
82 81 * Issue prefix = ``Trello-``
General Comments 0
You need to be logged in to leave comments. Login now