This GitHub Action allows you to upload files from your GitHub repository to Telegram using Telethon. Perfect for sharing build artifacts, logs, or any files directly through Telegram messages.
Required The recipient of the message (chat ID, username...).
Required The message to send along with the files.
Required The list of file paths to upload, one file per line.
The status of the command execution.
This action requires three environment variables to be set:
API_ID
: Your Telegram API ID.API_HASH
: Your Telegram API hash.BOT_TOKEN
: The Bot token.
You can obtain your API_ID
and API_HASH
from my.telegram.org, and the BOT_TOKEN
from BotFather on Telegram.
This example demonstrates how to use the Telegram File Uploader action with the required inputs and environment variables.
Create a .github/workflows/telegram-upload.yml
(or add to your existing workflow file):
name: Upload Files to Telegram
on: [push]
jobs:
upload-to-telegram:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Upload files to Telegram
uses: xz-dev/TelegramFileUploader@v1
with:
to-who: 'username'
message: 'Here are your files!'
files: |
/path/to/file1
/path/to/file2
env:
API_ID: ${{ secrets.API_ID }}
API_HASH: ${{ secrets.API_HASH }}
BOT_TOKEN: ${{ secrets.BOT_TOKEN }}
Make sure to replace your-github-username/telegram-file-uploader-action@v1
with the path to your action in your repository and the actual values of to-who
and files
inputs. Also, remember to set API_ID
, API_HASH
, and BOT_TOKEN
in your repository's secrets.
env:
API_ID: ${{ secrets.API_ID }}
API_HASH: ${{ secrets.API_HASH }}
BOT_TOKEN: ${{ secrets.BOT_TOKEN }}
This README provides a basic overview of your GitHub Action, how to use it, and how to configure it with necessary environment variables. Adjust the content according to your actual action's repository, inputs, and needs.