Skip to content

Commit 1d5a8d9

Browse files
authored
test: check flag/docs consistency (#1770)
1 parent 7648e9c commit 1d5a8d9

File tree

4 files changed

+171
-64
lines changed

4 files changed

+171
-64
lines changed

docs/arguments.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ Environment Variable: WATCHTOWER_INCLUDE_RESTARTING
178178
Will also include created and exited containers.
179179

180180
```text
181-
Argument: --include-stopped
181+
Argument: --include-stopped, -S
182182
Environment Variable: WATCHTOWER_INCLUDE_STOPPED
183183
Type: Boolean
184184
Default: false
@@ -278,7 +278,7 @@ Environment Variable: WATCHTOWER_NO_STARTUP_MESSAGE
278278
Run an update attempt against a container name list one time immediately and exit.
279279

280280
```text
281-
Argument: --run-once
281+
Argument: --run-once, -R
282282
Environment Variable: WATCHTOWER_RUN_ONCE
283283
Type: Boolean
284284
Default: false
@@ -392,3 +392,20 @@ Environment Variable: WATCHTOWER_WARN_ON_HEAD_FAILURE
392392
Possible values: always, auto, never
393393
Default: auto
394394
```
395+
## Programatic Output (porcelain)
396+
397+
Writes the session results to STDOUT using a stable, machine-readable format (indicated by the argument VERSION).
398+
399+
Alias for:
400+
401+
```text
402+
--notification-url logger://
403+
--notification-log-stdout
404+
--notification-report
405+
--notification-template porcelain.VERSION.summary-no-log
406+
407+
Argument: --porcelain, -P
408+
Environment Variable: WATCHTOWER_PORCELAIN
409+
Possible values: v1
410+
Default: -
411+
```

docs/notifications.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@ system, [logrus](http://github.com/sirupsen/logrus).
2020
- `--notifications-hostname` (env. `WATCHTOWER_NOTIFICATIONS_HOSTNAME`): Custom hostname specified in subject/title. Useful to override the operating system hostname.
2121
- `--notifications-delay` (env. `WATCHTOWER_NOTIFICATIONS_DELAY`): Delay before sending notifications expressed in seconds.
2222
- Watchtower will post a notification every time it is started. This behavior [can be changed](https://containrrr.github.io/watchtower/arguments/#without_sending_a_startup_message) with an argument.
23-
- `notification-title-tag` (env. `WATCHTOWER_NOTIFICATION_TITLE_TAG`): Prefix to include in the title. Useful when running multiple watchtowers.
24-
- `notification-skip-title` (env. `WATCHTOWER_NOTIFICATION_SKIP_TITLE`): Do not pass the title param to notifications. This will not pass a dynamic title override to notification services. If no title is configured for the service, it will remove the title all together.
23+
- `--notification-title-tag` (env. `WATCHTOWER_NOTIFICATION_TITLE_TAG`): Prefix to include in the title. Useful when running multiple watchtowers.
24+
- `--notification-skip-title` (env. `WATCHTOWER_NOTIFICATION_SKIP_TITLE`): Do not pass the title param to notifications. This will not pass a dynamic title override to notification services. If no title is configured for the service, it will remove the title all together.
25+
- `--notification-log-stdout` (env. `WATCHTOWER_NOTIFICATION_LOG_STDOUT`): Enable output from `logger://` shoutrrr service to stdout.
2526

2627
## [shoutrrr](https://github.com/containrrr/shoutrrr) notifications
2728

0 commit comments

Comments
 (0)