You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Actions Status Discord
v1.7.0
A Github Actions action to notify CI status to Discord.
- uses: sarisia/actions-status-discord@v1
if: always()
with:
webhook: ${{ secrets.DISCORD_WEBHOOK }}
- uses: sarisia/actions-status-discord@v1
if: always()
with:
webhook: ${{ secrets.DISCORD_WEBHOOK }}
status: ${{ job.status }}
title: "deploy"
description: "Build and deploy to GitHub Pages"
nofail: false
nocontext: false
noprefix: false
color: 0x0000ff
username: GitHub Actions
avatar_url: ${{ secrets.AVATAR_URL }}
- uses: sarisia/actions-status-discord@v1
if: always()
env:
DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
with:
nodetail: true
title: "We did it!"
color: 0xff91a4
For if parameter, see
GitHub Actions Reference
| Key | Value | Description |
|---|---|---|
| DISCORD_WEBHOOK | Discord webhook endpoind like:https://discordapp.com/api/webhooks/... |
You can provide webhook via inputs either. DO NOT APPEND /github SUFFIX! |
| Key | Required | Value | Default | Description |
|---|---|---|---|---|
| webhook | No | String | env.DISCORD_WEBHOOK |
Discord webhook endpoind like:https://discordapp.com/api/webhooks/...This overrides env.DISCORD_WEBHOOK.DO NOT APPEND /github SUFFIX! |
| status | No | Success, Failure or Cancelled |
${{ job.status }} |
See Document for job context |
| title | No | String | ${{ github.workflow}} |
String included in embed title. Overrides job input. |
| description | No | String | Description included in message | |
| color | No | Hex string like: 0xFFFFFF |
Overrides Discord embed color | |
| username | No | String | Overrides Discord webhook username | |
| avatar_url | No | String | Overrides Discord webhook avatar url | |
| nofail | No | true or false |
true |
This action won't make workflow failed by default. If set to false, this action will set status failed when failed to notify. |
| nocontext | No | true or false |
false |
Set true to suppress GitHub context fields (Repository, Ref, etc). |
| noprefix | No | true or false |
false |
Set true to avoid appending job status (Success: , etc.) to title |
| nodetail | No | true or false |
false |
Set true will set both nocontext and noprefix to true |
| Key | Required | Value | Default | Description |
|---|---|---|---|---|
| job | No | String | Deprecated. Will be removed in v2 Job name included in message title. Same as title input. |
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.
As Guilded supports Discord Webhooks API, you can use Guilded webhook endpoint in the same way as Discord webhook.
Guilded Embed Image
