Skip to content

Commit

Permalink
Added screenshots and more description to README
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBusyBiscuit authored May 14, 2020
1 parent 53e7081 commit 1da8725
Showing 1 changed file with 32 additions and 5 deletions.
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# discord-webhook
# Fancier Discord Webhook
This GitHub Action can produce fancy and more meaningful discord messages for your commits.
<br>It includes Test results and coverage.

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

## Inputs

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

## Screenshots
TODO
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>

### Standard Webhook
![old webhook](https://raw.githubusercontent.com/Slimefun/discord-webhook/master/assets/old-webhook.png)

### New and improved Webhook
![new webhook](https://raw.githubusercontent.com/Slimefun/discord-webhook/master/assets/new-webhook.png)

### Changes
* Removed the obnoxious author name and image at the top (may be a toggle in the future)
* The branch is now clearly visible "Slimefun4:master" -> "Slimefun4 (master)"
* The repository is now referred to by its full name, including the repository owner
* 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)
* 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)"
* Includes test results, passes will be prepended with a green circle, skips with yellow and failures with red.
* It will also list the exact tests which failed (max of 4, then it will crop them)
* An estimated test coverage is provided if you use the `jacoco` maven plugin.
* Dynamic embed color changes

## Example workflow
TODO
#### Dynamic Coloring
The color of the embed changes depending on the compiler and test results. Here's a breakdown:

| Color | Description |
| ----- | ----------- |
| red | The build has failed. |
| orange | The build was successful but some tests failed. |
| yellow | The build was successful, no tests failed but some were skipped. |
| green | The build was successful, no tests failed and none were skipped. |

## Example setup
TODO

0 comments on commit 1da8725

Please sign in to comment.