Skip to content

[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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

am-lim
Copy link

@am-lim am-lim commented Jul 1, 2025

Description

Upcoming breaking changes for 2025-04-01-preview API
Control plane PR: #27998
Data plane PR: #27999

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • Update src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.
      • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header in the past tense.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT adjust version of module manually in pull request

@Copilot Copilot AI review requested due to automatic review settings July 1, 2025 06:36
Copy link

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

Copilot

This comment was marked as outdated.

@am-lim am-lim changed the title [devcenter] Add breaking changes for 2025-04-01-preview API [devcenter] Add breaking change deprecation messages for 2025-04-01-preview API Jul 1, 2025
@YanaXu
Copy link
Contributor

YanaXu commented Jul 1, 2025

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@YanaXu
Copy link
Contributor

YanaXu commented Jul 1, 2025

Hi @am-lim, please add the ChangLog.

@YanaXu YanaXu self-assigned this Jul 1, 2025
Copy link

github-actions bot commented Jul 1, 2025

This PR was labeled "needs-revision" because it has unresolved review comments or CI failures.
Please resolve all open review comments and make sure all CI checks are green. Refer to our guide to troubleshoot common CI failures.

@Alex-AZPS Alex-AZPS added the Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change label Jul 1, 2025
@am-lim
Copy link
Author

am-lim commented Jul 1, 2025

Hi @am-lim, please add the ChangLog.

HI @YanaXu, this is updated.

@YanaXu
Copy link
Contributor

YanaXu commented Jul 2, 2025

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@YanaXu
Copy link
Contributor

YanaXu commented Jul 2, 2025

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

YanaXu
YanaXu previously approved these changes Jul 2, 2025
@YanaXu
Copy link
Contributor

YanaXu commented Jul 2, 2025

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@YanaXu YanaXu enabled auto-merge (squash) July 2, 2025 06:26
@YanaXu
Copy link
Contributor

YanaXu commented Jul 2, 2025

Hi @am-lim, please run autorest, build-module.ps1 and submit all changes.

@vidai-msft vidai-msft requested a review from Copilot July 2, 2025 08:52
Copy link
Contributor

@Copilot Copilot AI left a 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 the LocalAdministrator 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 the ParameterBreakingChangeAttribute to explain what change is coming for the LocalAdministrator 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:

auto-merge was automatically disabled July 2, 2025 16:33

Head branch was pushed to by a user without write access

@am-lim
Copy link
Author

am-lim commented Jul 2, 2025

Hi @am-lim, please run autorest, build-module.ps1 and submit all changes.

Hi @YanaXu, this is done, updated for both control and data plane.

@YanaXu
Copy link
Contributor

YanaXu commented Jul 3, 2025

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@am-lim
Copy link
Author

am-lim commented Jul 6, 2025

/azp run

Hi @YanaXu, can you run the checks again?

@YanaXu
Copy link
Contributor

YanaXu commented Jul 7, 2025

/azp run

Copy link
Contributor

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
Copy link
Contributor

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?

@YanaXu
Copy link
Contributor

YanaXu commented Jul 7, 2025

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants