Skip to content

Discord Webhook Notify v1.0.2

Compare
Choose a tag to compare
@rjstone rjstone released this 29 Dec 04:09
· 24 commits to v1 since this release

This sends a notification to discord using a webhook URL. It is written in JavaScript so it will work with windows, osx, and linux execution environments.

To use this, get on Discord and create a new webhook. Then get on GitHub, go into your project settings, and add a new Secret called DISCORD_WEBHOOK. In your workflow YAML, set webhookUrl as follows: webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}. You must set webhookUrl this way for each invocation of the action.

  • Use rjstone/discord-webhook-notify@v1 if you want bugfixes but nothing backward-compatability breaking. (If anything breaks compatability it will be in v2+.)
  • Use rjstone/[email protected] (or another specific tag after the @) if you want to guarantee use of a specific revision.

Simple case example:

- name: Test Success
    uses: rjstone/discord-webhook-notify@v1
    if: success()
    with:
        severity: info
        details: Test Succeeded!
        webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}
- name: Test Failure
    uses: rjstone/discord-webhook-notify@v1
    if: failure()
    with:
        severity: error
        details: Test Failed!
        webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}
- name: Test Cancelled
    uses: rjstone/discord-webhook-notify@v1
    if: cancelled()
    with:
        severity: warn
        details: Test Cancelled!
        webhookUrl: ${{ secrets.DISCORD_WEBHOOK }}

Changes:

  • v1.0.2 adds the commit message to the default notification