Skip to content

feat(cli): generate release notes in ~3 minutes (opt-in)#1048

Closed
harish-garg wants to merge 2 commits intoPreTeXtBook:mainfrom
harish-garg:chore/cli-release-notes
Closed

feat(cli): generate release notes in ~3 minutes (opt-in)#1048
harish-garg wants to merge 2 commits intoPreTeXtBook:mainfrom
harish-garg:chore/cli-release-notes

Conversation

@harish-garg
Copy link
Copy Markdown

This adds a small, safe-by-default CLI to generate release notes from merged commits/tags.

  • Runs locally; no secrets; no network by default
  • Works without any LLMs; optional --llm polish via OpenAI-compatible endpoints
  • Artifact-only: creates a Markdown file, never commits changes

Quick start:

python3 scripts/release_notes.py --last-tag > RELEASE_NOTES.md
# or pick a range:
python3 scripts/release_notes.py --since vX.Y.Z > RELEASE_NOTES.md

Why:

Release prep often takes ~30–45 minutes; this gets you to 2–3 minutes and is CI-friendly

Keeps human review as the default; easy rollback (artifact only)

If this is useful, I can also wire a GitHub Action that runs this on PRs and attaches the notes as an artifact, plus add guardrails/evals.

@harish-garg
Copy link
Copy Markdown
Author

This is opt-in and artifact-only; happy to move it to a different folder if you prefer.

If useful, I can open a follow-up PR with a small GitHub Action that runs on pull_request and uploads RELEASE_NOTES.md as an artifact (no change to your release process).

@oscarlevin
Copy link
Copy Markdown
Member

Thanks for this contribution. Since this package includes releases from the core pretext library, I will need to think about whether this sort of tool is worth it. Either way, I appreciate the time you spent on it.

@oscarlevin oscarlevin closed this Aug 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants