spacebar/kamal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Allow customizing audit broadcast with env

Browse Source 
When invoking the audit broadcast command, provide a few environment
variables so that people can customize the format of the message if they
want.

We currently provide `MRSK_PERFORMER`, `MRSK_ROLE`, `MRSK_DESTINATION` and
`MRSK_EVENT`.

Also adds the destination to the default message, which we continue to
send as the first argument as before.
This commit is contained in:
Kevin McConnell
2023-04-13 11:47:29 +01:00
parent bc8875e020
commit 828e56912e
4 changed files with 51 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -677,6 +677,15 @@ That'll post a line like follows to a preconfigured chatbot in Basecamp:
[My App] [dhh] Rolled back to version d264c4e92470ad1bd18590f04466787262f605de
```
In addition to the formatted message, MRSK sets a number of environment variables with the components of the broadcast.
You can use these (rather than the command argument) if you want more control over how the message is formatted.
MRSK currently sets:
- `MRSK_PERFORMER` - the user performing the command
- `MRSK_DESTINATION` - the destination
- `MRSK_ROLE` - the specific role being targetted, if any
- `MRSK_EVENT` - text of the action (e.g. "Deployed app@150b24f")
### Custom healthcheck
MRSK defaults to checking the health of your application again `/up` on port 3000 up to 7 times. You can tailor the behaviour with the `healthcheck` setting: