https://github.com/hunghg255/action-notifications

Github Action Notification for Discord, Slack, Telegram, Google Chat, Microsoft Teams. Support show QR code
https://github.com/hunghg255/action-notifications

actions ci discord github github-actions google-chat microsoft-teams notifications qrcode slack telegram-bot webhook

Last synced: about 1 month ago
JSON representation

Github Action Notification for Discord, Slack, Telegram, Google Chat, Microsoft Teams. Support show QR code

• Host: GitHub
• URL: https://github.com/hunghg255/action-notifications
• Owner: hunghg255
• Created: 2023-09-05T14:18:52.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-02T20:38:06.000Z (9 months ago)
• Last Synced: 2024-04-26T04:41:28.635Z (8 months ago)
• Topics: actions, ci, discord, github, github-actions, google-chat, microsoft-teams, notifications, qrcode, slack, telegram-bot, webhook
• Language: TypeScript
• Homepage:
• Size: 1.1 MB
• Stars: 15
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        










  A Github actions notification to Discord, Slack, Telegram, Google chat, Microsoft Teams, Support show QR code





  

  



## Usage

```yaml

uses: hunghg255/action-notifications@master

with:

  discord_webhook: ${{ secrets.DISCORD_WEBHOOK }}

  slack_webhook: ${{ secrets.SLACK_WEBHOOK }}

  telegram_bot_token: ${{ secrets.TELEGRAM_BOT_TOKEN }}

  telegram_chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}

  # telegram_message_thread_id: ${{ secrets.TELEGRAM_MESSAGE_THREAD_ID }}

  google_chat_webhook: ${{ secrets.GOOGLE_CHAT_WEBHOOK }}

  ms_teams_webhook: ${{ secrets.MS_TEAMS_WEBHOOK }}

  title: "Deploy to Dev"

  description: "Test here: https://hung.thedev.id"

```

## Inputs

| Properties                   | Description                       |                              |

| ---------------------------- | --------------------------------- | :--------------------------- |

| discord\_webhook             | Discord Webhook                   |                              |

| slack\_webhook               | Slack Webhook                     |                              |

| slack\_username              | Slack Username                    |                              |

| telegram\_bot\_token         | Telegram Bot Token                | Require `telegram_chat_id`   |

| telegram\_chat\_id           | Telegram Chat ID                  | Require `telegram_bot_token` |

| telegram\_message\_thread_id | Telegram Thread Message For Topic |                              |

| google\_chat\_webhook        | Google Chat Webhook               |                              |

| ms\_teams\_webhook           | Microsoft Teams Webhook           |                              |

| title                        | Title                             |                              |

| description                  | Description                       |                              |

| qrcode                       | Text                              |                              |

- Config telegram bot, get chat id: [CONFIG_TELEGRAM_BOT](https://github.com/hunghg255/action-notifications/blob/master/CONFIG_TELEGRAM_BOT.md)

## Example

```yaml

name: Notification

on:

  push:

    branches:

      - nofication

jobs:

  deploy:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: Build and lint

        run: |

          echo "Build and lint"

      - name: Notification Failure

        if: failure()

        uses: hunghg255/action-notifications@master

        with:

          discord_webhook: ${{ secrets.DISCORD_WEBHOOK }}

          slack_webhook: ${{ secrets.SLACK_WEBHOOK }}

          telegram_bot_token: ${{ secrets.TELEGRAM_BOT_TOKEN }}

          telegram_chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}

          # Remove comment below for Telegram Topic Message

          # telegram_message_thread_id: ${{ secrets.TELEGRAM_MESSAGE_THREAD_ID }}

          google_chat_webhook: ${{ secrets.GOOGLE_CHAT_WEBHOOK }}

          ms_teams_webhook: ${{ secrets.MS_TEAMS_WEBHOOK }}

          title: "Deploy to Dev"

          description: "Test here: https://hung.thedev.id"

  notifification:

    needs: deploy

    runs-on: ubuntu-latest

    steps:

      - name: Notification Success

        uses: hunghg255/action-notifications@master

        if: always()

        with:

          discord_webhook: ${{ secrets.DISCORD_WEBHOOK }}

          slack_webhook: ${{ secrets.SLACK_WEBHOOK }}

          telegram_bot_token: ${{ secrets.TELEGRAM_BOT_TOKEN }}

          telegram_chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}

          # Remove comment below for Telegram Topic Message

          # telegram_message_thread_id: ${{ secrets.TELEGRAM_MESSAGE_THREAD_ID }}

          google_chat_webhook: ${{ secrets.GOOGLE_CHAT_WEBHOOK }}

          ms_teams_webhook: ${{ secrets.MS_TEAMS_WEBHOOK }}

          title: "Deploy to Dev"

          description: "Test here: https://hung.thedev.id"

```

## Results

- Discord

![Discord](./assets/discord.png)

- Slack

![Slack](./assets/slack.png)

- Telegram

![Telegram](./assets/telegram.png)

- Google Chat

![Google Chat](./assets/google-chat.png)

- Microsoft Teams

![Microsoft Teams](./assets/ms-teams.png)