RSS feeds for GitHub activity across multiple repositories with customizable feed organization.
============================================================================
- Create config file: mkdir -p ~/.config/github-activity-rss
- Copy example config and customize
- Set GITHUB_TOKEN environment variable
- Run: main.py --feed-organization custom
- Output files appear in output-dir (default: current directory)
# ============================================================================
# CONFIGURATION FILE REFERENCE
# ============================================================================
# Location: ~/.config/github-activity-rss/config.yaml
#
# FULL EXAMPLE CONFIG with all options:
# ============================================================================
#
# ---- Global Settings ----
# repo:
# - owner/repo1 # Single repository
# - owner/repo2
# - owner/pattern* # Glob patterns (requires --repo-cache-days)
#
state-file: ~/.local/share/github-activity-rss/state.db
since-days: 7 # Look back 7 days for activity
repo-cache-days: 7 # Cache owner's repo list for 7 days
verbose: true # Print progress to stderr
feed-organization: custom # Options: single, by-type, custom
output-dir: ~/feeds # Directory for output RSS files
#
# ---- Custom Feed Definitions ----
# custom-feeds:
# development:
# title: "Development Activity"
# types: [pushes, prs, issues, releases]
# image: "🚀" # Optional: emoji for RSS feed icon
#
# code-review:
# title: "Code Reviews Needed"
# types: [pr-reviews, pr-review-comments, issue-comments]
# image: "👁️"
#
# releases-only:
# title: "Releases & Deployments"
# types: [releases, deployments, deployment-status]
# image: "🏷️"
#
# ============================================================================
# AVAILABLE EVENT TYPES
# ============================================================================
# pushes - Push events to branches
# prs - Pull request opened/closed/merged
# issues - Issues opened/closed
# releases - Release published
# stars - Repository starred
# issue-comments - Comments on issues
# pr-reviews - PR reviews submitted
# pr-review-comments - Comments on PR reviews
# commit-comments - Comments on commits
# create - Branch or tag created
# delete - Branch or tag deleted
# forks - Repository forked
# deployments - Deployment created
# deployment-status - Deployment status changed
# wiki - Wiki pages created/updated
#
# Sub-types (for custom feeds only):
# prs-opened - PRs opened or reopened
# prs-closed - PRs closed or merged
#
# Special keyword: "all" - Include all event types
#
# ============================================================================
# CONFIGURATION EXAMPLES
# ============================================================================
#
# Example 1: Granular feeds (Recommended — covers all 15 event types)
custom-feeds:
prs-opened:
title: "New Pull Requests"
types: [prs-opened]
image: "🔀"
prs-closed:
title: "Closed/Merged PRs"
types: [prs-closed]
image: "✅"
reviews:
title: "Code Reviews"
types: [pr-reviews, pr-review-comments]
image: "👁️"
issues:
title: "Issues & Discussion"
types: [issues, issue-comments, commit-comments]
image: "🐛"
development:
title: "Code Changes"
types: [pushes, create, delete]
image: "💻"
releases:
title: "Releases & Deployments"
types: [releases, deployments, deployment-status]
image: "🏷️"
community:
title: "Community & Wiki"
types: [stars, forks, wiki]
image: "⭐"
#
# Example 2: Group by activity criticality
# custom-feeds:
# critical:
# title: "Critical: PRs & Releases"
# types: [prs, releases, deployments] # High-impact changes
# image: "🔴"
#
# activity:
# title: "General Activity"
# types: [pushes, issues, issue-comments]
# image: "🟡"
#
# optional:
# title: "Background Information"
# types: [stars, forks, wiki, create, delete]
# image: "🔵"
#
# Example 3: By team role / responsibility
# custom-feeds:
# my-work:
# title: "My Code Changes"
# types: [pushes, prs, releases] # Your development work
# image: "📝"
#
# feedback:
# title: "Feedback on My Work"
# types: [pr-reviews, issue-comments, pr-review-comments]
# image: "💬"
#
# Example 4: Everything in one feed
# custom-feeds:
# all:
# title: "All GitHub Activity"
# types: [all] # Special keyword to include all event types
# image: "📦" # Optional: defaults to 📦 when not specified
#