Skip to content

Commit 613ba26

Browse files
committedOct 4, 2024
docs: updated README.md
1 parent 940a1bd commit 613ba26

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed
 

‎README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# GitHub Releases To Discord Action
2-
A GitHub action that parses a GitHub release and posts it to a Discord channel as a stylized Discord webhook.
2+
3+
A GitHub Action that sends a stylized Discord webhook containing the description of a GitHub Release to a specified Discord channel. It formats the description to improve readability and includes various configuration options to customize the message.
4+
5+
## Features
6+
7+
- Formats release descriptions by:
8+
- Removing carriage returns and HTML comments.
9+
- Styling headers for better readability in Discord (optional).
10+
- Cleaning up redundant whitespace and newlines.
11+
- Converting common GitHub links (e.g., PRs, Issues) into clickable URLs.
12+
- Limits description length to avoid exceeding Discord's character limits.
13+
- Provides customization for the Discord message, including:
14+
- Webhook URL, message color, footer text/icon, and timestamp.
15+
- Username and avatar for the webhook.
16+
- Optional message content outside the embed.
317

418
---
519
## Output
@@ -35,7 +49,7 @@ jobs:
3549
- name: Checkout
3650
uses: actions/checkout@v3
3751
- name: Github Releases To Discord
38-
uses: SethCohen/github-releases-to-discord@v1.13.1
52+
uses: SethCohen/github-releases-to-discord@v1.15.1
3953
with:
4054
webhook_url: ${{ secrets.WEBHOOK_URL }}
4155
color: "2105893"
@@ -45,6 +59,8 @@ jobs:
4559
footer_title: "Changelog"
4660
footer_icon_url: "https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png"
4761
footer_timestamp: true
62+
max_description: '4096'
63+
reduce_headings: true
4864
```
4965
5066
## Setup Instructions

0 commit comments

Comments
 (0)
Please sign in to comment.