Skip to content

Conversation

lijinpei2008
Copy link
Contributor

…ell v3->v4

Description

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

@lijinpei2008
Copy link
Contributor Author

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@lijinpei2008
Copy link
Contributor Author

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@lijinpei2008
Copy link
Contributor Author

/azp run

Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@lijinpei2008 lijinpei2008 added the Contains Breaking Change This PR contains breaking change label Aug 18, 2025
Copy link

To the author of the pull request,
This PR was labeled "Breaking Change Release" because it contains breaking changes.

  • According to our policy, breaking changes can only take place during major release and they must be preannounced.
  • Please follow our guide on the detailed steps.
  • Required: Please fill in the task below to facilitate our contact,you will receive notifications related to breaking changes.

@lijinpei2008 lijinpei2008 marked this pull request as ready for review August 22, 2025 10:33
@Copilot Copilot AI review requested due to automatic review settings August 22, 2025 10:33
Copilot

This comment was marked as outdated.

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 updates the Azure Arc Resource Bridge PowerShell module by upgrading from AutoRest PowerShell v3 to v4, resulting in improved cmdlet interfaces and breaking change exceptions being documented.

Key changes:

  • Upgraded AutoRest PowerShell generation tool from version 3 to 4
  • Updated cmdlet parameters to use more idiomatic PowerShell patterns (e.g., EnableSystemAssignedIdentity switch instead of IdentityType enum)
  • Added new parameter sets for JSON file and string input
  • Updated help documentation and examples to reflect the new parameter patterns

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
tools/StaticAnalysis/Exceptions/Az.ArcResourceBridge/BreakingChangeIssues.csv Documents all breaking changes resulting from the AutoRest v4 upgrade
src/ArcResourceBridge/ArcResourceBridge/help/*.md Updated help files with new parameter sets and improved documentation
src/ArcResourceBridge/ArcResourceBridge.Autorest/docs/*.md Updated AutoRest documentation files with new cmdlet signatures
src/ArcResourceBridge/ArcResourceBridge.Autorest/test/AzArcResourceBridge.Tests.ps1 Updated test to use new parameter syntax
src/ArcResourceBridge/ArcResourceBridge.Autorest/examples/New-AzArcResourceBridge.md Updated example with new parameter syntax
src/ArcResourceBridge/ArcResourceBridge.Autorest/README.md Updated AutoRest configuration to remove v3 settings

Comment on lines 37 to 40
module-version: 0.1.0
subject-prefix: $(service-name)

identity-correction-for-post: true
resourcegroup-append: true
nested-object-to-string: true

# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
use-extension:
"@autorest/powershell": "3.x"

directive:
Copy link
Preview

Copilot AI Aug 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The README.md file is missing documentation about the AutoRest v4 upgrade and its implications. Consider adding a comment or section explaining the version change from v3 to v4 and noting that this affects the generated cmdlet interfaces.

Copilot uses AI. Check for mistakes.

# Generated by: Microsoft Corporation
#
# Generated on: 2025-07-27
# Generated on: 2025-07-14
Copy link
Preview

Copilot AI Aug 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The generated date has moved backward from 2025-07-27 to 2025-07-14, which is inconsistent with a forward-moving development timeline. This could indicate an issue with the generation process or incorrect date handling.

Suggested change
# Generated on: 2025-07-14
# Generated on: 2025-07-27

Copilot uses AI. Check for mistakes.

Copy link

@julienstroheker julienstroheker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@isra-fel isra-fel added the autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 label Oct 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autorest v4 migration pr migrating module from generated by autorest.powershell v3 to v4 Contains Breaking Change This PR contains breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants