GitHub Weekly Reporter
Your GitHub activity, turned into a beautiful weekly report. Automatically.
Collects your commits, pull requests, and code reviews throughout the week.
An LLM writes a narrative summary. The result is a self-contained HTML report,
deployed to GitHub Pages. Runs as a GitHub Action, costs nothing on public repos.
Features
- AI narratives: six LLM providers (OpenRouter, Anthropic, OpenAI, Gemini, Groq, Grok). One API call per week generates title, overview, summaries, and highlights.
- GitHub Action: daily event collection + weekly report pipeline. Drop two workflow files and your reports run on autopilot. Zero cost on public repos.
- 10 languages: en, ja, zh-CN, zh-TW, ko, es, fr, de, pt, ru. UI text, date formatting, fonts, and LLM output all localized.
- SEO + archive: OG images, JSON-LD, sitemaps, RSS feeds, canonical URLs. All past reports preserved with weekly archive URLs.
What You Need
Two things to prepare before running setup.
- GitHub PAT: a personal access token to read your activity across all repositories. Fine-grained (create) or classic with
repo + workflow scopes (create).
- LLM API key: from any supported provider. Free tiers available from OpenRouter, Groq, and Google Gemini. Paid providers: OpenAI, Anthropic, Grok.
Quick Start
One command sets up everything: repository, workflows, secrets, and GitHub Pages.
npx github-weekly-reporter setup
The setup command walks you through interactively. Your first report will be live within 5 minutes.
See manual setup for full control.
Themes
Three built-in themes, each with light/dark mode and responsive layout.
-
Bold, high-contrast dark theme with monospace typography and raw geometric layout. Self-contained HTML with no JavaScript. The default theme.
-
Clean lines, generous whitespace, and understated elegance. Light and dark modes with smooth transitions. Designed for readability.
-
Horizontal-scroll magazine layout inspired by print editorial design. Serif typography (Playfair Display + Newsreader), column-based content flow, and data visualizations woven into the narrative.
Profile Card
Embed an animated news ticker in your GitHub Profile README. AI writes the headlines.
Generated automatically with each weekly report. Headlines use dramatic, tongue-in-cheek labels like a TV news broadcast.
