https://github.com/dolthub/ga-discord-notify

https://github.com/dolthub/ga-discord-notify

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dolthub/ga-discord-notify
• Owner: dolthub
• Created: 2020-12-21T06:03:06.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-02T20:37:06.000Z (about 4 years ago)
• Last Synced: 2024-11-08T08:32:44.826Z (about 2 months ago)
• Language: JavaScript
• Size: 953 KB
• Stars: 0
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Background

This is an action for sending notifications to the DoltHub team about events on our various code repositories.

## Details

In order to make a job notify Discord of it's status, along with useful metadata, simply append the following YAML to the job definition:

```yaml

- name: Discord Notify

  if: always()

  uses: dolthub/ga-discord-notify@master

  with:

    job-status: ${{ job.status }}

    webhook-url: ${{ secrets.DISCORD_WEBHOOK }}

    notify-on-success: false

```

This ensures that this step _always_ runs, passes the status to the action for parsing, and provides a webhook URL for sending the message to be rendered in Discord.

`notify-on-success` is used for release notifications. Our general policy is that we notify on failed and cancelled jobs, and all releases.

## Channels

Note that here we use `secrets.DISCORD_WEBHOOK`. This webhook will send notifications to a specific channel. Users can easily add webhooks for other channels to the secrets of their repository to get specific information sent to a channel.