Skip to content

[PS Relay] Add breaking change announcement #27975

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

Merged
merged 4 commits into from
Jun 18, 2025

Conversation

JoyerJin
Copy link
Contributor

Description

Add breaking change announcement for Relay Migration 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 17, 2025 07:25
Copy link

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

@JoyerJin JoyerJin added the Breaking Change Preannounce This PR adds preannouncement about upcoming breaking change label Jun 17, 2025
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 introduces a breaking change announcement for the Relay migration along with several supporting updates. The changes include updated generated metadata and module dependency versions in the PSD1 file, expanded solution configuration support for x86/x64 builds, corrections of typos in example scripts and docs, and the addition of breaking change announcement details in the Autorest README.

Reviewed Changes

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

Show a summary per file
File Description
src/Relay/Relay/Az.Relay.psd1 Updated generated date, RequiredModules version, and adjusted file path separators
src/Relay/Relay.sln Expanded solution configurations to include x64/x86 builds and updated project entries and GUIDs
src/Relay/Relay.Autorest/resources/README.md Added resource documentation
src/Relay/Relay.Autorest/generate-info.json Updated generate_Id
Example markdown files Corrected typos (e.g. "Hybird" to "Hybrid", "InputeObject" to "InputObject") in example scripts and documentation
src/Relay/Relay.Autorest/README.md Added breaking change announcements with details about property type changes
src/Relay/Relay.Autorest/Properties/AssemblyInfo.cs Added auto-generated assembly information
Comments suppressed due to low confidence (1)

src/Relay/Relay/Az.Relay.psd1:66

  • Please confirm that the change in file path separator from a backslash to a forward slash is consistent with module standards across all target environments.
FormatsToProcess = 'Relay.Autorest/Az.Relay.format.ps1xml'

Copy link
Contributor

@vidai-msft vidai-msft left a comment

Choose a reason for hiding this comment

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

Change log update is missing.

Copy link
Contributor

@vidai-msft vidai-msft left a comment

Choose a reason for hiding this comment

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

LGTM

@vidai-msft vidai-msft enabled auto-merge (squash) June 18, 2025 08:10
@vidai-msft vidai-msft merged commit 9b4638b into main Jun 18, 2025
12 checks passed
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.

2 participants