stroepwafel/AI Release Notes Generator

Generate release notes using AI based on code changes since the previous release

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
groq_api_keyGroq API key for AI generationyes
tag_nameTag name for the releaseyes
release_nameName of the release (defaults to tag_name)no
draftCreate as draft releasenofalse
prereleaseCreate as prereleasenofalse
modelGroq model to use (default: openai/gpt-oss-120b)noopenai/gpt-oss-120b
previous_tagPrevious tag to compare against (defaults to latest tag)no
filesComma-separated list of files to attach to releaseno
body_templateOptional template for release notes structureno
max_tokensMax AI completion tokens (default 8000). Prevents output truncation.no8000
diff_limitMax diff lines sent to AI (default 120). Higher = more depth but may exceed Groq token limits.no120
commits_limitMax commit messages sent to AI (default 60). Higher = more context.no60
detail_levelShortcut for depth: brief, standard, or detailednostandard
compatibilityOptional. e.g. "Node 18+, Python 3.10+". Placed in Compatibility field.no
show_diff_sectionAppend diff section at bottom of release notes (default false)nofalse
diff_section_limitMax lines of inline diff in release body (default 500)no500
summarizer_modelModel for per-file summarization in two-stage mode. If empty, uses same as model.no
two_stage_char_limitUse two-stage summarization when diff is under this size in chars (default 40000). Set 0 to disable.no40000
prompt_appendOptional text appended to the user prompt. Use for custom instructions (e.g. tone, audience, extra context).no
system_appendOptional text appended to the system prompt. Use for custom behavior or constraints.no
notes_styleRelease notes format: github (default) or desqta (emoji headers, categorized sections)nogithub
product_nameProduct name for DesQTA-style title (defaults to repo name)no
plain_languageUse simple, jargon-free language that the average person can understand (default false)nofalse
namedescription
release_idThe ID of the created release
release_urlThe URL of the created release
release_notesThe generated release notes