Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
bell

GitHub Action

Better Discord Notification

v1.1.0

Better Discord Notification

bell

Better Discord Notification

A GitHub action for sending a better Discord notification embed, which can also be customized

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Better Discord Notification

              
  uses: Retr0-01/[email protected]
Learn more about this action in Retr0-01/better-discord-notification

Choose a version

Better Discord Notification

GitHub release (latest by date) GitHub Workflow Status GitHub
A GitHub action for sending an enhanced, fully customizable, Discord notification embed.

Usage

All options must be quoted. If your webhook-url is provided by using secrets, do not quote it.

Input Type Required Description Default
webhook-url string yes The Discord webhook URL this notification will be send to. -
embed-color int no The embed's color, in decimal form. 0
footer-icon string no A small icon to put on the footer. Image
ignore-hidden bool no Branches that contain the phase hidden/ in them will be ignored. true

Example Workflow

name: Discord Notification

on:
  push:
    branches: [ main ] # Replace main with your branch name.

jobs:
  Notify:
    runs-on: ubuntu-latest
    name: Send Notification
    steps:
      - name: Send Notification
        uses: Retr0-01/better-discord-notification@main
        with:
          webhook-url: ${{ secrets.CI_DISCORD_WEBHOOK }} # It is recommended to store your webhooks using actions secrets
          embed-color: '3093151'
          footer-icon: 'https://cdn.discordapp.com/attachments/712252851283296260/961953852897255454/706526933973860412.png'
          ignore-hidden: 'false'

Results

image