GitHub Action
Discord Commits
Notify Discord with all commits present in a payload. Customize layout by customizing templates.
Use markdown in your commit messages for nice formatting. As an example, here is a link to commit in picture. https://github.com/Sniddl/discord-commits/commit/1e5aedd3f8bae8bb8272289cea173f2258e519e8
- name: Discord Commits
uses: Sniddl/[email protected]
with:
webhook: ${{ secrets.DISCORD_WEBHOOK }}
template: 'avatar-with-link'
include-extras: true| Global Variable | Description |
|---|---|
| github | Access all data provided by GitHub such as payloads and commits. For example, the repository name. {{ github.context.payload.repository.name }} |
| env | Access all environment variables. For example, an environment variable called my_data. {{ env.my_data }} |
| commit | Access the data for the current commit. This will apply to ALL commits in the push event. If you do not want multiple commits see other options. Here's an example for commit data {{ commit.author.name }} |
| Option | Description |
|---|---|
| webhook | The url for a Discord webhook. Store this as a secret otherwise you may receive unwanted spam in your discord. |
| Option | Description |
|---|---|
| template | The name of a premade template located into the discord-commits/templates folder. |
| message | The text message that appears on Discord. This would be the equivalent of typing a message. |
| embed | The template for each embed item. An embed item is shown for every commit message in the push event. There may be multiple commits per push. This can be prevented by enabling last-commit-only |
| Option | Description |
|---|---|
| include-extras | Boolean - Include extra embeds from templates such as a link to the payload difference. |
| last-commit-only | Boolean - Only include the last commit. |
For information on the GitHub context API visit https://docs.github.com/en/actions/learn-github-actions/contexts For information on the Discord Webhook API visit https://discord.com/developers/docs/resources/webhook
Here are the defaults for each template. If you want to modify the values, you need to turn the JSON into a string so it can be passed from the action environment to the script. See main.yml for a commented out example.
Returns a message and no embeds
{
embed: false,
}
Returns embeds containing a title and description. Includes the author's name.
{
embed: {
title: "{{ commit.title }}",
description: "{{ commit.description }}",
author: {
name: "{{ commit.author.name }}"
}
}
}
Returns embeds containing a title and description. The title links to the commit url
{
embed: {
title: "{{ commit.title }}",
description: "{{ commit.description }}",
url: "{{ commit.url }}"
}
}
Returns embeds containing a title and description. The title links to the commit url. Includes the author's name
embed: {
title: "{{ commit.title }}",
description: "{{ commit.description }}",
url: "{{ commit.url }}",
author: {
name: "{{ commit.author.name }}"
}
}
Returns embeds containing a title and description. The title links to the commit url. Includes author's name and GitHub avatar.
embed: {
title: "{{ commit.title }}",
description: "{{ commit.description }}",
url: "{{ commit.url }}",
author: {
name: "{{ commit.author.name }}",
icon_url: "https://github.com/{{ commit.author.username }}.png"
}
}
We suggest everyone uses a tool like https://github.com/nektos/act to test GitHub actions locally. This is the tool I use so the directory structure will reflect that. If the following command does not pass, I will not accept your PR.
- install act see https://github.com/nektos/act for instructions.
cp .env.example .envpaste discord commit url into .env- make sure the following command passes.
act -W tests/workflows -e tests/push.json