{"id":35828760,"url":"https://github.com/btfranklin/release-notes-scribe","last_synced_at":"2026-01-25T09:01:38.696Z","repository":{"id":332413531,"uuid":"1129460570","full_name":"btfranklin/release-notes-scribe","owner":"btfranklin","description":"Generate polished draft GitHub release notes from tag diffs using the OpenAI Responses API","archived":false,"fork":false,"pushed_at":"2026-01-08T05:47:17.000Z","size":364,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-13T20:03:07.191Z","etag":null,"topics":["automation","changelog","devops","github-action","github-actions","llm","openai","release-notes","semver"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/btfranklin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-01-07T05:56:30.000Z","updated_at":"2026-01-08T05:47:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/btfranklin/release-notes-scribe","commit_stats":null,"previous_names":["btfranklin/release-notes-scribe"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/btfranklin/release-notes-scribe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btfranklin%2Frelease-notes-scribe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btfranklin%2Frelease-notes-scribe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btfranklin%2Frelease-notes-scribe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btfranklin%2Frelease-notes-scribe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/btfranklin","download_url":"https://codeload.github.com/btfranklin/release-notes-scribe/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btfranklin%2Frelease-notes-scribe/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28750627,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T09:00:19.176Z","status":"ssl_error","status_checked_at":"2026-01-25T09:00:04.131Z","response_time":113,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","changelog","devops","github-action","github-actions","llm","openai","release-notes","semver"],"created_at":"2026-01-07T21:15:35.271Z","updated_at":"2026-01-25T09:01:38.690Z","avatar_url":"https://github.com/btfranklin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Release Notes Scribe\n\n![Release Notes Scribe banner](https://raw.githubusercontent.com/btfranklin/release-notes-scribe/main/.github/social%20preview/release_notes_scribe_social_preview.jpg \"Release Notes Scribe\")\n[![Build Status](https://github.com/btfranklin/release-notes-scribe/actions/workflows/build.yml/badge.svg)](https://github.com/btfranklin/release-notes-scribe/actions/workflows/build.yml)\n\nGenerate draft GitHub release notes using the OpenAI Responses API, based on the commit messages and diffs between tags.\n\n## How it works\n\n- Triggered by a tag push (recommended).\n- Finds the previous tag and gathers commits in the range.\n- Builds a structured prompt with commit messages + diff lines.\n- Calls the OpenAI Responses API (model configurable, default `gpt-5.2`).\n- Creates a **draft** GitHub Release with the generated notes.\n\n## Example workflow\n\n```yaml\nname: Draft Release Notes\n\non:\n  push:\n    tags:\n      - \"v*.*.*\"\n\npermissions:\n  contents: write\n\njobs:\n  draft-release:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v6.0.1\n        with:\n          fetch-depth: 0\n      - name: Generate release notes\n        uses: btfranklin/release-notes-scribe@v0\n        with:\n          openai_api_key: ${{ secrets.OPENAI_API_KEY }}\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          include_github_generated_notes: \"true\"\n```\n\n## Inputs\n\n- `openai_api_key` (required): API key for an OpenAI-compatible provider.\n- `openai_base_url`: Optional base URL for OpenAI-compatible providers.\n- `model`: Model name (must support Responses API). Default: `gpt-5.2`.\n- `github_token`: Token with `contents:write` permission. Defaults to `GITHUB_TOKEN` env var.\n- `tag`: Override tag. Defaults to the tag that triggered the workflow.\n- `previous_tag`: Override previous tag for comparison.\n- `include_github_generated_notes`: Add GitHub-generated notes as extra context. Default: `false`.\n- `max_diff_lines`: Max diff lines per commit in prompt. Default: `120`.\n- `max_commits`: Max commits to include. Default: `200`.\n- `max_stage_chars`: Max characters per summarization stage (approx 4 chars/token). Default: `400000`.\n- `source_extensions`: Comma/space-separated list of source code extensions to include diffs for. Non-source files are filename-only. Default: built-in language list.\n- `draft`: Create the release as a draft. Default: `true`.\n- `prerelease`: Mark release as prerelease. Default: `false`.\n- `release_name`: Override release title. Defaults to the tag.\n\n## Outputs\n\n- `release_notes`: Generated Markdown.\n- `release_url`: URL of the created release.\n\n## Notes\n\n- Ensure `actions/checkout` uses `fetch-depth: 0` so tags are available.\n- Shallow clones will warn and can block tag discovery.\n- If no previous tag is found, the action compares against the empty tree.\n- For tag-triggered workflows, prefer `v*.*.*` so moving major tags like `v1` don't trigger runs.\n- Large releases are summarized in multiple stages to stay within prompt limits.\n\n## Testing\n\n```bash\nnpm install\nnpm test\n```\n\n## Release\n\n```bash\nnpm run release -- v0.1.0\n```\n\nOptional moving tag update:\n\n```bash\nnpm run release -- v0.1.0 --move-major-tag\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtfranklin%2Frelease-notes-scribe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbtfranklin%2Frelease-notes-scribe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtfranklin%2Frelease-notes-scribe/lists"}