https://github.com/tankibaj/github-release-notifier
A Python script that watches specified GitHub repositories for new releases and sends notifications to a Discord channel via webhook.
https://github.com/tankibaj/github-release-notifier
Last synced: 23 days ago
JSON representation
A Python script that watches specified GitHub repositories for new releases and sends notifications to a Discord channel via webhook.
- Host: GitHub
- URL: https://github.com/tankibaj/github-release-notifier
- Owner: tankibaj
- Created: 2023-06-30T17:04:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-15T21:32:07.000Z (over 1 year ago)
- Last Synced: 2025-05-16T10:09:51.124Z (5 months ago)
- Language: Python
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Release Notifier
A Python script that watches specified GitHub repositories for new releases and sends notifications to a Discord channel via webhook.
## Features
- Monitors multiple GitHub repositories for new releases.
- Sends notifications to a Discord channel using webhooks.
- Can be deployed as a Docker container or in a Kubernetes cluster.
- Optional GitHub authentication for higher rate limits.
- Configurable check interval.
## Requirements
- Python 3.6 or higher.
- Docker (for image build).
- Helm and Kubernetes (for Kubernetes deployment).
## Quick Start
### Local Deployment
- Clone the repository
```bash
git clone https://github.com/tankibaj/github-release-notifier.git
```
- Navigate to the project directory
```bash
cd github-release-notifier
```
- Install the required Python packages.
```bash
pip install -r requirements.txt
```
- Run the script
```bash
python main.py
```
### Build container image
- Build the Docker image
```bash
docker build -t thenaim/github-release-notifier:latest .
```
### Kubernetes Deployment
- Create a Helm chart using the provided instructions in the previous answers.
- Deploy the Helm chart to your Kubernetes cluster.
```bash
helm upgrade --install github-release-notifier ./helm-chart \
--namespace github-release-notifier \
--create-namespace
```
## Configuration
The following environment variables can be set for configuration:
- `DISCORD_WEBHOOK_URL`: The Discord webhook URL for sending notifications (required).
- `GITHUB_TOKEN`: A GitHub personal access token for authenticated requests (optional).
- `CHECK_INTERVAL`: The check interval in seconds (default: 7200, which is 2 hours).
- `REPOSITORIES`: A list of repositories to monitor, formatted as OWNER,REPO (required).
## Contributing
Contributions are welcome! Please submit a pull request or open an issue if you have any improvements or bug fixes.