-
Notifications
You must be signed in to change notification settings - Fork 646
Add release-notes, breaking-changes, and bump-version Copilot skills #1328
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.
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
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
f7f505a
Add release-notes agent skill
jeffhandley cc3e074
Refactor breaking-changes into standalone skill
jeffhandley 3dc6b08
Refine release-notes and breaking-changes skills
jeffhandley da197ec
Add bump-version skill
jeffhandley 3bd2da4
Add version bump step to release-notes skill
jeffhandley ff4ebbf
Require diff confirmation before overwriting published release notes
jeffhandley 139f523
Require diff confirmation before overwriting published release notes
jeffhandley aecb4eb
Extract preamble into separate step in release-notes skill
jeffhandley 94f85f6
Revise release process to use Copilot CLI release-notes skill
jeffhandley 8948700
Address PR feedback on release skills
jeffhandley 096a622
Incorporate SDK versioning policy into breaking change classification
jeffhandley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| name: breaking-changes | ||
| description: Audit pull requests for breaking changes in the C# MCP SDK. Examines PR descriptions, review comments, and diffs to identify API and behavioral breaking changes, then reconciles labels with user confirmation. Use when asked to audit breaking changes, check for breaking changes, or review a set of PRs for breaking impact. | ||
| compatibility: Requires gh CLI with repo access and GitHub API access for PR details, review history, and labels. | ||
| --- | ||
|
|
||
| # Breaking Change Audit | ||
|
|
||
| Audit pull requests in the `modelcontextprotocol/csharp-sdk` repository for breaking changes. This skill examines a range of commits, identifies API and behavioral breaking changes, assesses their impact, reconciles `breaking-change` labels, and returns structured results. | ||
|
|
||
| ## Input | ||
|
|
||
| The user provides a commit range in any of these forms: | ||
| - `tag..HEAD` (e.g. `v0.8.0-preview.1..HEAD`) | ||
| - `tag..tag` (e.g. `v0.8.0-preview.1..v0.9.0-preview.1`) | ||
| - `sha..sha` | ||
| - `tag..sha` or `sha..HEAD` | ||
|
|
||
| If no range is provided, ask the user to specify one. | ||
|
|
||
| Use the GitHub API to get the full list of PRs merged within the specified range. | ||
|
|
||
| ## Process | ||
|
|
||
| ### Step 1: Examine Every PR | ||
|
|
||
| For each PR in the range, study: | ||
| - PR description and linked issues | ||
| - Full review and comment history | ||
| - Complete code diff | ||
|
|
||
| Look for both categories of breaking changes: | ||
| - **API (compile-time)** — changes to public type signatures, parameter types, return types, removed members, sealed types, new obsoletion attributes, etc. | ||
| - **Behavioral (runtime)** — new/changed exceptions, altered return values, changed defaults, modified event ordering, serialization changes, etc. | ||
|
|
||
| See [references/classification.md](references/classification.md) for the full classification guide, including SDK-specific versioning policies (pre-1.0 preview flexibility, experimental APIs, obsoletion lifecycle, and spec-driven changes) that influence how breaks are assessed. | ||
|
|
||
| ### Step 2: Assess Impact | ||
|
|
||
| For each identified breaking change, assess: | ||
| - **Breadth** — how many consumers are likely affected (widely-used type vs. obscure API) | ||
| - **Severity** — compile-time break (immediate build failure) vs. behavioral (subtle runtime difference) | ||
| - **Migration** — straightforward fix vs. significant code changes required | ||
|
|
||
| This assessment informs how breaking changes are ordered when presented (most impactful first). | ||
|
|
||
| ### Step 3: Reconcile Labels | ||
|
|
||
| Compare findings against existing `breaking-change` labels on PRs. | ||
|
|
||
| Present mismatches to the user interactively: | ||
|
|
||
| - **Unlabeled but appears breaking** → explain why the PR appears breaking, ask user to confirm. If confirmed: apply the `breaking-change` label and ask the user whether to comment on the PR explaining the addition. | ||
| - **Labeled but does not appear breaking** → explain why, ask user to confirm removal. If confirmed: remove the label and ask the user whether to comment on the PR explaining the removal. | ||
|
|
||
| ### Step 4: Present Results | ||
|
|
||
| Present the final list of confirmed breaking changes, sorted from most impactful to least, with: | ||
| - PR number and title | ||
| - Classification (API or behavioral) | ||
| - Impact assessment summary | ||
| - 1-2 bullet description of what breaks and migration guidance | ||
|
|
||
| ## Output | ||
|
|
||
| The audit produces a structured list of breaking changes that can be consumed by other skills (e.g. the release-notes skill) or presented directly to the user. | ||
|
|
||
| Each entry contains: | ||
| - PR number and description | ||
| - Impact ranking (most → least impactful) | ||
| - Detail bullets describing the break and migration path |
120 changes: 120 additions & 0 deletions
120
.github/skills/breaking-changes/references/classification.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| # Breaking Change Classification Guide | ||
|
|
||
| This guide defines how to identify and classify breaking changes in the C# MCP SDK. It is derived from the [dotnet/runtime breaking change guidelines](https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/breaking-changes.md). | ||
|
|
||
| ## Two Categories of Breaking Changes | ||
|
|
||
| ### API Breaking Changes (Compile-Time) | ||
| Changes that alter the public API surface in ways that break existing code at compile time: | ||
|
|
||
| - **Renaming or removing** a public type, member, or parameter | ||
| - **Changing the return type** of a method or property | ||
| - **Changing parameter types, order, or count** on a public method | ||
| - **Sealing** a type that was previously unsealed (when it has accessible constructors) | ||
| - **Making a virtual member abstract** | ||
| - **Adding `abstract` to a member** when the type has accessible constructors and is not sealed | ||
| - **Removing an interface** from a type's implementation | ||
| - **Changing the value** of a public constant or enum member | ||
| - **Changing the underlying type** of an enum | ||
| - **Adding `readonly` to a field** | ||
| - **Removing `params` from a parameter** | ||
| - **Adding/removing `in`, `out`, or `ref`** parameter modifiers | ||
| - **Renaming a parameter** (breaks named arguments and late-binding) | ||
| - **Adding the `[Obsolete]` attribute** or changing its diagnostic ID | ||
| - **Adding the `[Experimental]` attribute** or changing its diagnostic ID | ||
| - **Removing accessibility** (making a public/protected member less visible) | ||
|
|
||
| ### Behavioral Breaking Changes (Runtime) | ||
| Changes that don't break compilation but alter observable behavior: | ||
|
|
||
| - **Throwing a new/different exception type** in an existing scenario (unless it's a more derived type) | ||
| - **No longer throwing an exception** that was previously thrown | ||
| - **Changing return values** for existing inputs | ||
| - **Decreasing the range of accepted values** for a parameter | ||
| - **Changing default values** for properties, fields, or parameters | ||
| - **Changing the order of events** being fired | ||
| - **Removing the raising of an event** | ||
| - **Changing timing/order** of operations | ||
| - **Changing parsing behavior** and throwing new errors | ||
| - **Changing serialization format** or adding new fields to serialized types | ||
|
|
||
| ## Classification Buckets | ||
|
|
||
| ### Bucket 1: Clear Public Contract Violation | ||
| Obvious breaking changes to the public API shape. **Always flag these.** | ||
|
|
||
| ### Bucket 2: Reasonable Grey Area | ||
| Behavioral changes that customers would have reasonably depended on. **Flag and discuss with user.** | ||
|
|
||
| ### Bucket 3: Unlikely Grey Area | ||
| Behavioral changes that customers could have depended on but probably wouldn't (e.g., corner case corrections). **Flag with lower confidence.** | ||
|
|
||
| ### Bug Fixes (Exclude) | ||
| Changes that correct incorrect behavior, fix spec compliance, or address security issues are **not breaking changes** even if they alter observable behavior. Examples: | ||
| - Fixing encoding to match a specification requirement | ||
| - Correcting a logger category or metric name that was wrong | ||
| - Fixing exception message leaks that were a security concern | ||
| - Moving data to the correct location per protocol spec evolution | ||
| - Setting a flag that should have been set automatically (e.g., `IsError` for error content) | ||
| - Returning a more specific/informative exception for better diagnostics | ||
|
|
||
| If a change is primarily a bug fix or spec compliance correction, exclude it from the breaking changes list even though the observable behavior changes. | ||
|
|
||
| ### Bucket 4: Clearly Non-Public | ||
| Changes to internal surface or behavior (e.g., internal APIs, private reflection). **Generally not flagged** unless they could affect ecosystem tools. | ||
|
|
||
| ## SDK Versioning Policy | ||
|
|
||
| The classification rules above are derived from the dotnet/runtime breaking change guidelines, but the MCP SDK has its own versioning policy (see `docs/versioning.md`) that provides additional context for classification decisions. | ||
|
|
||
| ### Pre-1.0 Preview Status | ||
|
|
||
| Prior to a stable 1.0.0 release, the SDK is in preview and breaking changes can be introduced without prior notice. This does **not** change how breaks are classified — they should still be flagged, labeled, and documented — but it affects the **severity assessment**. Preview consumers expect breaks, so migration guidance matters more than avoidance. | ||
|
|
||
| ### Experimental APIs | ||
|
|
||
| APIs annotated with `[Experimental]` (using `MCP`-prefixed diagnostic codes) can change at any time, including within PATCH or MINOR updates. Changes to experimental APIs should still be **noted** in the audit, but classified as **Bucket 3 (Unlikely Grey Area)** or lower unless the API has been widely adopted despite its experimental status. | ||
|
|
||
| ### Obsoletion Lifecycle | ||
|
|
||
| The SDK follows a three-step obsoletion process: | ||
|
|
||
| 1. **MINOR update**: API marked `[Obsolete]` producing _build warnings_ with migration guidance | ||
| 2. **MAJOR update**: API marked `[Obsolete]` producing _build errors_ (API throws at runtime) | ||
| 3. **MAJOR update**: API removed entirely (expected to be rare) | ||
|
|
||
| When auditing, classify each step appropriately: | ||
| - Step 1 (adding `[Obsolete]` warning) → API breaking change (new build warning) | ||
| - Step 2 (escalating to error) → API breaking change (previously working code now fails) | ||
| - Step 3 (removal) → API breaking change; migration guidance should note prior deprecation | ||
|
|
||
| In exceptional circumstances — especially during the pre-1.0 preview period — the obsoletion lifecycle may be compressed (e.g., marking obsolete and removing in the same MINOR release). This should still be flagged as a breaking change but the migration guidance should explain the rationale. | ||
|
|
||
| ### Spec-Driven Changes | ||
|
|
||
| Breaking changes necessitated by MCP specification evolution should be flagged and documented normally, but the migration guidance should reference the spec change. If a spec change forces an incompatible API change, preference is given to supporting the most recent spec version. | ||
|
|
||
| ## Compatibility Switches | ||
|
|
||
| When a breaking change includes an `AppContext` switch or other opt-in/opt-out mechanism, always note it in the migration guidance. Search for `AppContext.TryGetSwitch`, `DOTNET_` environment variables, and similar compat patterns in the diff. Include the switch name and the value that alters the behavior: | ||
|
|
||
| ``` | ||
| * Compat switch: `ModelContextProtocol.AspNetCore.AllowNewSessionForNonInitializeRequests` = `true` restores previous behavior | ||
| ``` | ||
|
|
||
| ## What to Study for Each PR | ||
|
|
||
| For every PR in the range, examine: | ||
|
|
||
| 1. **PR description** — Authors often describe breaking changes here | ||
| 2. **Linked issues** — May contain discussion about breaking impact | ||
| 3. **Review comments** — Reviewers may have flagged breaking concerns | ||
| 4. **Code diff** — Look at changes to: | ||
| - Public type/member signatures | ||
| - Exception throwing patterns | ||
| - Default values and constants | ||
| - Return value changes | ||
| - Parameter validation changes | ||
| - Attribute changes (`[Obsolete]`, `[Experimental]`, etc.) | ||
| - `AppContext.TryGetSwitch` or environment variable compat switches | ||
| 5. **Labels** — Check if `breaking-change` is already applied | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| name: bump-version | ||
| description: Bump the SDK version after publishing a release. Reads the current version from src/Directory.Build.props, suggests the next minor version, and creates a pull request with the change. Use when asked to bump the version, prepare for the next release, or increment the version number. | ||
| compatibility: Requires gh CLI with repo access for creating branches and pull requests. | ||
| --- | ||
|
|
||
| # Bump Version | ||
|
|
||
| Bump the SDK version in `src/Directory.Build.props` after publishing a release and create a pull request with the change. | ||
|
|
||
| ## Process | ||
|
|
||
| ### Step 1: Read Current Version | ||
|
|
||
| Read `src/Directory.Build.props` on the default branch and extract: | ||
| - `<VersionPrefix>` — the `MAJOR.MINOR.PATCH` version | ||
| - `<VersionSuffix>` — the prerelease suffix (e.g. `preview.1`), if present | ||
|
|
||
| Display the current version to the user: `{VersionPrefix}-{VersionSuffix}` or `{VersionPrefix}` if no suffix. | ||
|
|
||
| ### Step 2: Determine Next Version | ||
|
|
||
| If the user provided a target version in their prompt, use it. Otherwise, suggest the next **minor** version with the same suffix pattern: | ||
|
|
||
| - Current `0.9.0` with suffix `preview.1` → suggest `0.10.0-preview.1` | ||
| - Current `1.0.0` with no suffix → suggest `1.1.0` | ||
| - Current `1.2.3` with suffix `rc.1` → suggest `1.3.0-rc.1` | ||
|
|
||
| Present the suggestion and let the user confirm or provide an alternative. Parse the confirmed version into its `VersionPrefix` and `VersionSuffix` components. | ||
|
|
||
| ### Step 3: Create Pull Request | ||
|
|
||
| 1. Create a new branch named `bump-version-to-{version}` (e.g. `bump-version-to-0.10.0-preview.1`) from the default branch | ||
| 2. Update `src/Directory.Build.props`: | ||
| - Set `<VersionPrefix>` to the new prefix | ||
| - Set `<VersionSuffix>` to the new suffix, or remove the element if there is no suffix | ||
| 3. Commit with message: `Bump version to {version}` | ||
| 4. Push the branch and create a pull request: | ||
| - **Title**: `Bump version to {version}` | ||
| - **Label**: `infrastructure` | ||
| - **Base**: default branch | ||
|
|
||
| ### Step 4: Confirm | ||
|
|
||
| Display the pull request URL to the user. |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.