mirror of
https://github.com/deployphp/deployer.git
synced 2025-02-23 16:54:08 +01:00
168 lines
3.7 KiB
Markdown
168 lines
3.7 KiB
Markdown
<!-- DO NOT EDIT THIS FILE! -->
|
||
<!-- Instead edit contrib/mattermost.php -->
|
||
<!-- Then run bin/docgen -->
|
||
|
||
# mattermost
|
||
|
||
[Source](/contrib/mattermost.php)
|
||
|
||
|
||
## Installing
|
||
|
||
Create a Mattermost incoming webhook, through the administration panel.
|
||
|
||
Require the new recipe into your `deploy.php`
|
||
|
||
```php
|
||
require 'contrib/mattermost.php';
|
||
```
|
||
|
||
Add hook on deploy:
|
||
|
||
```
|
||
before('deploy', 'mattermost:notify');
|
||
```
|
||
|
||
## Configuration
|
||
|
||
- `mattermost_webhook` - incoming mattermost webook **required**
|
||
```
|
||
set('mattermost_webook', 'https://{your-mattermost-site}/hooks/xxx-generatedkey-xxx');
|
||
```
|
||
|
||
- `mattermost_channel` - overrides the channel the message posts in
|
||
```
|
||
set('mattermost_channel', 'town-square');
|
||
```
|
||
|
||
- `mattermost_username` - overrides the username the message posts as
|
||
```
|
||
set('mattermost_username', 'deployer');
|
||
```
|
||
|
||
- `mattermost_icon_url` - overrides the profile picture the message posts with
|
||
```
|
||
set('mattermost_icon_url', 'https://domain.com/your-icon.png');
|
||
```
|
||
|
||
- `mattermost_text` - notification message
|
||
```
|
||
set('mattermost_text', '_{{user}}_ deploying `{{branch}}` to **{{target}}**');
|
||
```
|
||
|
||
- `mattermost_success_text` – success template, default:
|
||
```
|
||
set('mattermost_success_text', 'Deploy to **{{target}}** successful {{mattermost_success_emoji}}');
|
||
```
|
||
|
||
- `mattermost_failure_text` – failure template, default:
|
||
```
|
||
set('mattermost_failure_text', 'Deploy to **{{target}}** failed {{mattermost_failure_emoji}}');
|
||
```
|
||
|
||
- `mattermost_success_emoji` – emoji added at the end of success text
|
||
- `mattermost_failure_emoji` – emoji added at the end of failure text
|
||
|
||
For detailed information about Mattermost hooks see: https://developers.mattermost.com/integrate/incoming-webhooks/
|
||
|
||
## Usage
|
||
|
||
If you want to notify only about beginning of deployment add this line only:
|
||
|
||
```php
|
||
before('deploy', 'mattermost:notify');
|
||
```
|
||
|
||
If you want to notify about successful end of deployment add this too:
|
||
|
||
```php
|
||
after('deploy:success', 'mattermost:notify:success');
|
||
```
|
||
|
||
If you want to notify about failed deployment add this too:
|
||
|
||
```php
|
||
after('deploy:failed', 'mattermost:notify:failure');
|
||
```
|
||
|
||
|
||
|
||
* Config
|
||
* [`mattermost_webhook`](#mattermost_webhook)
|
||
* [`mattermost_channel`](#mattermost_channel)
|
||
* [`mattermost_username`](#mattermost_username)
|
||
* [`mattermost_icon_url`](#mattermost_icon_url)
|
||
* [`mattermost_success_emoji`](#mattermost_success_emoji)
|
||
* [`mattermost_failure_emoji`](#mattermost_failure_emoji)
|
||
* [`mattermost_text`](#mattermost_text)
|
||
* [`mattermost_success_text`](#mattermost_success_text)
|
||
* [`mattermost_failure_text`](#mattermost_failure_text)
|
||
* Tasks
|
||
* [`mattermost:notify`](#mattermostnotify) — Notify mattermost
|
||
* [`mattermost:notify:success`](#mattermostnotifysuccess) — Notifying mattermost about deploy finish
|
||
* [`mattermost:notify:failure`](#mattermostnotifyfailure) — Notifying mattermost about deploy failure
|
||
|
||
## Config
|
||
### mattermost_webhook
|
||
[Source](/contrib/mattermost.php#L86)
|
||
|
||
|
||
|
||
### mattermost_channel
|
||
[Source](/contrib/mattermost.php#L87)
|
||
|
||
|
||
|
||
### mattermost_username
|
||
[Source](/contrib/mattermost.php#L88)
|
||
|
||
|
||
|
||
### mattermost_icon_url
|
||
[Source](/contrib/mattermost.php#L89)
|
||
|
||
|
||
|
||
### mattermost_success_emoji
|
||
[Source](/contrib/mattermost.php#L91)
|
||
|
||
|
||
|
||
### mattermost_failure_emoji
|
||
[Source](/contrib/mattermost.php#L92)
|
||
|
||
|
||
|
||
### mattermost_text
|
||
[Source](/contrib/mattermost.php#L94)
|
||
|
||
|
||
|
||
### mattermost_success_text
|
||
[Source](/contrib/mattermost.php#L95)
|
||
|
||
|
||
|
||
### mattermost_failure_text
|
||
[Source](/contrib/mattermost.php#L96)
|
||
|
||
|
||
|
||
|
||
## Tasks
|
||
### mattermost:notify
|
||
[Source](/contrib/mattermost.php#L99)
|
||
|
||
|
||
|
||
### mattermost:notify:success
|
||
[Source](/contrib/mattermost.php#L120)
|
||
|
||
|
||
|
||
### mattermost:notify:failure
|
||
[Source](/contrib/mattermost.php#L141)
|
||
|
||
|
||
|