github-releases-to-discord/README.md

GitHub Release To Discord Action

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

---

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!

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.

Output

Example Usage

on:
  release:
    types: [published]

jobs:
  github-release-to-discord:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Github Releases To Discord
        uses: SethCohen/github-release-to-discord@v1.12.0
        with:
          webhook_url: ${{ secrets.WEBHOOK_URL }}
          color: "2105893"
          username: "Release Changelog"
          avatar_url: "https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png"