Simple Telegram GitHub changelog bot, commonly used in public projects to show progress, with some cool features such as:
- 🌐 Multi-language support! You can contribute adding your language, just make a PR!
- ⚙ Extensively configurable, you can tweak basically anything you'll ever need.
- 🍕 Powered by pizza.
- NodeJS (LTS)
- NPM
- A telegram bot token, easily obtained using Telegram's Bot Father.
- A GitHub repository with a valid webhook configuration in order to reach the webserver.
- Some pizza 🍕
Having all those requirements met, you just have to install and briefly configure the bot. Let me walk you through this process.
First of all you should clone the repository, after that cd into it and run npm install in order to download all the needed dependencies for it to run. Then you have to configure the configuration file (config.json).
These are all the settings explained:
| Property | Type | Description |
|---|---|---|
| WebServer | WebServer configuration | |
| shouldCloseOnError | Boolean | Whether the webserver should close on error when starting up or staying online. This is totally up to you. Default: true |
| webhookEndpoint | String | The endpoint which github will be sending requests to. Example: http://<your-ip>/webhookEndpoint Default: /github |
| port | Number | The port number which the webserver will be listening to |
| logging | Boolean | Whether the webserver should be logging requests or not. |
| secret | String | The secret key used for validating requests, recommended. |
| Bot | Bot configuration | |
| token | String | The telegram's bot token |
| groupID | Number | The group ID which the bot will be sending "draft" commit messages that, if accepted, will be sent to the configured channel. To obtain that you can use the /chatid command in the group chat, while the bot is inside and administrator. |
| channelID | String | The channel which the bot will be sending commit messages that were previously accepted. The bot MUST be an administrator. |
| admin | Array<Number> | An array containing userIDs of those who will be able to execute admin commands on the bot. |
| language | String | The language code that directly correseponds with the file name in the languages folder. Example: lang/it.json -> language: "it" |
| repoUrlPreview | Boolean | Determines whether or not the telegram should show the message's links preview |
| addRepoLinkIfPublic | Boolean | Whether the bot should add the link to the repository if is public or not. |
In order to receive updates from github when a push event is being fired you must configure the webhook properly.
To do so follow these steps:
- Open the repository you want to get updates from
- Navigate to the settings
- Navigate to "Webhook"
- Click on "Add webhook"
- In the Payload URL field you have to put the webhook url according to the bot's configuration:
Example: http://yourdomain.xyz/webhookEndpoint - In the Content type selector choose "application/json"
- Add secret if you want to, recommended.
- Click on the "Add webhook" button
The bot needs to be administrator on both private group and public channel in order to be able to send messages. You must also enable "Allow groups" and disable "Groups privacy" in the Bot Father's bot settings.