Skip to content

ci: fix release please notes setup #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThomasK33 merged 1 commit into from
Jun 28, 2026
+7 −2
Merged

ci: fix release please notes setup #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/release-please.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
GITHUB_TOKEN: ${{ github.token }}
GITHUB_REPOSITORY: ${{ github.repository }}
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
RELEASE_NOTES_MODEL: ${{ vars.RELEASE_NOTES_MODEL }}
RELEASE_NOTES_MODEL: ${{ vars.RELEASE_NOTES_MODEL || secrets.RELEASE_NOTES_MODEL }}
run: bun run release-please

- name: Dispatch publish workflow for stable release
Expand Down
1 change: 1 addition & 0 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ coverage/
.git/
.vite/
bun.lock
CHANGELOG.md
ghostty/
6 changes: 5 additions & 1 deletion docs/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Release Please owns the canonical changelog structure, commit sections, headings
The AI path uses an AI SDK `ToolLoopAgent` with scoped tools. It can list the release commits and inspect GitHub commit diffs for those SHAs before producing the structured editorial summary. The tools reject SHAs outside the current release scope.

- Configure `ANTHROPIC_API_KEY` as a repository secret to enable AI editorial notes.
- Configure `RELEASE_NOTES_MODEL` as a repository variable to choose the model.
- Configure `RELEASE_NOTES_MODEL` as a repository variable or secret to choose the model. The workflow reads the variable first and falls back to the secret for compatibility with secret-only setups.
- If either setting is missing or model generation fails, the runner logs the reason and falls back to default Release Please notes.

## Next publishes
Expand All @@ -31,6 +31,10 @@ The Release Please config intentionally uses the `prerelease` versioning strateg

When the pipeline has been test-driven successfully and maintainers are ready for a stable release, remove the prerelease settings from `release-please-config.json` so the next Release Please PR can promote to a normal `0.5.0` release.

## Formatting generated release notes

`CHANGELOG.md` is generated by Release Please and is intentionally excluded from Prettier checks. Release Please can emit markdown spacing that Prettier would rewrite, so excluding the generated changelog avoids failing CI on release PRs for formatting-only differences.

## Manual recovery

- Rerun `Release Please` on `main` to recreate or update a release PR.
Expand Down
Loading