docs(cli): add release notes generation prompt#5330
Draft
avallete wants to merge 2 commits into
Draft
Conversation
Adds a prompt template at tools/release/release-notes-prompt.md for rewriting semantic-release output into user-centric GitHub Release notes. Pre-fills supabase/cli inputs, scopes user-facing reporting to the legacy shell, and folds Go-to-TS port PRs into a short port-progress section so they don't masquerade as user-visible features or fixes.
Adds a propose -> review -> apply pipeline so stable releases get notes rewritten from the raw semantic-release block into user-centric prose without blocking distribution. New pieces: - `apps/cli/scripts/propose-release-notes.ts` re-derives the raw notes, inlines them into `tools/release/release-notes-prompt.md`, runs the Claude Agent SDK with WebFetch/Bash, and opens a PR adding `release-notes/v<VERSION>.md`. Supports `--render-only` for prompt iteration without an LLM call. - `apps/cli/scripts/apply-release-notes.ts` pushes a `release-notes/` file to the GitHub Release body via `gh release edit`. - `.github/workflows/propose-release-notes.yml` (reusable) wraps the proposer; non-blocking so an LLM hiccup never gates a published release. Stable releases only. - `.github/workflows/apply-release-notes.yml` triggers on merged PRs touching `release-notes/**` and applies each touched file. - `release-shared.yml` calls the proposer after `backfill-release-notes` succeeds.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a comprehensive prompt template for generating user-centric release notes for Supabase CLI releases using an LLM.
This document provides:
next/shell changes, handling Go-to-TypeScript port PRs, and identifying user-facing changesThe prompt is designed to be pasted into an LLM along with a semantic-release changelog block, producing release notes that answer three key questions for users: "Should I upgrade?", "What can I do now?", and "What gotchas should I know about?"
This replaces the need for manual release note writing and ensures consistency across CLI releases.
https://claude.ai/code/session_01FgZaMWUbVrQaQUFRv9KKYn