Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/muhammadmp97/blueoctocat

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

actions github-actions notification telegram

Last synced: about 1 month ago
JSON representation

Github action for getting Telegram notifications

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/[email protected]
with:
bot_token: ${{ secrets.BOT_TOKEN }}
user_id: ${{ secrets.USER_ID }}
```

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