github-telegram-notify
github-telegram-notify copied to clipboard
Actions that sends commit updates of a repository to any chat in Telegram
Github Telegram Notify
Actions that sends commit updates of a repository to any chat in Telegram
🏪 View on Github Marketplace 🏷️ v1.1.2
Prerequisites
- bot_token
A Telegram Bot Token is required for using the Telegram bot from which the commit updates are being send.
Obtaining a Telegram Bot Token
- Goto @BotFather
- After sending
/start
command, send/newbot
- Follow the onscreen instructions and at the end, you'll obtain a bot token.
- chat_id
Obtaining Chat ID of a group
- Go to the group of your choice
- Add @MissRose_bot
- Type the command
/id
and send it to the group.
- topic_id
(optional)
Use this only if you have topics enabled.
How to use
Add the following lines of code in your YML file.
- name: Notify the commit on Telegram
uses: EverythingSuckz/github-telegram-notify@main
with:
bot_token: '${{ secrets.BOT_TOKEN }}'
chat_id: '${{ secrets.CHAT_ID }}'
Supported events
- [x] Commits
- [x] Forks
- [x] Watch
- [x] stars
- [x] Issues
- [x] created
- [x] closed
- [x] opened
- [x] reopened
- [x] locked
- [x] unlocked
- [x] Issue comments
- [x] created
- [x] deleted
- [x] Pull Request
- [x] created
- [x] closed
- [x] opened
- [x] reopened
- [x] locked
- [x] unlocked
- [x] synchronize
- [x] Pull Request comments
- [x] created
- [x] deleted
- [x] Releases
- [x] published
- [x] released
- [ ] Discussions
- [ ] Discussion comments
Contributing
If you can't find the event you are looking for, assume that it's not tested yet. You are free to open a pull request.
Also, feel free to open a PR in case of any minor fix and please open an issue first for major changes.