Actions Status Discord

Discord Notification Made Easy.

• 🍣 Zero-configure! Works perfectly out of the box.
• 🍣 Universal! Supports Linux (Ubuntu), macOS and Windows.
• 🍣 Faster startup! Faster than ones written in Docker container action.

• Usage
• Configuration
  • Environment Variables
  • Inputs
• Tips
• FAQ
• Questions? Bugs?

⚠️ If you're reading this document in Marketplace page, please refer to the latest document here.

Usage

Minimum

- uses: sarisia/[email protected]
  if: always()
  with:
    webhook: ${{ secrets.DISCORD_WEBHOOK }}

Full options

- uses: sarisia/[email protected]
  if: always()
  with:
    webhook: ${{ secrets.DISCORD_WEBHOOK }}
    title: "deploy"
    description: "Build and deploy to GitHub Pages"
    image: ${{ secrets.EMBED_IMAGE }}
    color: 0x0000ff
    username: GitHub Actions
    avatar_url: ${{ secrets.AVATAR_URL }}

No detail

- uses: sarisia/[email protected]
  if: always()
  env:
    DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
  with:
    nodetail: true
    title: "We did it!"
    color: 0xff91a4

For if parameter, see GitHub Actions Reference

Configuration

Environment Variables

Inputs

Tips

Using markdown

Some fields support markdown syntax.

- uses: sarisia/[email protected]
  with:
    webhook: ${{ secrets.DISCORD_WEBHOOK }}
    nodetail: true
    title: New version of `software` is ready!
    description: |
      Version `1.2.3-alpha`
      Click [here](https://github.com/sarisia/actions-status-discord) to download!

Trigger multiple webhooks

You can set multiple webhooks separated with EOL (line break, \n) to Secrets.

For example, set Secrets to:

https://discordapp.com/api/webhooks/...
https://media.guilded.gg/weabhooks/...
https://this-is-invalid-webhook-endpoint.invalid/...

will trigger these 3 webhooks simultaneously.

If some of these webhooks are failed, other deliveries will NOT be cancelled.

If the option nofail is set to false and any of one fail, the action will set workflow status to Failure.

Guilded webhook support

As Guilded supports Discord Webhooks API, you can use Guilded webhook endpoint in the same way as Discord webhook.

Guilded Embed Image

FAQ

Error: Webhook response: 400: {"sender":["This field is required"]}

Do not append /github suffix to your webhook URL. See Inputs section.

Questions? Bugs?

Feel free to ask in Discussions, or report bugs in Issues!