docs: updated integrations docs fix #4137
This commit is contained in:
lisaq
parent
eb8b1f9e41
commit
889480af8a
7 changed files with 62 additions and 52 deletions
|
|
@ -3,17 +3,12 @@
|
|||
Hipchat integration
|
||||
===================
|
||||
|
||||
In order to set a hipchat integration up it is necessary to obtain the Hipchat
|
||||
In order to set a Hipchat integration up, it is necessary to obtain the Hipchat
|
||||
service url by:
|
||||
|
||||
1. Login to Hipchat (https://www.hipchat.com/)
|
||||
2. Goto `Integrations` -> `Build your own`
|
||||
1. Log into Hipchat (https://your-hipchat.hipchat.com/)
|
||||
2. Go to *Integrations* -> *Build your own*
|
||||
3. Select a room to post notifications to and save it
|
||||
|
||||
Once the integration is setup on hipchat you should have a url of the
|
||||
form: `
|
||||
which can be used in :ref:`creating-integrations`
|
||||
|
||||
Once you have set up a Hipchat webhook integrations url of the form:
|
||||
``https://yourapp.hipchat.com/v2/room/123456/notification?auth_token=...``,
|
||||
create a ``hipchat`` integration in :ref:`creating-integrations`.
|
||||
Hipchat will create a URL for you to use in your integration as outlined in
|
||||
:ref:`creating-integrations`.
|
||||
|
|
@ -3,10 +3,10 @@
|
|||
Integrations
|
||||
------------
|
||||
|
||||
Rhodecode supports integrations with external services for various events
|
||||
Rhodecode supports integrations with external services for various events,
|
||||
such as commit pushes and pull requests. Multiple integrations of the same type
|
||||
(eg. slack) can be added at the same time which is useful for example to post
|
||||
different events to different slack channels.
|
||||
can be added at the same time; this is useful for posting different events to
|
||||
different Slack channels, for example.
|
||||
|
||||
Supported integrations
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -24,22 +24,24 @@ Type/Name |RC| Edition Description
|
|||
|
||||
.. _creating-integrations:
|
||||
|
||||
Creating an integration
|
||||
Creating an Integration
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Integrations can be added globally via the admin UI:
|
||||
|
||||
:menuselection:`Admin --> Integrations`
|
||||
|
||||
or per repository in the repository settings:
|
||||
or per repository in each repository's settings:
|
||||
|
||||
:menuselection:`Admin --> Repositories --> Edit --> Integrations`
|
||||
|
||||
To create an integration, select the type from the list of types in the
|
||||
`Create an integration` section.
|
||||
To create an integration, select the type from the list in the *Create New
|
||||
Integration* section.
|
||||
|
||||
The `Current integrations` section shows existing integrations that have been
|
||||
created along with their type (eg. slack) and enabled status.
|
||||
The *Current Integrations* section shows existing integrations that have been
|
||||
created along with their type (eg. Slack) and enabled status.
|
||||
|
||||
See pages specific to each type of integration for more instructions:
|
||||
|
||||
.. toctree::
|
||||
|
||||
|
|
|
|||
|
|
@ -5,22 +5,23 @@ JIRA integration
|
|||
|
||||
.. important::
|
||||
|
||||
In order to make issue numbers clickable in commit messages see the
|
||||
:ref:`rhodecode-issue-trackers-ref` section. The JIRA integration
|
||||
only deals with altering JIRA issues.
|
||||
JIRA integration is only available in |RCEE|.
|
||||
|
||||
|
||||
.. important::
|
||||
|
||||
JIRA integration is only available in |RCEE|.
|
||||
In order to make issue numbers clickable in commit messages, see the
|
||||
:ref:`rhodecode-issue-trackers-ref` section. The JIRA integration
|
||||
only deals with altering JIRA issues.
|
||||
|
||||
|
||||
The JIRA integration allows you to reference and change issue statuses in
|
||||
JIRA directly from commit messages using commit message patterns such as
|
||||
``fixes #JIRA-235`` in order to change the status of issue JIRA-235 to
|
||||
eg. ``Resolved``.
|
||||
eg. "Resolved".
|
||||
|
||||
In order to apply a status to a JIRA issue it is necessary to find out the
|
||||
transition status id which can be found in the Workflow section of JIRA.
|
||||
In order to apply a status to a JIRA issue, it is necessary to find the
|
||||
transition status id in the *Workflow* section of JIRA.
|
||||
|
||||
Once you have the transition status id, create a ``jira`` integration in
|
||||
:ref:`creating-integrations`.
|
||||
Once you have the transition status id, you can create a JIRA integration
|
||||
as outlined in :ref:`creating-integrations`.
|
||||
|
|
|
|||
|
|
@ -5,21 +5,24 @@ Redmine integration
|
|||
|
||||
.. important::
|
||||
|
||||
In order to make issue numbers clickable in commit messages see the
|
||||
:ref:`rhodecode-issue-trackers-ref` section. The Redmine integration
|
||||
only deals with altering Redmine issues.
|
||||
Redmine integration is only available in |RCEE|.
|
||||
|
||||
|
||||
.. important::
|
||||
|
||||
Redmine integration is only available in |RCEE|.
|
||||
In order to make issue numbers clickable in commit messages, see the section
|
||||
:ref:`rhodecode-issue-trackers-ref`. Redmine integration is specifically for
|
||||
altering Redmine issues.
|
||||
|
||||
The Redmine integration allows you to reference and change issue statuses in
|
||||
Redmine directly from commit messages using commit message patterns such as
|
||||
``fixes #235`` in order to change the status of issue 235 to eg. ``Resolved``
|
||||
|
||||
To set a Redmine integration up it is first necessary to obtain a Redmine api
|
||||
key. This can be found in ``My Account`` in the Redmine application.
|
||||
If it is not there, you may have to enable API Access in Redmine settings.
|
||||
Redmine integration allows you to reference and change issue statuses in
|
||||
Redmine directly from commit messages, using commit message patterns such as
|
||||
``fixes #235`` in order to change the status of issue 235 to eg. "Resolved".
|
||||
|
||||
Once you have the api key, create a ``redmine`` integration in
|
||||
To set a Redmine integration up, it is first necessary to obtain a Redmine API
|
||||
key. This can be found under *My Account* in the Redmine application.
|
||||
You may have to enable API Access in Redmine settings if it is not already
|
||||
available.
|
||||
|
||||
Once you have the API key, create a Redmine integration as outlined in
|
||||
:ref:`creating-integrations`.
|
||||
|
|
|
|||
|
|
@ -3,11 +3,19 @@
|
|||
Slack integration
|
||||
=================
|
||||
|
||||
To set a Slack integration up it is first necessary to set up a Slack webhook api
|
||||
endpoint for your slack channel, this can be done at:
|
||||
To set a Slack integration up, it is first necessary to set up a Slack webhook
|
||||
API endpoint for your Slack channel. This can be done at:
|
||||
|
||||
https://my.slack.com/services/new/incoming-webhook/
|
||||
|
||||
Once you have set up a Slack webhook integrations url of the
|
||||
form: ``https://hooks.slack.com/services/...``, create a ``slack`` integration
|
||||
in :ref:`creating-integrations`.
|
||||
Select the channel you would like to use, and Slack will provide you with the
|
||||
webhook URL for configuration.
|
||||
|
||||
You can now create a Slack integration as outlined in
|
||||
:ref:`creating-integrations`.
|
||||
|
||||
.. note::
|
||||
Some settings in the RhodeCode admin are identical to the options within the
|
||||
Slack integration. For example, if notifications are to be sent in a private
|
||||
chat, leave the "Channel" field blank. Likewise, the Emoji option within
|
||||
RhodeCode can override the one set in the Slack admin.
|
||||
|
|
@ -7,4 +7,6 @@ The Webhook integration allows you to POST events such as repository pushes
|
|||
or pull requests to a custom http endpoint as a json dict with details of the
|
||||
event.
|
||||
|
||||
To create a webhook integration select ``webhook`` in :ref:`creating-integrations`.
|
||||
To create a webhook integration, select "webhook" in the integration settings
|
||||
and use the url and key from your custom webhook. See
|
||||
:ref:`creating-integrations` for additional instructions.
|
||||
|
|
@ -5,12 +5,12 @@ Issue Tracker Integration
|
|||
|
||||
You can set an issue tracker connection in two ways with |RCE|.
|
||||
|
||||
* At instance level you can set a default issue tracker.
|
||||
* At |repo| level you can configure an integration with a different issue
|
||||
* At the instance level, you can set a default issue tracker.
|
||||
* At the |repo| level, you can configure an integration with a different issue
|
||||
tracker.
|
||||
|
||||
To integrate |RCM| with an issue tracker you need to define a regular
|
||||
expression that will fetch the issue ID stored in commit messages and replace
|
||||
To integrate |RCM| with an issue tracker, you need to define a regular
|
||||
expression that will fetch the issue ID stored in commit messages, and replace
|
||||
it with a URL. This enables |RCE| to generate a link matching each issue to the
|
||||
target |repo|.
|
||||
|
||||
|
|
@ -33,9 +33,8 @@ To integrate your issue tracker, use the following steps:
|
|||
Repository Issue Tracker Configuration
|
||||
--------------------------------------
|
||||
|
||||
You can configure specific |repos| to use a different issue tracker if
|
||||
you need to connect to a non-default one. See the instructions in
|
||||
:ref:`repo-it`
|
||||
You can configure specific |repos| to use a different issue tracker than the
|
||||
default one. See the instructions in :ref:`repo-it`
|
||||
|
||||
.. _issue-tr-eg-ref:
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue