🚀 Discord for GitHub Actions

Sends a Discord notification message. Simple as that. Supports all workflow event types by using the Discord GitHub webhooks.

Appearance on Discord :

Discord message

This GitHub action is part of a list of Actions that are located in an other repo. Feel free to check it out : https://github.com/Ilshidur/actions.

Compatibility note

As this Action is containerized with Docker, it can only run on Linux environments.

Docker container actions can only execute in the GitHub-hosted Linux environment. Self-hosted runners must use a Linux operating system and have Docker installed to run Docker container actions. For more information about the requirements of self-hosted runners, see "About self-hosted runners."

Usage

- name: Discord notification
  env:
    DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
  uses: Ilshidur/action-discord@master
  with:
    args: 'The project {{ EVENT_PAYLOAD.repository.full_name }} has been deployed.'

NOTICE : for stability purposes, it is recommended to use the action with an explicit commit SHA-1 :

Version : uses: "Ilshidur/action-discord@0.3.2" (→ link to the releases list : https://github.com/Ilshidur/action-discord/releases)
Commit SHA-1 : uses: "Ilshidur/action-discord@0c4b27844ba47cb1c7bee539c8eead5284ce9fa9" (→ link to the commits list : https://github.com/Ilshidur/action-discord/commits/master)

Arguments

By default, the GitHub action will send a notificaction with the event informations. Providing the arguments will override the message.

Environment variables can be interpolated in the message using brackets ({{ and }}) :

e.g.: Action called : {{ GITHUB_ACTION }}

Event Payload data can also be interpolated in the message using brackets ({{ and }}) with the EVENT_PAYLOAD variable.

e.g.: Action called: {{ GITHUB_ACTION }} as {{ EVENT_PAYLOAD.pull_request.id }}

See the event types for valid payload informations.

Examples

args = "Hello, beautiful ! I ran a GitHub Actions for you <3"
args = "I showed you my commit. Please respond."

Environment variables

DISCORD_WEBHOOK (required): the Discord webhook URL (see https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks).
- IMPORTANT !! You MUST NOT append /github at the end of the webhook.
DISCORD_USERNAME (optional): overrides the bot nickname.
DISCORD_AVATAR (optional): overrides the avatar URL.
DISCORD_EMBEDS (optional): This should be a valid JSON string of an array of Discord embed objects. See the documentation on Discord WebHook Embeds for more information. You can use set it to ${{ toJson(my_value) }} using toJson() if your input is an object value.
That's all.

Alternatives

Because open source is about everyone :

https://github.com/marketplace/actions/discord-message-notify

TODO

Pass arguments with the with keyword
Run outside of a container.

Don't forget to 🌟 Star 🌟 the repo if you like this GitHub Action !
Your feedback is appreciated

Ilshidur / action-discord

readme