https://github.com/deariary/github-weekly-reporter
GitHub Action that generates a beautiful weekly activity report on GitHub Pages.
https://github.com/deariary/github-weekly-reporter
ai cli developer-tools github-action github-actions github-activity github-pages github-weekly-reporter llm typescript weekly-report
Last synced: 16 days ago
JSON representation
GitHub Action that generates a beautiful weekly activity report on GitHub Pages.
- Host: GitHub
- URL: https://github.com/deariary/github-weekly-reporter
- Owner: deariary
- License: other
- Created: 2026-04-03T14:09:46.000Z (23 days ago)
- Default Branch: main
- Last Pushed: 2026-04-07T23:18:17.000Z (19 days ago)
- Last Synced: 2026-04-08T11:04:21.317Z (18 days ago)
- Topics: ai, cli, developer-tools, github-action, github-actions, github-activity, github-pages, github-weekly-reporter, llm, typescript, weekly-report
- Language: TypeScript
- Homepage: https://deariary.github.io/github-weekly-reporter/
- Size: 68.4 MB
- Stars: 15
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Agents: AGENTS.md
Awesome Lists containing this project
README
# GitHub Weekly Reporter
**Your GitHub activity, turned into a beautiful weekly report. Automatically.**
Every week, this tool looks at everything you did on GitHub (commits, pull requests, code reviews) and generates a polished, shareable report page with AI-written summaries. It runs as a GitHub Action, deploys to GitHub Pages, and costs nothing.
One command to set up. Zero maintenance after that.
```bash
npx github-weekly-reporter setup
```
[See a live example](https://unhappychoice.github.io/weekly-report/)
## Prerequisites
Before running setup, have these ready:
1. **GitHub fine-grained PAT** with `All repositories` access and these permissions (all Read & Write):
`Administration`, `Contents`, `Actions`, `Secrets`, `Pages`, `Workflows`
([Create one](https://github.com/settings/personal-access-tokens/new))
2. **LLM API key** from one of the supported providers.
| Provider | Free Tier | Get API Key |
|---|---|---|
| OpenRouter | Yes | https://openrouter.ai/settings/keys |
| Groq | Yes | https://console.groq.com/keys |
| Google Gemini | Yes | https://aistudio.google.com/apikey |
| OpenAI | No | https://platform.openai.com/api-keys |
| Anthropic | No | https://console.anthropic.com/settings/keys |
| Grok (xAI) | No | https://console.x.ai |
3. **LLM model name** for your chosen provider:
| Provider | Models |
|---|---|
| OpenRouter | https://openrouter.ai/models |
| Groq | https://console.groq.com/docs/models |
| Google Gemini | https://ai.google.dev/gemini-api/docs/models |
| OpenAI | https://platform.openai.com/docs/models |
| Anthropic | https://docs.anthropic.com/en/docs/about-claude/models |
| Grok (xAI) | https://docs.x.ai/docs/models |
## Quick Start
```bash
npx github-weekly-reporter setup
```
The setup command will walk you through everything:
- Creates a repository
- Adds workflow files (daily fetch + weekly report)
- Configures secrets (PAT and LLM API key)
- Enables GitHub Pages
- Triggers your first weekly report
See [Manual Setup](docs/manual-setup.md) if you prefer to configure everything yourself.
## Features
- Weekly stats: commits, PRs opened/merged, issues, reviews
- Top repositories by activity
- Language breakdown (CSS-only chart)
- 7-day contribution heatmap
- AI-generated narrative summary (6 providers, free tiers available)
- Dark theme with responsive design
- Self-contained HTML (no external requests, no JavaScript required)
- SEO optimized (OG images, JSON-LD, sitemap)
- Deploys to GitHub Pages with weekly archive
- Internationalization (10 languages)
## LLM Providers
AI narratives are required for report generation. Six providers are supported, including free tiers:
| Provider | Free Tier | Env Variable |
|---|---|---|
| **OpenRouter** | Yes (25+ free models) | `OPENROUTER_API_KEY` |
| **Groq** | Yes (generous) | `GROQ_API_KEY` |
| **Google Gemini** | Yes | `GEMINI_API_KEY` |
| OpenAI | No | `OPENAI_API_KEY` |
| Anthropic | No | `ANTHROPIC_API_KEY` |
| Grok (xAI) | No | `GROK_API_KEY` |
OpenRouter and Groq are recommended for free usage. Both offer high-quality models at no cost. For model selection, see each provider's documentation:
- OpenRouter: https://openrouter.ai/models
- Groq: https://console.groq.com/docs/models
- Gemini: https://ai.google.dev/gemini-api/docs/models
- OpenAI: https://platform.openai.com/docs/models
- Anthropic: https://docs.anthropic.com/en/docs/about-claude/models
- Grok: https://docs.x.ai/docs/models
If the LLM call fails, the workflow will stop with an error. Make sure your API key and model name are correct.
## Generating a Report Manually
After setup, daily fetches run automatically. To generate a weekly report anytime:
1. Go to your repository's **Actions** tab
2. Click **Weekly Report**
3. Click **Run workflow**
The report will be built and deployed to GitHub Pages within a few minutes.
## Supported Languages
| Code | Language |
|---|---|
| `en` | English |
| `ja` | Japanese |
| `zh-CN` | Chinese (Simplified) |
| `zh-TW` | Chinese (Traditional) |
| `ko` | Korean |
| `es` | Spanish |
| `fr` | French |
| `de` | German |
| `pt` | Portuguese |
| `ru` | Russian |
## Documentation
- [Manual Setup](docs/manual-setup.md) - step-by-step guide without the setup command
- [CLI Reference](docs/cli-reference.md) - all commands and environment variables
## URL Structure
Reports are archived by ISO week:
```
https://.github.io// # Index page (links to all reports)
https://.github.io//2026/W14/ # Weekly report
https://.github.io//2026/W13/ # Previous week
```
## License
See [LICENSE](./LICENSE) for details.
- Commercial use: "Powered by deariary" footer link must be retained
- Personal/non-commercial use: footer link may be removed
- Derivative works: same conditions apply