[Internal] Tooling: Adds Release Copilot Agent for SDK release automation#5633
Open
NaluTripician wants to merge 14 commits intomasterfrom
Open
[Internal] Tooling: Adds Release Copilot Agent for SDK release automation#5633NaluTripician wants to merge 14 commits intomasterfrom
NaluTripician wants to merge 14 commits intomasterfrom
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…tion - Adds .github/agents/release-copilot-agent.agent.md with Release and Hotfix modes - Adds GenAPI binaries under tools/GenAPI/ for API contract file generation - Updates .github/copilot-instructions.md with the new agent entry Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Kiran Kumar Kolli <kirankk@microsoft.com>
…ub.com/Azure/azure-cosmos-dotnet-v3 into users/ntripician/release-copilot-agent
…y hotfix GA+Preview, use Directory.Build.props for previous version - Renames 'Release Mode' to 'Minor Mode' throughout the agent file - Clarifies that Hotfix Mode also produces GA + Preview packages - Simplifies section 2.2 to read previous version from Directory.Build.props on master Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Fixes PR titles to use allowed verb 'Adds' instead of 'Bumps' to match the PR lint regex (Adds|Fixes|Refactors|Removes) - Expands hotfix contract generation (Section 3.8) to produce both GA and preview contract files with explicit build/GenAPI steps - Updates hotfix master-sync to explicitly list both contract files - Updates hotfix PR body to include preview version changes and separate GA/preview API diff sections - Updates hotfix PR checklist to reference both contract files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Adds Copilot CLI invocation guidance alongside VS Code syntax - Updates prerequisites to note GitHub MCP tools are built-in for CLI - Makes tool references context-agnostic (VS Code and CLI) - Updates copilot-instructions.md with CLI usage guidance - Supports hotfixing any previous release branch, not just latest - Prompts user for target hotfix version with existing patch detection - Clarifies preview version is derived from hotfix base, not master - Adds examples table for multi-patch hotfix scenarios Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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.
Summary
Adds a new Release Copilot Agent (
@ReleaseCopilotAgent) that guides the team through the Cosmos DB .NET SDK release process. Also bundles the GenAPI tool binaries into the repository so the agent can automate API contract file generation.Works with both VS Code Copilot Chat and the Copilot CLI (terminal).
Changes
.github/agents/release-copilot-agent.agent.md.github/copilot-instructions.mdReleaseCopilotAgentto Named Copilot Agents section (with CLI guidance)tools/GenAPI/*Usage Guide
Getting Started
In VS Code Copilot Chat:
or
In the Copilot CLI (terminal):
or
The agent will ask you to select a mode and then guide you step-by-step.
Minor Mode (Full Release)
Use this for a standard GA + Preview release from
master.What the agent does:
Directory.Build.propsand confirms the target release version with you[Internal]PRs, and categorizing by verb (Adds → Added, Fixes → Fixed, etc.)Directory.Build.propsfollowing the versioning rules enforced byContractEnforcementTestsdotnet build -c Releasefor GA,/p:IsPreview=truefor preview)tools/GenAPI/GenAPI.exe) to generate API contract files and places them inMicrosoft.Azure.Cosmos/contracts/git diff --no-index) between old and new contract filesExample flow:
Hotfix Mode
Use this to cherry-pick specific PRs into a patch release on any existing release branch (not just the most recent).
What the agent does:
releases/3.50.0,releases/3.57.0)Directory.Build.props(preview version derived from hotfix base, not master)Example flow:
Key Versioning Rules
The agent enforces the versioning rules from
ContractEnforcementTests.cs:ClientOfficialVersion3.58.0ClientPreviewVersion3.59.0ClientPreviewSuffixVersionpreview.{official_patch}preview.0Prerequisites
gh) authenticated