Skip to content
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

Add breaking changes docs for breaking changes caused by v3 to v4 uprade #26248

Merged
merged 3 commits into from
Oct 9, 2024

Conversation

dolauli
Copy link
Contributor

@dolauli dolauli commented Oct 9, 2024

Description

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • For SDK-based development mode, 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.
    • For autorest-based development mode, include the changelog in the PR description.
    • 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

Copy link

azure-client-tools-bot-prd bot commented Oct 9, 2024

️✔️Az.Accounts
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows

Copy link
Member

@isra-fel isra-fel left a comment

Choose a reason for hiding this comment

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

Main comments:

  1. How about mutability?
  2. Every BC needs a section to explain to cx how to know if they are impacted by the BC. For example, in the array-list section, we should say "If you are using any of the Array specific properties or methods then you are impacted. For example, ... and ..."

Thanks

Copy link
Member

@isra-fel isra-fel 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
Copy link
Member

isra-fel commented Oct 9, 2024

/azp run azure-powershell - security-tools

Copy link
Contributor

Azure Pipelines successfully started running 1 pipeline(s).

@dolauli dolauli merged commit 547f20e into Azure:main Oct 9, 2024
12 checks passed
github-actions bot pushed a commit that referenced this pull request Oct 9, 2024
…ade (#26248)

* Add breaking changes docs for breaking changes caused by v3 to v4 upgrade

* Apply suggestions from code review

Co-authored-by: Yeming Liu <[email protected]>

* Fixed a link issue and add explanation for enum change

---------

Co-authored-by: Yeming Liu <[email protected]>
VeryEarly added a commit that referenced this pull request Oct 10, 2024
…ade (#26248) (#26264)

* Add breaking changes docs for breaking changes caused by v3 to v4 upgrade

* Apply suggestions from code review



* Fixed a link issue and add explanation for enum change

---------

Co-authored-by: Xiaogang <[email protected]>
Co-authored-by: Yeming Liu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants