https://github.com/muhammadmp97/blueoctocat

Github action for getting Telegram notifications
https://github.com/muhammadmp97/blueoctocat

actions github-actions notification telegram

Last synced: 11 months ago
JSON representation

Github action for getting Telegram notifications

• Host: GitHub
• URL: https://github.com/muhammadmp97/blueoctocat
• Owner: muhammadmp97
• Created: 2024-02-19T18:55:43.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-02-20T21:39:32.000Z (over 2 years ago)
• Last Synced: 2025-03-25T09:02:42.609Z (about 1 year ago)
• Topics: actions, github-actions, notification, telegram
• Language: JavaScript
• Homepage:
• Size: 1.13 MB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Blue Octocat

Do you want to receive Telegram notifications, when your repository gets new issues/PRs?

## How to use

1. Create a Telegram bot using [@BotFather](https://core.telegram.org/bots/features#botfather).

2. Open your bot and click on the start button; bots cannot send messages unless your start a conversation with them.

3. Add the required [secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) to your repository: BOT_TOKEN and USER_ID. The second one is the receiver's id and you can get yours by using the [@get_id_bot](https://telegram.me/get_id_bot) bot.

5. Create your workflow file:

```yaml

# .github/workflows/notify.yml

name: telegram-notifier

on:

  pull_request:

    types: [opened]

  issues:

    types: [opened]

jobs:

  something:

    runs-on: ubuntu-latest

    steps:

      - name: Blue Octocat            

        uses: muhammadmp97/BlueOctocat@v1.0.0

        with:

          bot_token: ${{ secrets.BOT_TOKEN }}

          user_id: ${{ secrets.USER_ID }}

```

You may create an issue to test the workflow if it works properly.