Skip to content

Commit 81b5750

Browse files
authored
[doc] note how Slack notification is used to monitor automated tasks
2 parents e058759 + 12c9741 commit 81b5750

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,22 @@ We have a bash script that will automatically update the `last_updated` field in
7878

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

81-
Note: it would be nice to add this into our CI build but right now we do not have that setup. So we just need to run this script periodically to update the `last_updated` field when we update a blog post.
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+
```
8297
8398
## Contributors ✨
8499

0 commit comments

Comments
 (0)