Skip to content
This repository has been archived by the owner on Feb 7, 2025. It is now read-only.

blastorg/releases-to-discord

 
 

Repository files navigation

GitHub Releases To Discord Action

A GitHub action that parses a GitHub release and posts it to a Discord channel as a stylized Discord webhook.


Output

output

Configuration

Variable Required Default Description
webhook_url Discord's webhook url. Use GH repo secrets.
color "2105893" Decimal color value for embed.
username "Release Changelog" String username for webhook.
avatar_url "Profile Picture" String url to webhook avatar picture.
release_tag_name Override tag name to pull from.
github_token GITHUB_TOKEN to use if overriding tag_name.

Example Usage

.github/workflows/releases-to-discord.yml

on:
    release:
        types: [published]

jobs:
    github-releases-to-discord:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v3
            - name: Github Releases To Discord
              uses: sillyangel/[email protected]
              with:
                  webhook_url: ${{ secrets.WEBHOOK_URL }}
                  color: '2105893'
                  username: 'Release Changelog'
                  avatar_url: 'https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png'

Setup Instructions

  1. Open your Server Settings and head into the Integrations tab:
  2. Click the "Create Webhook" button to create a new webhook!
  3. Copy the webhook url
  4. Create a new GitHub repository secret called WEBHOOK_URL and paste the webhook url into it.
  5. Save the secret.
  6. Add the secret to your action configuration.

And you're done! Whenever you create a new release, the workflow should run and, if properly setup, post to your specified Discord channel.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%