Skip to content
Provides the function of slack notification to GitHub Actions.
TypeScript JavaScript
Branch: master
Clone or download
Latest commit 3547ce2 Oct 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows Fixed pre-branch test case Sep 16, 2019
__tests__ Initial commit Aug 15, 2019
docs Initial commit Aug 15, 2019
src Fix a typo Oct 23, 2019
.gitignore Initial commit Aug 15, 2019
LICENSE Prepare repository Aug 15, 2019
README.md fix legacy syntax in README Oct 21, 2019
action.yml add branding Sep 14, 2019
jest.config.js Initial commit Aug 15, 2019
package-lock.json [command] npm audit fix Oct 24, 2019
package.json Add a script for publishing Aug 15, 2019
tsconfig.json Initial commit Aug 15, 2019

README.md

Action Slack

GitHub Actions status GitHub Actions status

You can notify slack of GitHub Actions.

Usage

See action.yml, checkin.yml

with Parameters

key value default description
status 'success' or 'failure' or 'cancelled' or 'custom' '' Recommend
${{ job.status }}.
text any string '' You can add to text by specifying it.
author_name any string '8398a7@action-slack' It can be overwritten by specifying. The job name is recommend.
mention 'here' or 'channel' or '' '' Always mention when specified.
only_mention_fail 'here' or 'channel' or '' '' If specified, mention only on failure.
payload e.g. {"text": "Custom Field Check", obj: 'LOWER CASE'.toLowerCase()} '' Only available when status: custom. The payload format can pass javascript object.
username Only legacy incoming webhook supported. '' override the legacy integration's default name.
icon_emoji Only legacy incoming webhook supported. '' an emoji code string to use in place of the default icon.
icon_url Only legacy incoming webhook supported. '' an icon image URL string to use in place of the default icon.
channel Only legacy incoming webhook supported. '' override the legacy integration's default channel. This should be an ID, such as C8UJ12P4P.

See here for payload reference or Custom Notification.

Notification

success

- uses: 8398a7/action-slack@v2
  with:
    status: ${{ job.status }}
    author_name: Integration Test # default: 8398a7@action-slack
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # required
    SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required
  if: always() # Pick up events even if the job fails or is canceled.

When adding to text, write as follows.

- uses: 8398a7/action-slack@v2
  with:
    status: ${{ job.status }}
    text: overwrite text
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # required
    SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required

In case of failure or cancellation, you will be notified as follows.

failure

cancelled

Legacy Incoming Webhooks

If you specify as follows, you can also support legacy incoming webhooks.
The specified secrets.SLACK_WEBHOOK_URL must be legacy.

- uses: 8398a7/action-slack@v2
  with:
    type: ${{ job.status }}
    username: Custom Username
    icon_emoji: ':octocat:'
    channel: '#integration-test'
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # required
    SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required

Custom Notification

Use status: custom if you want to send an arbitrary payload.
The payload format can pass javascript object.

custom

- uses: 8398a7/action-slack@v2
  with:
    status: custom
    payload: |
      {
        text: "Custom Field Check",
        attachments: [{
          "author_name": "8398a7@action-slack", // json
          fallback: 'fallback',
          color: 'good',
          title: 'CI Result',
          text: 'Succeeded',
          fields: [{
            title: 'lower case',
            value: 'LOWER CASE CHECK'.toLowerCase(),
            short: true
          },
          {
            title: 'reverse',
            value: 'gnirts esrever'.split('').reverse().join(''),
            short: true
          },
          {
            title: 'long title1',
            value: 'long value1',
            short: false
          }],
          actions: [{
          }]
        }]
      }
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # optional
    SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required

Next Action

Selectable Field

Currently the field is fixed, but I want to make it selectable.
It is assumed that the input is in csv format.

- uses: 8398a7/action-slack@v2
  with:
    status: ${{ job.status }}
    fields: repo,message,action,author
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # required
    SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # required
You can’t perform that action at this time.