actions/github-releases-to-discord
1
0
Fork 0
mirror of https://github.com/SethCohen/github-releases-to-discord synced 2026-09-14 20:13:23 +00:00
Code Packages Releases Activity

chore: updated README.md

Browse Source
This commit is contained in:
SethCohen
2022-08-24 01:46:50 -04:00
parent a5abfa09d3
commit 6df64644c1
1 changed files with 20 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -5
View File
@@ -1,7 +1,23 @@
# GitHub Release To Discord Action # 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!
![](https://support.discord.com/hc/article_attachments/1500000463501/Screen_Shot_2020-12-15_at_4.41.53_PM.png)
![](https://support.discord.com/hc/article_attachments/360101553853/Screen_Shot_2020-12-15_at_4.51.38_PM.png)
3. Copy the webhook url
4. Create a new Github repository secret called WEBHOOK_URL and paste the webhook url into it.
![](https://i.imgur.com/hAaNOds.png)
5. Save the secret.
6. Add the secret to your action configuration.
And you're done!
This action parses a GitHub release and posts it to a Discord channel via a Discord webhook.
## Configuration ## Configuration
| Variable | Required | Default | Description | | Variable | Required | Default | Description |
|------------|----------|----------------------------------------------------------------------------------------------------------------|--------------------------------------------| |------------|----------|----------------------------------------------------------------------------------------------------------------|--------------------------------------------|
| webhook_url | ✔ | | Discord's webhook url. Use GH repo secrets. | | webhook_url | ✔ | | Discord's webhook url. Use GH repo secrets. |
@@ -13,7 +29,7 @@ This action parses a GitHub release and posts it to a Discord channel via a Disc
## Output ## Output
![output](https://i.imgur.com/Zf3TXtb.png) ![output](https://i.imgur.com/Zf3TXtb.png)
## Example usage ## Example Usage
```yaml ```yaml
on: on:
@@ -26,9 +42,8 @@ jobs:
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: Handle Release - name: Github Releases To Discord
uses: ./ # Uses an action in the root directory uses: SethCohen/github-release-to-discord@v1.12.0
id: release
with: with:
webhook_url: ${{ secrets.WEBHOOK_URL }} webhook_url: ${{ secrets.WEBHOOK_URL }}
color: "2105893" color: "2105893"