Added spec for 'package updater' tools#12563
Merged
Merged
Conversation
github-actions
Bot
added
the
azsdk-cli
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a comprehensive specification for "package updater" tools in the Azure SDK CLI workflow. The spec formalizes Stage 6 of SDK preparation—the housekeeping tasks performed after code generation and validation but before creating release PRs. It defines four composable CLI and MCP tools (CI Update, Changelog Update, Version Update, Metadata Update) that standardize metadata and documentation updates across all supported SDK languages.
Key Changes:
- Defines four discrete, composable tools with structured JSON outputs for deterministic orchestration
- Establishes explicit behavioral differences between management-plane and data-plane SDK workflows
- Specifies PowerShell-based script interfaces with standardized parameters and error handling conventions
raych1
requested review from
MaryGao,
haiyuazhang,
haolingdong-msft,
jsquire,
lmazuel,
maririos,
msyyc,
ronniegeraghty and
tadelesh
October 20, 2025 18:17
raych1
commented
Oct 20, 2025
l0lawrence
reviewed
Oct 20, 2025
This was referenced Oct 21, 2025
m-redding
reviewed
Oct 21, 2025
jsquire
reviewed
Oct 21, 2025
weshaggard
reviewed
Oct 31, 2025
m-redding
approved these changes
Nov 4, 2025
l0lawrence
approved these changes
Nov 5, 2025
timovv
approved these changes
Nov 5, 2025
ronniegeraghty
approved these changes
Nov 5, 2025
richardpark-msft
approved these changes
Nov 5, 2025
richardpark-msft
left a comment
richardpark-msft
left a comment
Member
There was a problem hiding this comment.
Looks great, I'm sure we'll find out more when we implement it but the outline looks fine.
weshaggard
reviewed
Nov 5, 2025
samvaity
approved these changes
Nov 5, 2025
|
|
||
| Execution Steps (Data-Plane): | ||
|
|
||
| 1. Return `noop` result advising manual edit and future version bump timing. |
Member
There was a problem hiding this comment.
I believe every language would at least have formats with content headers and specifications that need to be in the Readme, we can/should link to that.
lmazuel
approved these changes
Nov 5, 2025
maririos
approved these changes
Nov 5, 2025
msyyc
approved these changes
Nov 6, 2025
MaryGao
approved these changes
Nov 6, 2025
lirenhe
approved these changes
Nov 6, 2025
tadelesh
approved these changes
Nov 6, 2025
weidongxu-microsoft
approved these changes
Nov 6, 2025
weidongxu-microsoft
left a comment
weidongxu-microsoft
left a comment
Member
There was a problem hiding this comment.
If Haoling has change request, feel free to make a follow-up PR.
weshaggard
approved these changes
Nov 6, 2025
Member
|
@raych1 Thanks for adding the configuration and example. It is very helpful for language to do integration! |
ronniegeraghty
added
the
AzSDK Tools Agent
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.
Ported the original docs specs into the new spec layout.
Added new content and clarifications to match the updated format.
See issue Spec: package metadata and docs update #11827 for scope and follow-ups.