https://github.com/sudo88com/slacknotify-action

A GitHub Action for sending notifications to Slack
https://github.com/sudo88com/slacknotify-action

actions marketplace shell-script slack

Last synced: 15 days ago
JSON representation

A GitHub Action for sending notifications to Slack

• Host: GitHub
• URL: https://github.com/sudo88com/slacknotify-action
• Owner: sudo88com
• License: mit
• Created: 2024-06-26T00:39:31.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-07-07T01:45:18.000Z (4 months ago)
• Last Synced: 2024-10-04T21:36:07.324Z (about 1 month ago)
• Topics: actions, marketplace, shell-script, slack
• Language: Shell
• Homepage:
• Size: 56.6 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sudo88com/slacknotify-action

[![slacknotify-action](https://img.shields.io/github/v/release/sudo88com/slacknotify-action.svg)](https://github.com/sudo88com/slacknotify-action/releases)

Send notifications seamlessly to Slack from your GitHub Actions workflows with `slacknotify-action`. This GitHub Action allows you to notify your team about the success, failure, or any other status of your GitHub Actions workflows directly into Slack.

![Screenshot](./img/screen1.png)

## Usage

To use this action, add the following step to the end of your job in your GitHub workflow YAML file. Ensure that you add this step after any other steps that you want to monitor with notifications.

```yaml

    - name: Run Slack Notification

      if: always()  # Ensures notification is sent regardless of previous step success or failure

      uses: sudo88com/slacknotify-action@v1 # Check https://github.com/sudo88com/slacknotify-action/releases for latest release

      with:

        webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}

```

## Obtaining Slack App Webhook URL

To use this action, you need to obtain a webhook URL from Slack. Follow these steps:

1. **Create a Slack App:**

   - Go to the [Slack API: Applications](https://api.slack.com/apps) page.

   - Click on the "Create New App" button.

   - Enter an App Name and choose the workspace where you want to post notifications.

   - Click "Create App".

2. **Add Incoming Webhooks:**

   - In your newly created app, navigate to "Incoming Webhooks" on the left sidebar.

   - Activate the "Incoming Webhooks" toggle.

   - Click "Add New Webhook to Workspace".

   - Select the channel where you want to send notifications and click "Authorize".

3. **Copy the Webhook URL:**

   - After authorizing, you will see a new webhook URL generated.

   - Copy this URL and add it to your GitHub repository secrets as `SLACK_WEBHOOK_URL`.

## Example Workflow

```yaml

name: Example CI Workflow

on: [push]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

    - name: Checkout Code

      uses: actions/checkout@v2

    - name: Build Project

      run: make build

    - name: Run Slack Notification

      if: always()

      uses: sudo88com/slacknotify-action@v1

      with:

        webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}

```

## License

This project is licensed under the [MIT License](./LICENSE).