arslanym/MergeDoc AI

AI-powered release documentation — generates categorized changelog entries from merged PR diffs.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Apr 11, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: arslanym/mergedoc@b95c2955449cdb2242acd0c039115f2e81582524 # v1.2.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
github_tokenGitHub token with 'contents: write' and 'pull-requests: read' permissions. Typically passed as 'secrets.GITHUB_TOKEN'. yes
llm_api_keyAPI key for the LLM provider (OpenRouter, Gemini, Anthropic, or OpenAI). For the free tier, get an OpenRouter key at https://openrouter.ai/settings/keys Store this as a repository secret. yes
llm_providerLLM provider to use. Supported values: 'auto' (detects from key format), 'openrouter' (free models available), 'gemini', 'anthropic', 'openai'. When set to 'auto', it looks at your API key prefix (sk-or- = OpenRouter, sk-ant- = Anthropic, sk- = OpenAI, otherwise Gemini). noauto
model_nameModel identifier to use for generation. Defaults to 'openrouter/auto' (free, auto-selected), 'gemini-2.0-flash', 'claude-sonnet-4-20250514' for Anthropic, or 'gpt-4o' for OpenAI. no""
max_diff_tokensMaximum token budget for the diff context sent to the LLM. Diffs exceeding this will be chunked and summarized via map-reduce. no80000
changelog_pathRelative path to the CHANGELOG.md file from the repository root. noCHANGELOG.md
excluded_filesComma-separated glob patterns for files to exclude from diff analysis. Binary files, lockfiles, and generated code are excluded by default. nopackage-lock.json,yarn.lock,pnpm-lock.yaml,*.generated.*,*.min.js,*.min.css
namedescription
release_notesThe generated release notes in Markdown format.
changelog_updatedWhether the CHANGELOG.md file was modified ('true' or 'false').
files_analyzedNumber of diff files that were sent to the LLM for analysis.