Releases: wardsvelds2l/pr-summary
Releases · wardsvelds2l/pr-summary
Release list
v0.2.0 — Production-grade release
v0.2.0 — Production-grade release
This release promotes pr-summary from a working-but-rough internal action to a production-grade GitHub Action ready for marketplace distribution and npm publishing.
Highlights
- Repository hygiene: full
CONTRIBUTING.md(dev setup, DCO, dist-rebuild rules),CODE_OF_CONDUCT.md(Contributor Covenant v2.1),SECURITY.md(GitHub Advisories only),.editorconfig,.gitattributes(locksdist/as generated, normalises to LF),dependabot.yml(npm + github-actions, grouped minor/patch),FUNDING.yml, bug / feature issue templates, and a PR template. - Multi-Node CI matrix (
18,20,22) on Linux, macOS, and Windows, with codecov upload and a dedicateddist-syncjob that fails the build ifdist/index.jsis out of sync withsrc/. - Release-please workflow for automated conventional-commits → release PR → tag → GitHub Release pipeline.
- npm publish workflow with
--provenanceandaccess=public. Uses theNPM_TOKENsecret (must be added by the repo admin before the first release). - Polished README with badges, comparison table, cost & performance benchmarks, ASCII architecture diagram, idempotency and chunking explanations, examples directory, security section, and roadmap.
- Examples directory with 5 ready-to-paste workflow YAMLs (minimal, detailed, multilingual, Anthropic-via-proxy, self-hosted LLMs) plus a real 8-file sample diff and a generated example comment (
npm run examples:comment). - OpenAI-compatible API: works with OpenAI, Azure, Groq, OpenRouter, Together, Ollama, LM Studio, llama.cpp, and Anthropic via LiteLLM/OpenRouter.
- 42 tests pass, 96.98 % line coverage on
src/,dist/index.jsis 1.94 MB CJS.
Action inputs (unchanged)
github-token, openai-api-key, openai-base-url, model, max-diff-chars, summary-style, language, trigger-event — all documented in action.yml and the README.
Outputs
comment-id, summary-length.
How to use
- uses: wardsvelds2l/pr-summary@v0
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
openai-api-key: ${{ secrets.OPENAI_API_KEY }}Required secrets for the new workflows
CODECOV_TOKEN(optional, for coverage badge) — the workflow tolerates its absence.NPM_TOKEN(required, for auto-publish to npm on the GitHub Release event) — generate at https://www.npmjs.com/settings/~/tokens with "Automation" type, then add as a repository secret.
Verification
npm run allpasses locally on Node 18, 20, 22 (CI matrix).npm run test:coveragereports 96.98 % line coverage.npm pack --dry-runships exactly 7 files:LICENSE,README.md,action.yml,dist/{index.js, index.js.map, sourcemap-register.js},package.json. No source, tests, or build configs.node -e "require('./dist/index.js')"loads the bundle without throwing.
See CONTRIBUTING.md for the development workflow and SECURITY.md for vulnerability reporting.