|
| 1 | +# Copilot Playbook: Elsa Studio Release Notes (GitHub Release + PR/commit links) |
| 2 | + |
| 3 | +## Goal |
| 4 | +Generate consistent GitHub Release notes for `elsa-workflows/elsa-studio` between two tags/refs, including: |
| 5 | +- a short **Highlights** section up top |
| 6 | +- standard grouped sections (Breaking/Features/Improvements/Fixes/Tests/CI) |
| 7 | +- **GitHub-style** PR/commit references at the end of bullets: `(#1234)` or `(abcd123)` |
| 8 | +- a short **Full changelog** section (one line per commit/PR) |
| 9 | +- optional **Known issues** section when applicable |
| 10 | + |
| 11 | +## Inputs to provide (required) |
| 12 | +- Repository: `elsa-workflows/elsa-studio` |
| 13 | +- From tag/ref: `<FROM>` |
| 14 | +- To tag/ref: `<TO>` |
| 15 | + |
| 16 | +Also provide ONE of: |
| 17 | +- `git log --oneline <FROM>..<TO>` output (preferred), OR |
| 18 | +- compare URL: `https://github.com/elsa-workflows/elsa-studio/compare/<FROM>...<TO>` |
| 19 | + |
| 20 | +Optionally provide: |
| 21 | +- whether merges are squash (often include `(#NNNN)` in subject) vs merge commits |
| 22 | +- any release-specific callouts you want forced into Highlights / Known issues |
| 23 | + |
| 24 | +## Output format (required) |
| 25 | +- Return a single Markdown file using a four-backtick fenced block: |
| 26 | + - filename: `release-notes-<TO>.md` (or `release-notes-<version>.md`) |
| 27 | +- Use this section order and headings exactly: |
| 28 | + |
| 29 | +1. Title and compare range |
| 30 | +2. `### 🌟 Highlights` |
| 31 | +3. `### ⚠️ Breaking changes / upgrade notes` |
| 32 | +4. `### ✨ New features` |
| 33 | +5. `### 🔧 Improvements` |
| 34 | +6. `### 🐛 Fixes` |
| 35 | +7. `### 🧩 Developer-facing changes` (omit if none) |
| 36 | +8. `### 🧪 Tests` (omit if none) |
| 37 | +9. `### 🔁 CI / Build` (omit if none) |
| 38 | +10. `### 🧭 Known issues` (omit if none provided/known) |
| 39 | +11. `### 📦 Full changelog (short)` |
| 40 | + |
| 41 | +## Link style rules |
| 42 | +- Prefer PR number if available: end bullet with `(#NNNN)` |
| 43 | +- If no PR association: end bullet with `(abcd123)` short SHA (7–12 chars) |
| 44 | +- If multiple relevant PRs/commits: include multiple suffixes, e.g. `(#7172) (abcd123)` |
| 45 | + |
| 46 | +Never invent PR numbers. Only use what is present in commit subjects, merge commits, or explicitly provided. |
| 47 | + |
| 48 | +## PR title vs commit subject convention (new) |
| 49 | +- If a PR number is available, prefer **PR title wording** over commit subject wording **when you have the PR title**. |
| 50 | +- If PR titles are not available (e.g., only `git log` output), use commit subjects as-is. |
| 51 | +- If you *do* have PR titles and they differ significantly from commit subjects: |
| 52 | + - use the PR title in the release note bullet |
| 53 | + - keep “Full changelog (short)” as the raw commit subjects (or PR titles if you have them consistently) |
| 54 | + |
| 55 | +(If you want PR-title-first release notes, provide a list of PR URLs/titles or enable an API-derived PR list in the session.) |
| 56 | + |
| 57 | +## Highlights convention (new) |
| 58 | +- 3–6 bullets max |
| 59 | +- Must be user-facing and high-signal: |
| 60 | + - new capabilities |
| 61 | + - resilience / reliability improvements |
| 62 | + - important defaults/behavior changes |
| 63 | +- Each highlight bullet should still end with `(#NNNN)` / `(sha)`. |
| 64 | + |
| 65 | +## Known issues convention (new) |
| 66 | +Only include if the user provides known issues or you can clearly infer them from the provided material (avoid guessing). |
| 67 | +Each entry should include: |
| 68 | +- symptom (what breaks) |
| 69 | +- workaround (if known) |
| 70 | +- reference suffix `(#NNNN)` / `(sha)` if applicable |
| 71 | + |
| 72 | +If none are provided, omit the section entirely. |
| 73 | + |
| 74 | +## How to build the content (process) |
| 75 | +1. Parse the provided commit list into an ordered changelog. |
| 76 | +2. Extract PR numbers from subjects: |
| 77 | + - `(#7174)` at end of subject |
| 78 | + - `Merge pull request #7157 ...` |
| 79 | +3. Group changes into sections: |
| 80 | + - Breaking: API changes, package swaps, SDK/toolchain, serialization model changes |
| 81 | + - Features: new APIs/modules/capabilities |
| 82 | + - Improvements: performance, resilience, refactors that improve behavior |
| 83 | + - Fixes: correctness, bugs |
| 84 | + - Developer-facing: attributes, extension points, new hooks/contracts |
| 85 | + - Tests: new test projects, new coverage, determinism fixes |
| 86 | + - CI/Build: workflow changes, branch triggers, packaging/versioning |
| 87 | +4. Produce concise bullets: |
| 88 | + - Start with an action verb (“Added”, “Introduced”, “Fixed”, “Improved”, “Updated”, “Removed”) |
| 89 | + - One idea per bullet |
| 90 | + - Add details as sub-bullets only when necessary (max 2 levels) |
| 91 | + - Append PR/commit suffix at end |
| 92 | +5. Generate **Highlights** by selecting the top 3–6 bullets across all sections (no duplicates). |
| 93 | +6. Add **Full changelog (short)**: |
| 94 | + - include every commit line from the provided input range, in the same order |
| 95 | + - each line should include PR number if present; otherwise SHA |
| 96 | + |
| 97 | +## Consistency checks before finalizing |
| 98 | +- Compare range line present: `Compare: <FROM>...<TO>` |
| 99 | +- Highlights present (3–6 bullets) |
| 100 | +- Every bullet has suffix `(#NNNN)` or `(sha)` where available |
| 101 | +- No PR numbers are guessed |
| 102 | +- Full changelog includes all commits provided |
| 103 | +- Optional sections (Developer-facing / Tests / CI / Known issues) are omitted if empty |
| 104 | + |
| 105 | +## Example prompt for a new session |
| 106 | +“Generate GitHub Release notes for `elsa-workflows/elsa-studio` from `<FROM>` to `<TO>`. Use the template with **Highlights** and **Known issues** (only if I provide them). Prefer PR titles when available, otherwise use commit subjects. Use GitHub-style `(#NNNN)` references and include a short Full changelog. Here is `git log --oneline <FROM>..<TO>`: …” |
0 commit comments