What problem does it solve?
It saves teams from manually writing weekly status updates by automatically collecting recent shipping activity (commits, merged PRs, releases, and closed issues) and turning it into a narrative shiplog article.
Core Features & Use Cases
- Weekly shipping narrative generation: Creates either a full or short “Week in Review” article based on the volume and substance of recent changes.
- Theme-filtered updates: Optionally narrows the shiplog to a specific topic by matching commit/PR messages and changed file paths against a provided theme.
- Idempotent daily output: Writes at most one shiplog per day and avoids duplicate runs by checking for an existing article.
- Source-backed reporting: Grounds every concrete claim with exact
(sha) and (#PR) references derived from GitHub API data.
Quick Start
Run weekly-shiplog with the optional theme filter so the update focuses on the topic you care about.