-
Notifications
You must be signed in to change notification settings - Fork 4k
[devcenter] Add breaking change deprecation messages for 2025-04-01-preview API #28080
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
base: main
Are you sure you want to change the base?
Conversation
…2025-04-01-preview
…view Amlim/breaking changes2025 04 01 preview
Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
Hi @am-lim, please add the ChangLog. |
This PR was labeled "needs-revision" because it has unresolved review comments or CI failures. |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
Hi @am-lim, please run |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds breaking change annotations for the 2025-04-01-preview Data Plane API and updates module metadata and changelogs to preannounce upcoming deprecations.
- Adds
OutputBreakingChangeAttribute
to several DevBox cmdlets - Introduces
ParameterBreakingChangeAttribute
for theLocalAdministrator
parameter - Updates AutoRest README with root module name and extensive breaking-changes rules
- Records preannouncement in the ChangeLog
Reviewed Changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
src/DevCenter/DevCenterData.AutoRest/custom/Stop-AzDevCenterUserDevBox.ps1 | Added placeholder breaking change attribute to output |
src/DevCenter/DevCenterData.AutoRest/custom/Start-AzDevCenterUserDevBox.ps1 | Same placeholder attribute added |
src/DevCenter/DevCenterData.AutoRest/custom/Restart-AzDevCenterUserDevBox.ps1 | Same placeholder attribute added |
src/DevCenter/DevCenterData.AutoRest/custom/Repair-AzDevCenterUserDevBox.ps1 | Same placeholder attribute added |
src/DevCenter/DevCenterData.AutoRest/custom/Remove-AzDevCenterUserEnvironment.ps1 | Same placeholder attribute added |
src/DevCenter/DevCenterData.AutoRest/custom/Remove-AzDevCenterUserDevBox.ps1 | Same placeholder attribute added |
src/DevCenter/DevCenterData.AutoRest/custom/New-AzDevCenterUserDevBox.ps1 | Added ParameterBreakingChangeAttribute for LocalAdministrator |
src/DevCenter/DevCenterData.AutoRest/README.md | Added root-module-name and a large block of breaking-changes rules |
src/DevCenter/DevCenter/ChangeLog.md | Logged “Added preannouncement breaking change messages.” |
Comments suppressed due to low confidence (3)
src/DevCenter/DevCenterData.AutoRest/custom/New-AzDevCenterUserDevBox.ps1:122
- [nitpick] Consider adding a brief
ChangeDescription
argument to theParameterBreakingChangeAttribute
to explain what change is coming for theLocalAdministrator
parameter.
[Microsoft.Azure.PowerShell.Cmdlets.DevCenterdata.Runtime.ParameterBreakingChangeAttribute("LocalAdministrator", "15.0.0", "3.0.0", "2025/11/18")]
src/DevCenter/DevCenter/ChangeLog.md:21
- [nitpick] The changelog entry is vague; consider specifying which cmdlets or parameters have breaking change preannouncements for clarity.
* Added preannouncement breaking change messages.
src/DevCenter/DevCenterData.AutoRest/README.md:173
- The large YAML block of breaking-changes rules may have inconsistent indentation and quoting (e.g.
replacement-cmdlet: $.replace("DevCenter", "AzDevCenterAdmin")
). Verify YAML syntax and properly quote nested strings to prevent parsing errors.
- where:
src/DevCenter/DevCenterData.AutoRest/custom/Stop-AzDevCenterUserDevBox.ps1
Show resolved
Hide resolved
src/DevCenter/DevCenterData.AutoRest/custom/Start-AzDevCenterUserDevBox.ps1
Show resolved
Hide resolved
Head branch was pushed to by a user without write access
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
Hi @YanaXu, can you run the checks again? |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
@@ -45,7 +45,7 @@ Applies customizations to the Dev Box. | |||
|
|||
## EXAMPLES | |||
|
|||
### Example 1: Create a customization group by endpoint |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you check the right word and don't revert it?
Hi @am-lim, the PR is clear but can you check the md files? If the words in the repo is better, can you revert yor change on them? |
Description
Upcoming breaking changes for 2025-04-01-preview API
Control plane PR: #27998
Data plane PR: #27999
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.md
and reviewed the following information:ChangeLog.md
file(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
.## Upcoming Release
header in the past tense.ChangeLog.md
if no new release is required, such as fixing test case only.