Skip to content

Commit 0ffbaab

Browse files
[automatic] Update docs with bin/docgen
1 parent 3d995d9 commit 0ffbaab

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

docs/contrib/ms-teams.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,6 @@ after('deploy:failed', 'teams:notify:failure');
4141
set('teams_webhook', 'https://outlook.office.com/webhook/...');
4242
```
4343
- `teams_title` – the title of application, default `{{application}}`
44-
- `teams_failure_continue` - allow deploys to continue on failure
45-
```
46-
set('teams_failure_continue', true);
47-
```
4844
- `teams_text` – notification message template, markdown supported
4945
```
5046
set('teams_text', '_{{user}}_ deploying `{{what}}` to *{{where}}*');
@@ -60,7 +56,6 @@ after('deploy:failed', 'teams:notify:failure');
6056
- `teams_color` – color's attachment
6157
- `teams_success_color` – success color's attachment
6258
- `teams_failure_color` – failure color's attachment
63-
6459
## Usage
6560
If you want to notify only about beginning of deployment add this line only:
6661
```php
@@ -86,18 +81,19 @@ Title of project
8681
return get('application', 'Project');
8782
```
8883

84+
8985
### teams_failure_continue
90-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L79)
86+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L84)
9187

9288
Allow Continue on Failure
9389

94-
```php title="Continue on Failure"
95-
return get('teams_failure_continue', false)
90+
```php title="Default value"
91+
false
9692
```
9793

9894

9995
### teams_text
100-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L84)
96+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L87)
10197

10298
Deploy message
10399

@@ -107,7 +103,7 @@ Deploy message
107103

108104

109105
### teams_success_text
110-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L85)
106+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L88)
111107

112108

113109

@@ -117,7 +113,7 @@ Deploy message
117113

118114

119115
### teams_failure_text
120-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L86)
116+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L89)
121117

122118

123119

@@ -127,7 +123,7 @@ Deploy message
127123

128124

129125
### teams_color
130-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L89)
126+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L92)
131127

132128
Color of attachment
133129

@@ -137,7 +133,7 @@ Color of attachment
137133

138134

139135
### teams_success_color
140-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L90)
136+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L93)
141137

142138

143139

@@ -147,7 +143,7 @@ Color of attachment
147143

148144

149145
### teams_failure_color
150-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L91)
146+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L94)
151147

152148

153149

@@ -160,23 +156,23 @@ Color of attachment
160156
## Tasks
161157

162158
### teams\:notify {#teams-notify}
163-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L94)
159+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L97)
164160

165161
Notifies Teams.
166162

167163

168164

169165

170166
### teams\:notify\:success {#teams-notify-success}
171-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L109)
167+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L121)
172168

173169
Notifies Teams about deploy finish.
174170

175171

176172

177173

178174
### teams\:notify\:failure {#teams-notify-failure}
179-
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L124)
175+
[Source](https://github.com/deployphp/deployer/blob/master/contrib/ms-teams.php#L144)
180176

181177
Notifies Teams about deploy failure.
182178

0 commit comments

Comments
 (0)