Skip to content

Commit 9b7f5e1

Browse files
SteveSandersonMSCopilot
SteveSandersonMS
and
Copilot
committed
Add release changelog agentic workflow
Create an AI agent that automatically generates CHANGELOG.md entries when a stable (non-preview) release is published. The agent: - Triggers on release:published events (filtered to non-prerelease) - Reads merged PRs/commits between the new and previous stable tags - Generates categorized, bullet-pointed changelog entries - Opens a PR to update CHANGELOG.md via create-pull-request safe output - Updates the GitHub Release notes via update-release safe output - Posts an announcement Discussion for team visibility Also adds a seed CHANGELOG.md at the repo root. Note: The .lock.yml must be compiled via 'gh aw compile release-changelog' before this workflow will run in CI. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f843c80 commit 9b7f5e1

2 files changed

Lines changed: 151 additions & 0 deletions

File tree

‎.github/workflows/release-changelog.md‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
---
2+
description: Generates a changelog from merged PRs/commits when a stable release is published, and opens a PR to update CHANGELOG.md
3+
on:
4+
release:
5+
types: [published]
6+
workflow_dispatch:
7+
inputs:
8+
tag:
9+
description: "Release tag to generate changelog for (e.g., v0.1.30)"
10+
required: true
11+
type: string
12+
if: ${{ github.event.release.prerelease == false || github.event_name == 'workflow_dispatch' }}
13+
permissions:
14+
contents: read
15+
actions: read
16+
tools:
17+
github:
18+
toolsets: [default]
19+
edit:
20+
safe-outputs:
21+
create-pull-request:
22+
title-prefix: "[changelog] "
23+
labels: [automation, changelog]
24+
draft: false
25+
update-release:
26+
max: 1
27+
timeout-minutes: 15
28+
---
29+
30+
# Release Changelog Generator
31+
32+
You are an AI agent that generates a well-formatted changelog when a new stable release of the Copilot SDK is published. You update `CHANGELOG.md` in the repository and create a PR with the changes.
33+
34+
## Context
35+
36+
- Repository: ${{ github.repository }}
37+
- Release tag: ${{ github.event.release.tag_name || inputs.tag }}
38+
- Release name: ${{ github.event.release.name || inputs.tag }}
39+
- Release URL: ${{ github.event.release.html_url }}
40+
41+
## Your Task
42+
43+
### Step 1: Identify the version range
44+
45+
1. The **new version** is the release tag: `${{ github.event.release.tag_name || inputs.tag }}`
46+
2. Read `CHANGELOG.md` and find the **most recent version heading** (a line matching `## [vX.Y.Z](...)`). Extract that version tag — this is the last documented release.
47+
3. If `CHANGELOG.md` has no version entries yet, find the previous stable release by listing releases and picking the most recent non-prerelease release before this one. If none exist, use the first commit in the repo as the starting point.
48+
49+
### Step 2: Gather changes
50+
51+
1. Use the GitHub tools to list commits between the last documented tag (from Step 1) and the new release tag.
52+
2. Also list merged pull requests in that range. For each PR, note:
53+
- PR number and title
54+
- The PR author
55+
- Which SDK(s) were affected (look for prefixes like `[C#]`, `[Python]`, `[Go]`, `[Node]` in the title, or infer from changed files)
56+
3. Ignore:
57+
- Dependabot/bot PRs that only bump internal dependencies (like `Update @github/copilot to ...`) unless they bring user-facing changes
58+
- Merge commits with no meaningful content
59+
- Preview/prerelease-only changes that were already documented
60+
61+
### Step 3: Categorize and write up
62+
63+
Separate the changes into two groups:
64+
65+
1. **Highlighted features**: Any interesting new feature or significant improvement that deserves its own section with a description and code snippet(s). Read the PR diff and source code to understand the feature well enough to write about it.
66+
2. **Other changes**: Bug fixes, minor improvements, and smaller features that can be summarized in a single bullet each.
67+
68+
Only include changes that are **user-visible in the published SDK packages**. Skip anything that only affects docs, CI, build tooling, GitHub workflows, test infrastructure, or other internal-only concerns.
69+
70+
### Step 4: Update CHANGELOG.md
71+
72+
1. Read the current `CHANGELOG.md` file.
73+
2. Add the new version entry **at the top** of the file, right after the title/header.
74+
75+
**Format for each highlighted feature** — use an `### Feature:` or `### Fix:` heading, a 1-2 sentence description explaining what it does and why it matters, and at least one short code snippet (max 3 lines). Focus on **TypeScript** and **C#** as the primary languages. Only show Go/Python when giving a list of one-liner equivalents across all languages, or when their usage pattern is meaningfully different.
76+
77+
**Format for other changes** — a single `### Other changes` section with a flat bulleted list. Each bullet has a lowercase prefix (`feature:`, `bugfix:`, `improvement:`) and a one-line description linking to the PR.
78+
79+
3. Use today's date for the release date.
80+
4. Make sure the existing content below is preserved exactly as-is.
81+
82+
### Step 5: Create a Pull Request
83+
84+
Use the `create-pull-request` output to submit your changes. The PR should:
85+
- Have a clear title like "Add changelog for vX.Y.Z"
86+
- Include a brief body summarizing the number of changes
87+
88+
### Step 6: Update the GitHub Release
89+
90+
Use the `update-release` output to replace the auto-generated release notes with your nicely formatted changelog (same content you put in CHANGELOG.md, minus the header).
91+
92+
## Example Output
93+
94+
Here is an example of what a changelog entry should look like, based on real commits from this repo. **Follow this style exactly.**
95+
96+
````markdown
97+
## [v0.1.28](https://github.com/github/copilot-sdk/releases/tag/v0.1.28) (2026-02-14)
98+
99+
### Feature: support overriding built-in tools
100+
101+
Applications can now override built-in tools such as `edit` or `grep`. To do this, register a custom tool with the same name and set the override flag. ([#636](https://github.com/github/copilot-sdk/pull/636))
102+
103+
```ts
104+
session.defineTool("edit", { isOverride: true }, async (params) => {
105+
// custom edit implementation
106+
});
107+
```
108+
109+
```cs
110+
session.DefineTool("edit", new ToolOptions { IsOverride = true }, async (params) => {
111+
// custom edit implementation
112+
});
113+
```
114+
115+
### Feature: simpler API for changing model mid-session
116+
117+
While `session.rpc.models.setModel()` already worked, there is now a convenience method directly on the session object. ([#621](https://github.com/github/copilot-sdk/pull/621))
118+
119+
- TypeScript: `session.setModel("gpt-4o")`
120+
- C#: `session.SetModel("gpt-4o")`
121+
- Python: `session.set_model("gpt-4o")`
122+
- Go: `session.SetModel("gpt-4o")`
123+
124+
### Other changes
125+
126+
- bugfix: **[Python]** correct `PermissionHandler.approve_all` type annotations ([#618](https://github.com/github/copilot-sdk/pull/618))
127+
- improvement: **[C#]** use event delegate for thread-safe, insertion-ordered event handler dispatch ([#624](https://github.com/github/copilot-sdk/pull/624))
128+
- improvement: **[C#]** deduplicate `OnDisposeCall` and improve implementation ([#626](https://github.com/github/copilot-sdk/pull/626))
129+
- improvement: **[C#]** remove unnecessary `SemaphoreSlim` locks for handler fields ([#625](https://github.com/github/copilot-sdk/pull/625))
130+
````
131+
132+
**Key rules visible in the example:**
133+
- Highlighted features get their own `### Feature:` heading, a short description, and code snippets
134+
- Code snippets are TypeScript and C# primarily; Go/Python only when listing one-liner equivalents or when meaningfully different
135+
- The `### Other changes` section is a flat bulleted list with lowercase `bugfix:` / `feature:` / `improvement:` prefixes
136+
- PR numbers are linked inline, not at the end with author attribution (keep it clean)
137+
138+
## Guidelines
139+
140+
1. **Be concise**: Each bullet should be one short sentence. Don't over-explain.
141+
2. **Be accurate**: Only include changes that actually landed in this release range. Don't hallucinate PRs.
142+
3. **Attribute correctly**: Always link to the PR number and credit the author.
143+
4. **Skip noise**: Don't include trivial changes (typo fixes in comments, whitespace changes) unless they're the only changes.
144+
5. **Preserve history**: Never modify existing entries in CHANGELOG.md — only prepend new ones.
145+
6. **Handle edge cases**: If there are no meaningful changes (e.g., only internal dependency bumps), still create an entry noting "Internal dependency updates only" or similar.

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Changelog
2+
3+
All notable changes to the Copilot SDK are documented in this file.
4+
5+
This changelog is automatically generated by an AI agent when stable releases are published.
6+
See [GitHub Releases](https://github.com/github/copilot-sdk/releases) for the full list.

0 commit comments

Comments
 (0)