https://github.com/ahmadnassri/action-slack-workflow-notifications

Fully detailed GitHub Actions workflow notifications in Slack
https://github.com/ahmadnassri/action-slack-workflow-notifications

action github notifications slack

Last synced: 3 months ago
JSON representation

Fully detailed GitHub Actions workflow notifications in Slack

• Host: GitHub
• URL: https://github.com/ahmadnassri/action-slack-workflow-notifications
• Owner: ahmadnassri
• License: mit
• Created: 2020-08-20T02:01:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-16T23:01:49.000Z (almost 2 years ago)
• Last Synced: 2024-10-05T09:41:16.035Z (3 months ago)
• Topics: action, github, notifications, slack
• Language: JavaScript
• Homepage:
• Size: 391 KB
• Stars: 1
• Watchers: 3
• Forks: 3
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Action: GitHub Slack Workflow Notifications

Fully detailed GitHub Actions workflow notifications in Slack

[![license][license-img]][license-url]

[![release][release-img]][release-url]

[![super linter][super-linter-img]][super-linter-url]

[![test][test-img]][test-url]

[![semantic][semantic-img]][semantic-url]

![](docs/preview.png)

## Usage

``` yaml

on:

  pull_request:

jobs:

  # run as many jobs as you want

  a-job:

    runs-on: ubuntu-latest

    steps:

      # run as many steps as you need

      - uses: actions/checkout@v2

      - uses: actions/setup-node@v1

      - run: npm install

      - run: npm test

  # include one last job

  slack:

    if: ${{ always() }} # ensure this job always runs

    needs: [ a-job, ... ] # indicate which jobs you want to wait for

    runs-on: ubuntu-latest

    steps:

      - uses: ahmadnassri/action-slack-workflow-notifications@v1

        with:

          slack-webhook: https://hooks.slack.com/services/...

          ignore-jobs: slack

          ignore-steps: actions/checkout@v2

```

### Inputs

| input           | required | default                    | description                                                     |

|-----------------|----------|----------------------------|-----------------------------------------------------------------|

| `slack-webhook` | ✔        | `-`                        | A Slack [Webhook URL](https://api.slack.com/messaging/webhooks) |

| `github-token`  | ❌        | `github.token`             | The GitHub token used to update the pull-request                |

| `ignore-jobs`   | ❌        | ` `                        | Comma separated list of job names to ignore                     |

| `ignore-steps`  | ❌        | `Set up job, Complete job` | Comma separated list of step names to ignore                    |

----

> Author: [Ahmad Nassri](https://www.ahmadnassri.com/) •

> Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)

[license-url]: LICENSE

[license-img]: https://badgen.net/github/license/ahmadnassri/action-slack-workflow-notifications

[release-url]: https://github.com/ahmadnassri/action-slack-workflow-notifications/releases

[release-img]: https://badgen.net/github/release/ahmadnassri/action-slack-workflow-notifications

[super-linter-url]: https://github.com/ahmadnassri/action-slack-workflow-notifications/actions?query=workflow%3Asuper-linter

[super-linter-img]: https://github.com/ahmadnassri/action-slack-workflow-notifications/workflows/super-linter/badge.svg

[test-url]: https://github.com/ahmadnassri/action-slack-workflow-notifications/actions?query=workflow%3Atest

[test-img]: https://github.com/ahmadnassri/action-slack-workflow-notifications/workflows/test/badge.svg

[semantic-url]: https://github.com/ahmadnassri/action-slack-workflow-notifications/actions?query=workflow%3Arelease

[semantic-img]: https://badgen.net/badge/📦/semantically%20released/blue