diff --git a/scripts/generate-newsletter.py b/scripts/generate-newsletter.py index b52785c91..3378ed8fe 100755 --- a/scripts/generate-newsletter.py +++ b/scripts/generate-newsletter.py @@ -12,6 +12,11 @@ """ Generate a weekly Beads newsletter based on changelog, commits, and changes. +Requirements: + git >= 2.37 - get_commits_since() passes --since-as-filter to git log + (added in git 2.37, 2022-06). On older git the script + raises rather than silently reporting an empty range. + Usage: python generate-newsletter.py python generate-newsletter.py --model gpt-4o @@ -154,13 +159,41 @@ def get_previous_version() -> tuple[str, datetime]: def get_commits_since(since_date: datetime) -> list[dict]: - """Get git commits since the given date.""" + """Get git commits since the given date. + + Two things below are deliberate, and both of them were bugs whose failure + direction is silent-and-shorter: the newsletter comes out missing commits + and nothing about it looks wrong. + + THE TIMESTAMP IS WRITTEN OUT IN FULL because `--since` takes an + APPROXIDATE, and a bare `2026-09-10` does not mean the start of that day -- + it means that day at the CURRENT TIME OF DAY. Measured on this tree at + 17:02 local, `git log --since=2026-09-10` returned 0 commits where + `--since=2026-09-10T00:00:00` returned 60. Every commit made before the + hour the script happens to run is dropped, so the same command answers + differently depending on when it is invoked. + + `--since-as-filter` IS NOT A TYPO. Plain `--since` is a traversal CUTOFF: + git stops walking the moment it meets a commit older than the bound, so any + commit whose date is out of order with its topology -- rebase, cherry-pick, + imported history, clock skew between machines -- is dropped even though it + is inside the range. `--since-as-filter` (git 2.37+) walks the whole + history and filters, which is what a date range is supposed to mean. + + Do not "simplify" either one back. (igr/fable, 2026-09-10.) + """ + since_arg = since_date.strftime('%Y-%m-%dT%H:%M:%S') result = subprocess.run( - ["git", "log", f"--since={since_date.strftime('%Y-%m-%d')}", "--oneline", "--format=%h|%s|%an|%ai"], + ["git", "log", f"--since-as-filter={since_arg}", "--oneline", "--format=%h|%s|%an|%ai"], capture_output=True, text=True ) - + if result.returncode != 0: + raise RuntimeError( + "git log failed (--since-as-filter needs git >= 2.37): " + f"{result.stderr.strip()}" + ) + commits = [] for line in result.stdout.strip().split('\n'): if line: diff --git a/scripts/generate-newsletter_README.md b/scripts/generate-newsletter_README.md index 3b8161b7f..50a663482 100644 --- a/scripts/generate-newsletter_README.md +++ b/scripts/generate-newsletter_README.md @@ -4,6 +4,13 @@ This script generates a weekly Beads newsletter based on the changelog, git comm ## Setup +### Requirements + +- **git >= 2.37** (2022-06). The commit range is collected with `git log + --since-as-filter`, which older git does not support. On older git the script + fails with `git log failed (--since-as-filter needs git >= 2.37): ...` instead + of generating a newsletter that silently omits commits. + ### Environment Variables Set the appropriate API key for your chosen model: