Skip to content

quipper/slack-notification-action

Repository files navigation

slack-notification-action ts

This is an action to notify a status of GitHub Actions to a Slack channel.

Example

image

Getting Started

To nofity a failure of workflow run on main branch,

name: slack-notification

on:
  workflow_run:
    workflows:
      - "**"
      # you can exclude some workflows, like:
      # - '!*-metrics'
    branches:
      - main
    types:
      - completed

jobs:
  send:
    if: github.event.workflow_run.conclusion == 'failure'
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: quipper/slack-notification-action@v2
        with:
          slack-channel-id: ABCDEF123 # your Slack channel ID
          slack-app-token: ${{ secrets.SLACK_APP_TOKEN }}

You need to set up your Slack App. See https://github.com/slackapi/slack-github-action for details.

Specification

This action ignores an event if the conclusion is cancelled or skipped.

When this action is run on workflow_run event, it inspects the target workflow run. Otherwise, it inspects the current workflow run.

Inputs

Name Default Description
slack-channel-id (required) ID of the Slack channel
slack-thread-ts - Thread timestamp to post message in
slack-app-token - Bot token of Slack App. If not set, dry run is performed
github-token github.token GitHub token
mention-message github.actor Message to mention the current user. Set to empty to disable mentioning

Outputs

None.

About

Notify workflow run of GitHub Actions to Slack

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 5