github / github/copilot-sdk

[v2] Publish the breaking-change inventory and migration guide

Open
#2,527 1 comment 0 reactions 0 assignees View on GitHub
documentation sdk-v2
Dominant language
Java
Stars
10.5k
Forks
1.5k
Avg merge
1d 11h
Merged PRs (30d)
127

Description

## Summary

Publish the authoritative breaking-change inventory and migration guidance for Copilot SDK v2.

This work depends on the final decisions and implementations in the other v2 sub-issues.

## Required content

- Per-language inventory of removed, renamed, and relocated APIs.
- Before-and-after examples for every accepted breaking change.
- Behavioral changes that may compile successfully but alter runtime behavior.
- Supported replacements for removed APIs.
- Runtime and CLI compatibility requirements.
- Package/version upgrade instructions.
- Links to the decision issues and implementation pull requests.
- Explicit notes for historical proposals that were retained, superseded, deferred, or moved elsewhere.

## Completion

The migration guide is reviewed by each affected SDK owner, matches the shipped preview packages, and is linked from the v2 release notes and primary documentation.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the final decisions and implementations in the other v2 sub-issues, then compare them with the shipped preview packages. Build the per-language inventory, examples, compatibility notes, replacements, and upgrade instructions, linking decision issues and implementation pull requests. Done means each affected SDK owner has reviewed it and the guide is linked from the v2 release notes and primary documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.