Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pilosus/dienstplan
Slack bot app for duty rotations
https://github.com/pilosus/dienstplan
bot rotation slack slack-api slack-bot slackbot
Last synced: about 2 months ago
JSON representation
Slack bot app for duty rotations
- Host: GitHub
- URL: https://github.com/pilosus/dienstplan
- Owner: pilosus
- License: other
- Created: 2021-10-22T18:50:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T19:16:47.000Z (3 months ago)
- Last Synced: 2024-11-01T06:51:29.382Z (about 2 months ago)
- Topics: bot, rotation, slack, slack-api, slack-bot, slackbot
- Language: Clojure
- Homepage: https://dienstplan-slack.pilosus.org
- Size: 836 KB
- Stars: 21
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# dienstplan: slack duty rotations made easy
[](https://codecov.io/gh/pilosus/dienstplan)
[](https://hub.docker.com/r/pilosus/dienstplan/tags)
Slack bot for duty rotations.
## Why
- Dead simple: a few commands to manage on-call duty rotations in your team's Slack channels
- Follows the rule "Do One Thing and Do It Well"
- Plays nicely with Slack [reminders](https://slack.com/resources/using-slack/how-to-use-reminders-in-slack) and [workflows](https://slack.com/features/workflow-automation)
- Supports [crontab](https://man7.org/linux/man-pages/man5/crontab.5.html) for scheduling
## Quick example
[](https://youtu.be/pZWJYpsT1_w)
Let's create a rotation using `dienstplan`. Just pass in a `create`
command followed by a rotation name, a list of the channel users in a
rotation, and a rotation description:
```
@dienstplan create my-rota @user1 @user2 @user3
On-call engineer's duties:
- Process support team questions queue
- Resolve service alerts
- Check service health metrics
- Casual code refactoring-
Follow the boy scout rule: always leave the campground cleaner than you found it
```
Once the rota is set up, the first user in the list becomes a current
on-call person. Check it with a `who` command:
```
@dienstplan who my-rota
```
To change the current on-call person to the next one use `rotate`
command:
```
@dienstplan rotate my-rota
```
The bot iterates over the users in the list order:
```
@user1 -> @user2 -> @user3 -> @user1 -> @user2 ...
```
Now that you know the basics, let's automate rotation and current duty
notifications with Slack's built-in `/remind` command. First, set up a
reminder to rotate users weekly:
```
/remind #my-channel to "@dienstplan rotate my-rota" every Monday at 9AM UTC
```
Second, remind duties to a current on-call person:
```
/remind #my-channel to "@dienstplan who my-rota" every Monday, Tuesday, Wednesday, Thursday, Friday at 10AM UTC
```
If you prefer [crontab](https://en.wikipedia.org/wiki/Cron) format for
schedule description, use `schedule` command instead of `/remind`:
```
@dienstplan schedule create "rotate my-rota" 0 9 * * Mon
@dienstplan schedule create "who my-rota" 0 10 * * Mon-Fri
```
## Help
See [documentation](https://dienstplan-slack.pilosus.org/) for more details on
installation and usage.
## Contributing
See
[Contributing](https://github.com/pilosus/dienstplan/tree/main/CONTRIBUTING.md)
guide.
## License
See [LICENSE](https://github.com/pilosus/dienstplan/tree/main/LICENSE)