Update docs on Mattermost and Slack notifications channels
This commit is contained in:
parent
f2ebb63a8e
commit
14976f3db8
4 changed files with 12 additions and 9 deletions
Binary file not shown.
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 244 KiB |
Binary file not shown.
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 224 KiB |
|
@ -24,23 +24,24 @@ There, you will see a checkbox with the following events that can be triggered:
|
||||||
|
|
||||||
- Push
|
- Push
|
||||||
- Issue
|
- Issue
|
||||||
|
- Confidential issue
|
||||||
- Merge request
|
- Merge request
|
||||||
- Note
|
- Note
|
||||||
- Tag push
|
- Tag push
|
||||||
- Build
|
- Build
|
||||||
|
- Pipeline
|
||||||
- Wiki page
|
- Wiki page
|
||||||
|
|
||||||
Bellow each of these event checkboxes, you will have an input field to insert
|
Below each of these event checkboxes, you have an input field to enter
|
||||||
which Mattermost channel you want to send that event message, with `#town-square`
|
which Mattermost channel you want to send that event message. Enter your preferred channel handle (the hash sign `#` is optional).
|
||||||
being the default. The hash sign is optional.
|
|
||||||
|
|
||||||
At the end, fill in your Mattermost details:
|
At the end, fill in your Mattermost details:
|
||||||
|
|
||||||
| Field | Description |
|
| Field | Description |
|
||||||
| ----- | ----------- |
|
| ----- | ----------- |
|
||||||
| **Webhook** | The incoming webhooks which you have to setup on Mattermost, it will be something like: http://mattermost.example/hooks/5xo... |
|
| **Webhook** | The incoming webhook URL which you have to setup on Mattermost, it will be something like: http://mattermost.example/hooks/5xo… |
|
||||||
| **Username** | Optional username which can be on messages sent to Mattermost. Fill this in if you want to change the username of the bot. |
|
| **Username** | Optional username which can be on messages sent to Mattermost. Fill this in if you want to change the username of the bot. |
|
||||||
| **Notify only broken builds** | If you choose to enable the **Build** event and you want to be only notified about failed builds. |
|
| **Notify only broken builds** | If you choose to enable the **Build** event and you want to be only notified about failed builds. |
|
||||||
|
| **Notify only broken pipelines** | If you choose to enable the **Pipeline** event and you want to be only notified about failed pipelines. |
|
||||||
|
|
||||||
![Mattermost configuration](img/mattermost_configuration.png)
|
![Mattermost configuration](img/mattermost_configuration.png)
|
||||||
|
|
|
@ -21,23 +21,25 @@ There, you will see a checkbox with the following events that can be triggered:
|
||||||
|
|
||||||
- Push
|
- Push
|
||||||
- Issue
|
- Issue
|
||||||
|
- Confidential issue
|
||||||
- Merge request
|
- Merge request
|
||||||
- Note
|
- Note
|
||||||
- Tag push
|
- Tag push
|
||||||
- Build
|
- Build
|
||||||
|
- Pipeline
|
||||||
- Wiki page
|
- Wiki page
|
||||||
|
|
||||||
Bellow each of these event checkboxes, you will have an input field to insert
|
Below each of these event checkboxes, you have an input field to enter
|
||||||
which Slack channel you want to send that event message, with `#general`
|
which Slack channel you want to send that event message. Enter your preferred channel name **without** the hash sign (`#`).
|
||||||
being the default. Enter your preferred channel **without** the hash sign (`#`).
|
|
||||||
|
|
||||||
At the end, fill in your Slack details:
|
At the end, fill in your Slack details:
|
||||||
|
|
||||||
| Field | Description |
|
| Field | Description |
|
||||||
| ----- | ----------- |
|
| ----- | ----------- |
|
||||||
| **Webhook** | The [incoming webhook URL][slackhook] which you have to setup on Slack. |
|
| **Webhook** | The [incoming webhook URL][slackhook] which you have to setup on Slack. |
|
||||||
| **Username** | Optional username which can be on messages sent to slack. Fill this in if you want to change the username of the bot. |
|
| **Username** | Optional username which can be on messages sent to Slack. Fill this in if you want to change the username of the bot. |
|
||||||
| **Notify only broken builds** | If you choose to enable the **Build** event and you want to be only notified about failed builds. |
|
| **Notify only broken builds** | If you choose to enable the **Build** event and you want to be only notified about failed builds. |
|
||||||
|
| **Notify only broken pipelines** | If you choose to enable the **Pipeline** event and you want to be only notified about failed pipelines. |
|
||||||
|
|
||||||
After you are all done, click **Save changes** for the changes to take effect.
|
After you are all done, click **Save changes** for the changes to take effect.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue