https://github.com/serize02/.github-telegram
This repository implements a GitHub Actions workflow using a shell script and a YAML configuration file to send notifications to a Telegram bot for specific events in a GitHub repository. This setup helps developers and teams stay informed about important activities like pushes, pull requests, and issues.
https://github.com/serize02/.github-telegram
github-config shell shell-script telegram workflow
Last synced: over 1 year ago
JSON representation
This repository implements a GitHub Actions workflow using a shell script and a YAML configuration file to send notifications to a Telegram bot for specific events in a GitHub repository. This setup helps developers and teams stay informed about important activities like pushes, pull requests, and issues.
- Host: GitHub
- URL: https://github.com/serize02/.github-telegram
- Owner: serize02
- Created: 2025-01-30T06:49:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-01T06:05:13.000Z (over 1 year ago)
- Last Synced: 2025-02-01T07:18:22.202Z (over 1 year ago)
- Topics: github-config, shell, shell-script, telegram, workflow
- Language: Shell
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Getting Started
Follow these steps to set up the workflow in your GitHub repository:
## Create a Telegram Bot
1. Open Telegram and search for the user **@BotFather**.
2. Start a chat with BotFather and use the command `/newbot` to create a new bot.
3. Follow the prompts to name your bot and choose a username. Once created, you will receive a bot token.
## Obtain Your Chat ID
1. Start a chat with your new bot by searching for its username in Telegram.
2. Send any message to the bot.
3. To get your chat ID, you can use the following URL in your browser, replacing `YOUR_BOT_TOKEN` with your actual bot token:
https://api.telegram.org/botYOUR_BOT_TOKEN/getUpdates
4. Look for the `chat` object in the JSON response to find your `chat_id`.
## Add Secrets to Your GitHub Repository
1. Go to your GitHub repository where you want to set up the workflow.
2. Click on **Settings** > **Secrets and variables** > **Actions** > **New repository secret**.
3. Add the following secrets:
- **TOKEN**: Your Telegram bot token.
- **CHAT_ID**: Your chat ID.
## Configure the Workflow
1. Copy the content of this repo on `.github` directory.
2. Customize the YAML file as needed to specify which events you want to monitor.
## Commit and Push
1. Commit your changes and push them to your GitHub repository:
```bash
git add .
git commit -m "Add Telegram notification workflow"
git push
```