https://github.com/lmzdev/hellogithub_bot

Get GitHub notifications via Telegram
https://github.com/lmzdev/hellogithub_bot

bot github github-notifications github-webhook github-webhooks php php7 telegram telegram-bot

Last synced: 3 months ago
JSON representation

Get GitHub notifications via Telegram

• Host: GitHub
• URL: https://github.com/lmzdev/hellogithub_bot
• Owner: lmzdev
• License: mit
• Created: 2020-11-11T22:47:06.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-02T22:16:25.000Z (over 2 years ago)
• Last Synced: 2025-01-30T20:42:29.558Z (5 months ago)
• Topics: bot, github, github-notifications, github-webhook, github-webhooks, php, php7, telegram, telegram-bot
• Language: PHP
• Homepage:
• Size: 36.1 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hellogithub_bot

Ever wanted to keep track of your repositories the easiest way possible? This tool bridges GitHub's webhook notifications to a Telegram-Bot.

## 🔶 Advantages

- Productivity: Add to group chats to let small teams keep track of their work

- Lightweight: Only a single file, runs on cheap hosting plans

- Privacy: Does not store any data. At all.

## 🔶 Usage

### You can use my already existing bot...

1. 🔗 Go to [t.me/hellogithub_bot](https://t.me/hellogithub_bot)

2. 🤖 Start Bot and copy webhook url

3. 📋 Add webhook url to your repository

4. ✅ Get notified!

### ... or you can host your own

1. Create a new bot with [@BotFather](https://t.me/BotFather)

1. Upload ```bot.php``` to your webspace

2. Add a ```config.php``` containing your Bot-Token. **Do not [publish](https://core.telegram.org/bots#6-botfather) that Token!**

1. Tell Telegram to use your Bot by calling ```bot.php?webhook&token=```

1. 🤖 Start your Bot and copy webhook url

3. 📋 Add webhook url to your repository

4. ✅ Get notified!

## 🔶 Supported GitHub Events

Hellogithub_bot currently supports the following types of [HTTP_X_GITHUB_EVENT](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/webhook-events-and-payloads)

* ```push```

* ```ping```

* ```issues```

* ```member```

* ```deploy_key```

* ```pull_request```

* ```delete```

* ```create```

* ```public```

* ```release```

* ```star```

* ```fork```

* ```workflow_run```