Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cbrgm/telegram-github-action
Send (text) messages to a Telegram chat from GitHub Actions
https://github.com/cbrgm/telegram-github-action
action gihub-actions github go message telegram
Last synced: 3 months ago
JSON representation
Send (text) messages to a Telegram chat from GitHub Actions
- Host: GitHub
- URL: https://github.com/cbrgm/telegram-github-action
- Owner: cbrgm
- License: apache-2.0
- Created: 2023-12-13T17:47:09.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-01T12:10:52.000Z (5 months ago)
- Last Synced: 2024-10-24T04:10:41.250Z (4 months ago)
- Topics: action, gihub-actions, github, go, message, telegram
- Language: Makefile
- Homepage: https://cbrgm.net
- Size: 60.5 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Telegram GitHub Action
**Send (text) messages to a Telegram chat from GitHub Actions.**
[](https://github.com/cbrgm/telegram-github-action)
[](https://goreportcard.com/report/github.com/cbrgm/telegram-github-action)
[](https://github.com/cbrgm/telegram-github-action/actions/workflows/go-lint-test.yml)
[](https://github.com/cbrgm/telegram-github-action/actions/workflows/go-binaries.yml)
[](https://github.com/cbrgm/telegram-github-action/actions/workflows/container.yml)
## Inputs
- `token`: **Required** - Telegram bot's authorization token. Use GitHub secrets.
- `to`: **Required** - Unique identifier or username of the target Telegram chat.
- `message`: Optional - Text message to send. If omitted, bot's information is fetched.
- `parse-mode`: Optional - Mode for parsing text entities (`markdown` or `html`).
- `disable-web-page-preview`: Optional - Disables link previews.
- `disable-notification`: Optional - Sends message silently.
- `protect-content`: Optional - Protects message content from forwarding/saving.
- `dry-run`: Optional - If set, do not send a real message but print the details instead.
### Workflow Usage
```yaml
name: Send Telegram Message
on: [push]
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: Send Telegram Message
uses: cbrgm/telegram-github-action@v1
with:
token: ${{ secrets.TELEGRAM_TOKEN }}
to: ${{ secrets.TELEGRAM_CHAT_ID }}
message: "New commit pushed to repository"
```
#### Example Workflow: Inline Messages and Variable Templating
This workflow triggers a Telegram message notification when a new tag is published in the repository.
```yaml
name: Inline Message Workflow
on:
push:
branches: [main]
jobs:
send-inline-message:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Send Inline Telegram Message
uses: cbrgm/telegram-github-action@v1
with:
token: ${{ secrets.TELEGRAM_TOKEN }}
to: ${{ secrets.TELEGRAM_CHAT_ID }}
message: |
New commit by ${{ github.actor }}!
Commit: ${{ github.event.head_commit.message }}
Repository: ${{ github.repository }}
View changes: https://github.com/${{ github.repository }}/commit/${{ github.sha }}
```
### Example Workflow: Notification on New GitHub Release
This workflow triggers a Telegram message notification when a new release is published in the repository.
```yaml
name: Release Notification
on:
release:
types: [published]
jobs:
notify-on-release:
runs-on: ubuntu-latest
steps:
- name: Send Telegram Notification on New Release
uses: cbrgm/telegram-github-action@v1
with:
token: ${{ secrets.TELEGRAM_TOKEN }}
to: ${{ secrets.TELEGRAM_CHAT_ID }}
message: |
🚀 New Release Published!
Release Name: ${{ github.event.release.name }}
Tag: ${{ github.event.release.tag_name }}
Actor: ${{ github.actor }}
Repository: ${{ github.repository }}
Check it out: ${{ github.event.release.html_url }}j
```
### Creating a Telegram Bot and Obtaining a Token
1. Chat with [BotFather](https://t.me/botfather) on Telegram.
2. Follow prompts to name your bot and get a token.
3. Store the token as a GitHub secret (`TELEGRAM_TOKEN`).
### Obtaining the Chat ID
Run the following command:
```bash
curl https://api.telegram.org/bot/getUpdates
```
Replace with your bot's token to find your `chat_id` (`TELEGRAM_CHAT_ID`).
### Local Development
You can build this action from source using `Go`:
```bash
make build
```
## Contributing & License
* **Contributions Welcome!**: Interested in improving or adding features? Check our [Contributing Guide](https://github.com/cbrgm/telegram-github-action/blob/main/CONTRIBUTING.md) for instructions on submitting changes and setting up development environment.
* **Open-Source & Free**: Developed in my spare time, available for free under [Apache 2.0 License](https://github.com/cbrgm/telegram-github-action/blob/main/LICENSE). License details your rights and obligations.
* **Your Involvement Matters**: Code contributions, suggestions, feedback crucial for improvement and success. Let's maintain it as a useful resource for all 🌍.