Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/baked-libs/maven-discord-integration
This GitHub Action can produce fancy and more meaningful discord messages for your commits. It includes Test results and coverage.
https://github.com/baked-libs/maven-discord-integration
action code coverage discord discord-webhook github jacoco junit maven quality test testing unit webhook workflow
Last synced: 3 days ago
JSON representation
This GitHub Action can produce fancy and more meaningful discord messages for your commits. It includes Test results and coverage.
- Host: GitHub
- URL: https://github.com/baked-libs/maven-discord-integration
- Owner: baked-libs
- License: gpl-3.0
- Created: 2020-05-13T11:55:49.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-07T22:20:10.000Z (7 months ago)
- Last Synced: 2024-04-24T15:23:47.705Z (7 months ago)
- Topics: action, code, coverage, discord, discord-webhook, github, jacoco, junit, maven, quality, test, testing, unit, webhook, workflow
- Language: JavaScript
- Homepage:
- Size: 1.32 MB
- Stars: 22
- Watchers: 1
- Forks: 16
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fancier Discord Webhook
This GitHub Action can produce fancy and more meaningful discord messages for your commits.
It includes Test results and coverage.
## :notebook: Requirements
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`
## :mailbox_with_no_mail: Inputs
### `id`
**Required** This is the id of your Discord webhook, if you copy the webhook url, this will be the first part of it.
### `token`
**Required** Now your Discord webhook token, it's the second part of the url.
## :framed_picture: Screenshots
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.
### :spider_web: Standard Webhook
### :star: New and improved Webhook
### :books: 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
#### :art: 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. |
## :scroll: Example setup
To set up this Action, create a new workflow file under `.github/workflows/workflow_name.yml`.
**Important:** Your project must have a `pom.xml` file, this Action only supports Maven at the moment.
To report Unit Tests and coverage, you will need `maven-surefire` / `maven-failsafe` and/or `jacoco`.
This workflow is rather simple, it checks out your repository, sets up Java and the webhook will then run `mvn test` and report the results to your discord webhook.
You should configure the webhook id in advance.
```yaml
name: Discord Webhook
on: [push]
jobs:
report-status:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/[email protected]
- name: Set up Java JDK 11
uses: actions/[email protected]
with:
distribution: 'adopt'
java-version: '11'
java-package: jdk
architecture: x64
- name: Run Discord Webhook
uses: baked-libs/discord-webhook@main
with:
id: ${{ secrets.YOUR_DISCORD_WEBHOOK_ID }}
token: ${{ secrets.YOUR_DISCORD_WEBHOOK_TOKEN }}
```