Skip to content

Files

Latest commit

ecc3e27 ยท Mar 2, 2023

History

History
41 lines (35 loc) ยท 1.45 KB

README.md

File metadata and controls

41 lines (35 loc) ยท 1.45 KB

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
  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
  2. Upload bot.php to your webspace
  3. Add a config.php containing your Bot-Token. Do not publish that Token!
  4. Tell Telegram to use your Bot by calling bot.php?webhook&token=<yourbottoken>
  5. ๐Ÿค– Start your Bot and copy webhook url
  6. ๐Ÿ“‹ Add webhook url to your repository
  7. โœ… Get notified!

๐Ÿ”ถ Supported GitHub Events

Hellogithub_bot currently supports the following types of HTTP_X_GITHUB_EVENT

  • push
  • ping
  • issues
  • member
  • deploy_key
  • pull_request
  • delete
  • create
  • public
  • release
  • star
  • fork
  • workflow_run