README.md

Slack Notify Action

Send Notifications to Slack from a GitHub Workflow

ToC

• Feature
• Inputs
• Examples
  • Basic usage
  • Includes the latest commit information
• Slack UI
• LICENSE

Feature

• Uses Slack's Web API instead of an Incoming Webhook
• Notify the result of GitHub Actions
• Support three job status (reference: job-context)
  • success
  • failure
  • cancelled
• Mention
  • Notify message to channel members efficiently
  • You can specify the condition to mention

Inputs

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	default	description
type	required	N/A	The result of GitHub Actions job This parameter value must contain the following word: - success - failure - cancelled We recommend using ${{ job.status }}
job_name	required	N/A	Means slack notification title
url	required	N/A	Slack Incoming Webhooks URL Please specify this key or SLACK_WEBHOOK environment variable ※SLACK_WEBHOOK will be deprecated
mention	optional	N/A	Slack message mention
mention_if	optional	N/A	The condition to mention This parameter can contain the following word: - success - failure - cancelled - always
icon_emoji	optional	Use Slack Incoming Webhook configuration	Slack icon
username	optional	Use Slack Incoming Webhook configuration	Slack username
channel	optional	Use Slack Incoming Webhook configuration	Slack channel name
commit	optional	false	If true, slack notification includes the latest commit message and author.
token	case by case	N/A	This token is used to get commit data. If commit parameter is true, this parameter is required. ${{ secrets.GITHUB_TOKEN }} is recommended.

Please refer to action.yml for more details.

Examples

Basic usage

- name: Slack Notification
  uses: gesellix/slack-notify-action@main
  if: always()
  with:
    type: ${{ job.status }}
    job_name: '*Test*'
    channel: '#random'
    url: ${{ secrets.SLACK_WEBHOOK }}

Includes the latest commit information

- name: Slack Notification
  uses: gesellix/slack-notify-action@main
  if: always()
  with:
    type: ${{ job.status }}
    job_name: '*Lint Check*'
    mention: 'here'
    mention_if: 'failure'
    channel: '#random'
    url: ${{ secrets.SLACK_WEBHOOK }}
    commit: true
    token: ${{ secrets.GITHUB_TOKEN }}

Slack UI

---

License

The MIT License (MIT)

Credits

Most of the code is based on gesellix/slatify, which is a fork of lazy-actions/slatify, formerly known as homoluctus/slatify.

---

Create a JavaScript Action using TypeScript

Use this template to bootstrap the creation of a TypeScript action.:rocket:

This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance.

If you are new, there's also a simpler introduction. See the Hello World JavaScript Action

Create an action from this template

Click the Use this Template and provide the new repo details for your action

Code in Main

First, you'll need to have a reasonably modern version of node handy. This won't work with versions older than 9, for instance.

Install the dependencies

$ npm install

Build the typescript and package it for distribution

$ npm run build && npm run package

Run the tests ✔️

$ npm test

 PASS  ./index.test.js
  ✓ throws invalid number (3ms)
  ✓ wait 500 ms (504ms)
  ✓ test runs (95ms)

...

Change action.yml

The action.yml defines the inputs and output for your action.

Update the action.yml with your name, description, inputs and outputs for your action.

See the documentation

Change the Code

Most toolkit and CI/CD operations involve async operations so the action is run in an async function.

import * as core from '@actions/core';
...

async function run() {
  try { 
      ...
  } 
  catch (error) {
    core.setFailed(error.message);
  }
}

run()

See the toolkit documentation for the various packages.

Publish to a distribution branch

Actions are run from GitHub repos so we will checkin the packed dist folder.

Then run ncc and push the results:

$ npm run package
$ git add dist
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1

Note: We recommend using the --license option for ncc, which will create a license file for all of the production node modules used in your project.

Your action is now published! 🚀

See the versioning documentation

Validate

You can now validate the action by referencing ./ in a workflow in your repo (see test.yml)

uses: ./
with:
  milliseconds: 1000

See the actions tab for runs of this action! 🚀

Usage:

After testing you can create a v1 tag to reference the stable and latest V1 action