Skip to content

[PS Resource] Add breaking change announcement #27943

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 1 commit into
base: main
Choose a base branch
from

Conversation

JoyerJin
Copy link
Contributor

Description

breaking change announcement for Resource migrate PR

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 June 12, 2025 08:43
Copy link

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

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 a breaking change announcement for the update from Fixed Array to List for resource properties, along with associated metadata, manifest, and documentation changes.

  • Updated changelog entry to announce the breaking change.
  • Revised module manifest (Az.Resources.psd1) and solution file to include updated dates, dependency versions, and new configuration entries.
  • Updated Authorization.Autorest documentation, generate-info, and nuspec files to reflect the breaking change and dependency updates.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/Resources/Resources/ChangeLog.md Added entry for breaking change announcement.
src/Resources/Resources/Az.Resources.psd1 Updated generated date, dependency version, and configuration arrays.
src/Resources/Resources.sln Modified solution configuration with added project references and build configurations.
src/Resources/Authorization.Autorest/resources/README.md New documentation for additional module resources.
src/Resources/Authorization.Autorest/generate-info.json Updated generate_Id for the AutoRest generation process.
src/Resources/Authorization.Autorest/docs/Az.Authorization.md Updated the Module Guid to reflect the new metadata.
src/Resources/Authorization.Autorest/README.md Updated directives for breaking changes in specific cmdlets.
src/Resources/Authorization.Autorest/Properties/AssemblyInfo.cs Added assembly metadata for the updated module.
src/Resources/Authorization.Autorest/Az.Authorization.nuspec Updated dependency version for Az.Accounts.
Comments suppressed due to low confidence (4)

src/Resources/Resources/ChangeLog.md:22

  • [nitpick] Consider including additional context (e.g., affected resource types or cmdlets) in the changelog entry to make the breaking change clearer for users.
* Added breaking change announcement from Fixed Array to List.

src/Resources/Resources/Az.Resources.psd1:75

  • [nitpick] If no scripts are intended to be processed, consider leaving this section commented (as in other modules) to avoid potential confusion.
ScriptsToProcess = @()

src/Resources/Authorization.Autorest/docs/Az.Authorization.md:3

  • [nitpick] Confirm that the updated Module Guid is aligned with the metadata in other project files to ensure consistency.
Module Guid: 29b38940-f692-455e-8683-880403f4bf65

src/Resources/Authorization.Autorest/Az.Authorization.nuspec:16

  • Verify that the updated dependency version for Az.Accounts is compatible with the module and that no unintended breaking changes are introduced.
<dependency id="Az.Accounts" version="2.7.5" />

@JoyerJin JoyerJin added the Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change label Jun 13, 2025
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.

1 participant