Skip to content

[PS] Update Relay breaking change message #28182

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 2 commits into from
Jul 15, 2025
Merged

Conversation

JoyerJin
Copy link
Contributor

@JoyerJin JoyerJin commented Jul 14, 2025

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

Copy link

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

@JoyerJin JoyerJin marked this pull request as ready for review July 15, 2025 03:38
@Copilot Copilot AI review requested due to automatic review settings July 15, 2025 03:38
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 aligns the Relay PowerShell module with version 2.1.1 by improving how breaking‐change announcements are structured and updating related metadata.

  • Replaced flat change‐description lines with structured deprecated-output-properties and new-output-properties in the Autorest README.
  • Incremented module version, updated manifests (dates, GUIDs, project IDs) and assembly metadata.
  • Added a ChangeLog entry for the new breaking‐change output format.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/Relay/Relay/ChangeLog.md Added release note under Upcoming Release for updated outputs
src/Relay/Relay/Az.Relay.psd1 Bumped generation date and enabled empty Scripts/Types processing
src/Relay/Relay.sln Regenerated project GUID entries for the Az.Relay project
src/Relay/Relay.Autorest/generate-info.json Updated generate_Id GUID
src/Relay/Relay.Autorest/docs/Az.Relay.md Updated module GUID
src/Relay/Relay.Autorest/README.md Swapped change-description for structured output properties
src/Relay/Relay.Autorest/Properties/AssemblyInfo.cs Bumped AssemblyFileVersion and AssemblyVersion to 2.1.1
Comments suppressed due to low confidence (1)

src/Relay/Relay/ChangeLog.md:21

  • [nitpick] Consider elaborating this entry to specify which properties were updated (e.g., structured breaking‐change output for PrivateEndpointConnection and IPRule) for clearer release notes.
* Update the outputs of breaking change announcements.

Comment on lines 59 to 64
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()
ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()
TypesToProcess = @()

Copy link
Preview

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

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

[nitpick] If there are no script or type files to process, you can remove these empty ScriptsToProcess and TypesToProcess entries to clean up the manifest.

Copilot uses AI. Check for mistakes.

@YanaXu YanaXu merged commit 8937a7c into main Jul 15, 2025
11 checks passed
@YanaXu YanaXu deleted the joyer/relay-breakingchangefix branch July 15, 2025 09:12
anamikapan pushed a commit to anamikapan/azure-powershell that referenced this pull request Jul 15, 2025
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