Overview
GitHub Parrot Bot - telegram bot for tracking GitHub repository events, such as:
- Issues
- Pull request
- Check suits.
- Check runs.
Also, you can connect your GitHub username to telegram username and bot will tag you if issue ot pull request refers to you.
Why GitHub Parrot?
Because it uses webhooks to get updates. No OAuth and right privileges!. Just safe webhooks. Sounds good, right?
Getting started
Inviting the bot to Telegram chat
To connect the bot to Telegram chat follow steps:
- Open the chat where you want to add the bot.
- Open chat settings.
- Press the Add Memeber button.
- Find bot using tag
@GitHubIssuesPullsTrackingBot
. - Add the bot.
- Give the bot rights to delete messages.
Connecting the bot to the GitHub repository
So, when you have added the bot to your telegram chat - it’s time to add repository for tracking. One chat can be connected to several repositories as well as one repository to several chats.
To add the repository link follow steps:
- Come up with the secret word. Is can be any word from 4 to 255 symbols.
- Use next command in your Telegram chat to create a repository link:
/add <repository name> <your secret word>
Example:
/add "octocat/hello-worId" hellodarkness
- Now move to your GitHub repository.
- Open repository setting and go to the Webhooks section.
- Press Add webhook.
- Set the Payload URL field to:
here will be url
. - Set the Content type field to:
application/json
! - Fill the Secret field with your secret word.
- Select webhook events or select
send me everything
option. - Ensure that the Active flag is checked.
- Press Add webhook button.
Adding your GitHub nickname to bot
When you have connected your repository you can create link between your Telegram and GitHub accounts. It means, that when bot sends updates it will tag you in chat if you are related to the issue or pull request. That called AKA
.
To create AKA use following command in the chat:
/connect <github username>
Example:
/connect Octocat
Now, bot can tag you on new information updates.
Congratulations
Congratulations, you have made basic bot setup and now you can track repository updates. Hope, you are pleased .
What’s next
Now your GitHub repository issues, pull requests and other will appear in Telegram chat.
Giving rights
[instruction how to give bot rights]
Feedback
For developers
| Source usage
You can find information about source code usage in Wiki.
Also, you can find short information in source code directories using README.md
files.