Added spec for 'package updater' tools #12563
Conversation
github-actions
bot
added
the
azsdk-cli
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
richardpark-msft
left a comment
richardpark-msft
left a comment
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.
|
|
||
| Execution Steps (Data-Plane): | ||
|
|
||
| 1. Return `noop` result advising manual edit and future version bump timing. |
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.
weidongxu-microsoft
left a comment
weidongxu-microsoft
left a comment
There was a problem hiding this comment.
If Haoling has change request, feel free to make a follow-up PR.
|
@raych1 Thanks for adding the configuration and example. It is very helpful for language to do integration! |
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.