Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
bell

GitHub Action

Discord Commits

v1.3

Discord Commits

bell

Discord Commits

Send commit summary to Discord using custom templates

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Discord Commits

uses: Sniddl/discord-commits@v1.3

Learn more about this action in Sniddl/discord-commits

Choose a version

Discord Action Commits

GitHub Action for Discord that prints multiple commit messages based on a single template.

Example Appearence:

Put Discord chat syntax (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

Imgur


Example Usage

- name: Discord Commits
        uses: Sniddl/discord-commits@v1.3
        with:
          webhook: ${{ secrets.DISCORD_WEBHOOK }}
          message: "Successful commit to **{{ github.context.payload.repository.owner.name }}/{{ github.context.payload.repository.name}}**.\nDiff: {{ github.context.payload.compare }}"
          embed: '{ "title": "{{ commit.title }}", "description": "{{ commit.description }}", "url": "{{ commit.url }}", "author": { "name": "{{ commit.author.name }} ({{ commit.author.username }})", "icon_url": "https://avatars.io/gravatar/{{ commit.author.email }}"} }'
          last-commit-only: false

Variables

All variables available through GitHub such as payloads and commits can be accessed via {{ github }}. As an example, the repository name can be accessed by {{ github.context.payload.repository.name }}

Environment variables can be accessed by {{ env }}. Example, {{ env.mycustomdata.somepath }}

Commits are automatically looped over at displayed as embed objects. The data for each commit is scoped under {{ commit }} in the embed input template. Example, commmit author name is {{ commit.author.name }}