Skip to content
bell

GitHub Action

Matterfy

v1.9 Latest version

Matterfy

bell

Matterfy

Mattermost Notification for Github Actions

Installation

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

              

- name: Matterfy

uses: tferreira/matterfy@v1.9

Learn more about this action in tferreira/matterfy

Choose a version

Matterfy

GitHub release (latest by date) GitHub

This is Mattermost Notification for GitHub Actions.
Forked from homoluctus/slatify. Thanks a lot for your awesome work!

Feature

  • Notify the result of GitHub Actions

How to use

First of all, you need to set GitHub secrets for SLACK_WEBHOOK that is Incoming Webhook URL.
You can customize the following parameters:

with parameter required/optional description
type required The result of GitHub Actions job
This parameter value must contain success, fail or cancel
We recommend using ${{ job.status }}
job_name required Means slack notification title
channel required Mattermost channel name
icon_emoji optional Mattermost icon
default: octocat
username optional Mattermost username
default: Github Actions
url optional Mattermost Incoming Webhooks URL
Please specify this key or SLACK_WEBHOOK environment variable
※SLACK_WEBHOOK will be deprecated

Please refer action.yml for more details.

Example

- name: Mattermost Notification
  uses: tferreira/matterfy@releases/v1
  if: always()
  with:
    type: ${{ job.status }}
    job_name: '*Lint Check*'
    channel: 'random'
    url: ${{ secrets.SLACK_WEBHOOK }}

UI Examples

Success Case

github actions success pattern

Failure Case

github actions failure pattern

Cancel Case

github actions cancel pattern

LICENSE

The MIT License (MIT)