Git Weekly Report Generator

Problem It Solves

Writing weekly reports often stalls on the basic question: what was actually done this week? Commits are scattered across Git repositories, while merge commits and CI-generated updates mix in, making manual review slow and easy to overstate. weekly-report focuses on this workflow: it extracts project-relevant work from local Git history and turns it into a structured Markdown report.

How It Works

• Confirms scope first: asks for the project or product name so weekly items are not mixed across unrelated initiatives.
• Collects the week’s commits: calculates the Monday-to-today window and uses git log with --since and --until to fetch relevant records.
• Filters noisy commits: merge commits, CI/CD version bumps, and auto-generated changelog entries are usually excluded.
• Produces readable items: groups related commits, keeps component/module names and functional details, and describes both what changed and what effect it had.
• Saves the result: writes a UTF-8 Markdown file named by the report date range.

Boundary

It depends on local repository paths and commit-message quality. If messages lack business context, the report can only reflect code changes and cannot infer product reasoning on its own. If no valid commits are found, it asks the user to confirm the date range instead of producing empty content.