Skip to content

Commit c7dd09d

Browse files
committed
[doc] note how Slack notification is used to monitor automated tasks
1 parent 8cd9949 commit c7dd09d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,23 @@ We have a script that will automatically update the last_updated field for all o
7878

7979
`./scripts/date-updated.sh`
8080

81+
## Monitoring Automated Tasks
82+
83+
There are a few automated CI tasks in this repository to keep the website data up to date. In order for us to have visibility into when these jobs fail, we have automated a Slack bot to send a message to the `#pyos-infrastructure` channel on Slack using the [rtCamp/action-slack-notify](https://github.com/rtCamp/action-slack-notify) GitHub Action step. This action can be used within any repository in the PyOpenSci GitHub organization (as `SLACK_NOTIFICATIONS_BOT_TOKEN` is an org-wide secret) via:
84+
85+
```yml
86+
- name: Slack Notification
87+
uses: rtCamp/action-slack-notify@v2
88+
if: failure()
89+
env:
90+
SLACK_CHANNEL: pyos-infrastructure
91+
SLACK_COLOR: '#db540b'
92+
SLACK_LINK_NAMES: true
93+
SLACKIFY_MARKDOWN: true
94+
SLACK_MESSAGE: "Notification from GitHub Actions"
95+
SLACK_TOKEN: ${{ secrets.SLACK_NOTIFICATIONS_BOT_TOKEN }}
96+
```
97+
8198
## Contributors ✨
8299
83100
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

0 commit comments

Comments
 (0)