Skip to content

Commit 1da8725

Browse files
Added screenshots and more description to README
1 parent 53e7081 commit 1da8725

File tree

1 file changed

+32
-5
lines changed

1 file changed

+32
-5
lines changed

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# discord-webhook
1+
# Fancier Discord Webhook
22
This GitHub Action can produce fancy and more meaningful discord messages for your commits.
33
<br>It includes Test results and coverage.
44

@@ -7,7 +7,7 @@ This currently works only for Maven projects.
77
For Test Results and Coverage Reports you will need to use one of the following Maven plugins:
88
* `maven-surefire`
99
* `maven-failsafe`
10-
* 'jacoco'
10+
* `jacoco`
1111

1212
## Inputs
1313

@@ -18,7 +18,34 @@ For Test Results and Coverage Reports you will need to use one of the following
1818
**Required** Now your Discord webhook token, it's the second part of the url.
1919

2020
## Screenshots
21-
TODO
21+
The standard webhook from GitHub to Discord just dumps the commit messages right into your chat, this is fine but sometimes you just want some extra information. Did the commit introduce any new issues? Did it even compile successfully? That's what this Action is for.<br>
22+
23+
### Standard Webhook
24+
![old webhook](https://raw.githubusercontent.com/Slimefun/discord-webhook/master/assets/old-webhook.png)
25+
26+
### New and improved Webhook
27+
![new webhook](https://raw.githubusercontent.com/Slimefun/discord-webhook/master/assets/new-webhook.png)
28+
29+
### Changes
30+
* Removed the obnoxious author name and image at the top (may be a toggle in the future)
31+
* The branch is now clearly visible "Slimefun4:master" -> "Slimefun4 (master)"
32+
* The repository is now referred to by its full name, including the repository owner
33+
* The embed now includes a timestamp (it is actually the timestamp of the commit, not just the current date of when the webhook was sent)
34+
* Commit messages have slightly shorter limits and the committer is now better distinguishable from the commit message "Reduced technical debt - TheBusyBiscuit" -> "Reduced technical debt (@TheBusyBiscuit)"
35+
* Includes test results, passes will be prepended with a green circle, skips with yellow and failures with red.
36+
* It will also list the exact tests which failed (max of 4, then it will crop them)
37+
* An estimated test coverage is provided if you use the `jacoco` maven plugin.
38+
* Dynamic embed color changes
2239

23-
## Example workflow
24-
TODO
40+
#### Dynamic Coloring
41+
The color of the embed changes depending on the compiler and test results. Here's a breakdown:
42+
43+
| Color | Description |
44+
| ----- | ----------- |
45+
| red | The build has failed. |
46+
| orange | The build was successful but some tests failed. |
47+
| yellow | The build was successful, no tests failed but some were skipped. |
48+
| green | The build was successful, no tests failed and none were skipped. |
49+
50+
## Example setup
51+
TODO

0 commit comments

Comments
 (0)