{"id":47928329,"url":"https://github.com/deariary/github-weekly-reporter","last_synced_at":"2026-04-10T13:00:58.913Z","repository":{"id":348970641,"uuid":"1200521260","full_name":"deariary/github-weekly-reporter","owner":"deariary","description":"GitHub Action that generates a beautiful weekly activity report on GitHub Pages.","archived":false,"fork":false,"pushed_at":"2026-04-07T23:18:17.000Z","size":71718,"stargazers_count":15,"open_issues_count":1,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-08T11:04:21.317Z","etag":null,"topics":["ai","cli","developer-tools","github-action","github-actions","github-activity","github-pages","github-weekly-reporter","llm","typescript","weekly-report"],"latest_commit_sha":null,"homepage":"https://deariary.github.io/github-weekly-reporter/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deariary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-04-03T14:09:46.000Z","updated_at":"2026-04-07T23:18:21.000Z","dependencies_parsed_at":"2026-04-08T11:01:42.257Z","dependency_job_id":null,"html_url":"https://github.com/deariary/github-weekly-reporter","commit_stats":null,"previous_names":["deariary/github-weekly-reporter"],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/deariary/github-weekly-reporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deariary%2Fgithub-weekly-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deariary%2Fgithub-weekly-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deariary%2Fgithub-weekly-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deariary%2Fgithub-weekly-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deariary","download_url":"https://codeload.github.com/deariary/github-weekly-reporter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deariary%2Fgithub-weekly-reporter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31643431,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T07:40:12.752Z","status":"ssl_error","status_checked_at":"2026-04-10T07:40:11.664Z","response_time":98,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","cli","developer-tools","github-action","github-actions","github-activity","github-pages","github-weekly-reporter","llm","typescript","weekly-report"],"created_at":"2026-04-04T07:03:02.550Z","updated_at":"2026-04-10T13:00:58.843Z","avatar_url":"https://github.com/deariary.png","language":"TypeScript","readme":"# GitHub Weekly Reporter\n\n**Your GitHub activity, turned into a beautiful weekly report. Automatically.**\n\nEvery 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.\n\nOne command to set up. Zero maintenance after that.\n\n```bash\nnpx github-weekly-reporter setup\n```\n\n[See a live example](https://unhappychoice.github.io/weekly-report/)\n\n## Prerequisites\n\nBefore running setup, have these ready:\n\n1. **GitHub fine-grained PAT** with `All repositories` access and these permissions (all Read \u0026 Write):\n   `Administration`, `Contents`, `Actions`, `Secrets`, `Pages`, `Workflows`\n   ([Create one](https://github.com/settings/personal-access-tokens/new))\n\n2. **LLM API key** from one of the supported providers.\n   | Provider | Free Tier | Get API Key |\n   |---|---|---|\n   | OpenRouter | Yes | https://openrouter.ai/settings/keys |\n   | Groq | Yes | https://console.groq.com/keys |\n   | Google Gemini | Yes | https://aistudio.google.com/apikey |\n   | OpenAI | No | https://platform.openai.com/api-keys |\n   | Anthropic | No | https://console.anthropic.com/settings/keys |\n   | Grok (xAI) | No | https://console.x.ai |\n\n3. **LLM model name** for your chosen provider:\n\n   | Provider | Models |\n   |---|---|\n   | OpenRouter | https://openrouter.ai/models |\n   | Groq | https://console.groq.com/docs/models |\n   | Google Gemini | https://ai.google.dev/gemini-api/docs/models |\n   | OpenAI | https://platform.openai.com/docs/models |\n   | Anthropic | https://docs.anthropic.com/en/docs/about-claude/models |\n   | Grok (xAI) | https://docs.x.ai/docs/models |\n\n## Quick Start\n\n```bash\nnpx github-weekly-reporter setup\n```\n\nThe setup command will walk you through everything:\n- Creates a repository\n- Adds workflow files (daily fetch + weekly report)\n- Configures secrets (PAT and LLM API key)\n- Enables GitHub Pages\n- Triggers your first weekly report\n\nSee [Manual Setup](docs/manual-setup.md) if you prefer to configure everything yourself.\n\n## Features\n\n- Weekly stats: commits, PRs opened/merged, issues, reviews\n- Top repositories by activity\n- Language breakdown (CSS-only chart)\n- 7-day contribution heatmap\n- AI-generated narrative summary (6 providers, free tiers available)\n- Dark theme with responsive design\n- Self-contained HTML (no external requests, no JavaScript required)\n- SEO optimized (OG images, JSON-LD, sitemap)\n- Deploys to GitHub Pages with weekly archive\n- Internationalization (10 languages)\n\n## LLM Providers\n\nAI narratives are required for report generation. Six providers are supported, including free tiers:\n\n| Provider | Free Tier | Env Variable |\n|---|---|---|\n| **OpenRouter** | Yes (25+ free models) | `OPENROUTER_API_KEY` |\n| **Groq** | Yes (generous) | `GROQ_API_KEY` |\n| **Google Gemini** | Yes | `GEMINI_API_KEY` |\n| OpenAI | No | `OPENAI_API_KEY` |\n| Anthropic | No | `ANTHROPIC_API_KEY` |\n| Grok (xAI) | No | `GROK_API_KEY` |\n\nOpenRouter and Groq are recommended for free usage. Both offer high-quality models at no cost. For model selection, see each provider's documentation:\n\n- OpenRouter: https://openrouter.ai/models\n- Groq: https://console.groq.com/docs/models\n- Gemini: https://ai.google.dev/gemini-api/docs/models\n- OpenAI: https://platform.openai.com/docs/models\n- Anthropic: https://docs.anthropic.com/en/docs/about-claude/models\n- Grok: https://docs.x.ai/docs/models\n\nIf the LLM call fails, the workflow will stop with an error. Make sure your API key and model name are correct.\n\n## Generating a Report Manually\n\nAfter setup, daily fetches run automatically. To generate a weekly report anytime:\n\n1. Go to your repository's **Actions** tab\n2. Click **Weekly Report**\n3. Click **Run workflow**\n\nThe report will be built and deployed to GitHub Pages within a few minutes.\n\n## Supported Languages\n\n| Code | Language |\n|---|---|\n| `en` | English |\n| `ja` | Japanese |\n| `zh-CN` | Chinese (Simplified) |\n| `zh-TW` | Chinese (Traditional) |\n| `ko` | Korean |\n| `es` | Spanish |\n| `fr` | French |\n| `de` | German |\n| `pt` | Portuguese |\n| `ru` | Russian |\n\n## Documentation\n\n- [Manual Setup](docs/manual-setup.md) - step-by-step guide without the setup command\n- [CLI Reference](docs/cli-reference.md) - all commands and environment variables\n\n## URL Structure\n\nReports are archived by ISO week:\n\n```\nhttps://\u003cuser\u003e.github.io/\u003crepo\u003e/           # Index page (links to all reports)\nhttps://\u003cuser\u003e.github.io/\u003crepo\u003e/2026/W14/  # Weekly report\nhttps://\u003cuser\u003e.github.io/\u003crepo\u003e/2026/W13/  # Previous week\n```\n\n## License\n\nSee [LICENSE](./LICENSE) for details.\n\n- Commercial use: \"Powered by deariary\" footer link must be retained\n- Personal/non-commercial use: footer link may be removed\n- Derivative works: same conditions apply\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeariary%2Fgithub-weekly-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeariary%2Fgithub-weekly-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeariary%2Fgithub-weekly-reporter/lists"}