MCPcopy Index your code
hub / github.com/EverythingSuckz/github-telegram-notify

github.com/EverythingSuckz/github-telegram-notify @v1.1.2

Chat with this repo
repository ↗ · DeepWiki ↗ · release v1.1.2 ↗ · + Follow
38 symbols 75 edges 16 files 2 documented · 5%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

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.

License

mit
Licensed under MIT License

Core symbols most depended-on inside this repo

Contains
called by 6
utils/snippets.go
String
called by 3
types/errors.go
SendMessage
called by 2
utils/telegram.go
CreateContents
called by 2
utils/parser.go
ParseEvent
called by 1
types/base.go
createPushText
called by 1
utils/parser.go
createForkText
called by 1
utils/parser.go
createIssueCommentText
called by 1
utils/parser.go

Shape

Struct 21
Function 15
Method 2

Languages

Go100%

Modules by API surface

utils/parser.go9 symbols
types/prs.go4 symbols
types/issues.go4 symbols
types/release.go3 symbols
types/errors.go3 symbols
main_test.go3 symbols
types/commit.go2 symbols
types/base.go2 symbols
utils/telegram.go1 symbols
utils/snippets.go1 symbols
types/watch.go1 symbols
types/user.go1 symbols

For agents

$ claude mcp add github-telegram-notify \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page