https://github.com/rennf93/good-comms

This GitHub Action sends notifications to a Slack channel. It can send a new message or reply to an existing thread based on the provided inputs.
https://github.com/rennf93/good-comms

github-actions notification-service slack

Last synced: 14 days ago
JSON representation

This GitHub Action sends notifications to a Slack channel. It can send a new message or reply to an existing thread based on the provided inputs.

• Host: GitHub
• URL: https://github.com/rennf93/good-comms
• Owner: rennf93
• License: mit
• Created: 2024-07-19T16:44:23.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-07-25T23:52:12.000Z (3 months ago)
• Last Synced: 2024-10-04T21:36:02.720Z (about 1 month ago)
• Topics: github-actions, notification-service, slack
• Language: Python
• Homepage:
• Size: 52.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Good Comms

This GitHub Action sends notifications to a Slack channel. It can send a new message or reply to an existing thread based on the provided inputs.

Inspired by [rtCamp/action-slack-notify](https://github.com/rtCamp/action-slack-notify).

## Features

- Send a new message to a Slack channel.

- Reply to an existing thread in a Slack channel.

- Customize the message with author details, title, and color.

## Inputs

| Input Name         | Description                                     | Required |

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

| `SLACK_WEBHOOK`    | Slack webhook URL for sending messages          | true     |

| `STATUS`           | Status of the notification (e.g., success, fail)| false    |

| `AUTHOR_NAME`      | Name of the message author                      | false    |

| `AUTHOR_LINK`      | Link for the message author                     | false    |

| `AUTHOR_ICON`      | Icon URL for the message author                 | false    |

| `TITLE`            | Title of the message                            | false    |

| `TITLE_LINK`       | Link for the message title                      | false    |

| `MESSAGE`          | The message content                             | true     |

| `COLOR`            | Color of the message attachment                 | false    |

| `SLACK_TOKEN`      | Slack token for sending replies                 | true     |

| `CHANNEL_ID`       | Slack channel ID for sending replies            | true     |

| `SLACK_THREAD_TS`  | Timestamp of the thread to reply to             | false    |

## Outputs

This action sets the following outputs:

| Output Name        | Description                                     |

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

| `SLACK_THREAD_TS`  | Timestamp of the Slack thread                   |

| `SLACK_CHANNEL`    | Slack channel ID                                |

| `SLACK_MESSAGE_ID` | ID of the sent Slack message                    |

## Usage

To use this action in your workflow, add the following step:

```yaml

- name: Send Slack Communication

  uses: rennf93/good-comms@v1

  with:

    SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

    STATUS: 'success'

    AUTHOR_NAME: 'GitHub Action'

    AUTHOR_LINK: 'https://github.com'

    AUTHOR_ICON: 'https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png'

    TITLE: 'Build Notification'

    TITLE_LINK: 'https://github.com'

    MESSAGE: 'Your build has completed successfully!'

    COLOR: 'warning'

    SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}

    CHANNEL_ID: 'C12345678'

    SLACK_THREAD_TS: ${{ steps.previous-step.outputs.SLACK_THREAD_TS }}

```

## Example Workflow

Here is an example of how to integrate this action into a GitHub workflow:

```yaml

name: Example Workflow

on:

  push:

    branches:

      - main

jobs:

  send-slack-comms:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout repository

        uses: actions/checkout@v2

      - name: Send Slack Communication

        uses: rennf93/good-comms@v1

        with:

          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

          STATUS: 'success'

          AUTHOR_NAME: 'GitHub Action'

          AUTHOR_LINK: 'https://github.com'

          AUTHOR_ICON: 'https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png'

          TITLE: 'Build Notification'

          TITLE_LINK: 'https://github.com'

          MESSAGE: 'Your build has completed successfully!'

          COLOR: 'good'

          SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}

          CHANNEL_ID: 'C12345678'

          SLACK_THREAD_TS: ${{ steps.previous-step.outputs.SLACK_THREAD_TS }}

```

## License

This project is licensed under the MIT License - see the LICENSE file for details.