Skip to content

[Az.Dns] The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement #28369

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

Conversation

lijinpei2008
Copy link
Contributor

Description

#28318

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.

@lijinpei2008 lijinpei2008 added the Breaking Change Release This PR contains breaking change label Aug 11, 2025
@lijinpei2008 lijinpei2008 marked this pull request as ready for review August 11, 2025 06:20
@Copilot Copilot AI review requested due to automatic review settings August 11, 2025 06:20
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.

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 upcoming Az.Dns module refactoring, specifically for the Get-AzDnsDnssecConfig and New-AzDnsDnssecConfig cmdlets. The announcement notifies users that the SigningKey property will change from a single object to a list in future versions.

Key changes include:

  • Added breaking change directives for DNSSEC config cmdlets
  • Updated help documentation with corrected NAPTR record parameter ordering
  • Updated module dependencies and build configurations

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/Dns/Dns/ChangeLog.md Added changelog entry for breaking change announcement
src/Dns/Dns.Autorest/README.md Added breaking change directive for DNSSEC config cmdlets
src/Dns/Dns/help/*.md Fixed NAPTR parameter ordering and documentation in help files
src/Dns/Dns/Az.Dns.psd1 Updated module dependencies and file paths
src/Dns/Dns.sln Updated solution file with new project configurations

deprecated-output-properties:
- SigningKey
new-output-properties:
- SigningKey
Copy link
Preview

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

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

The breaking change directive lists the same property 'SigningKey' under both deprecated-output-properties and new-output-properties. This is confusing and should clarify that it's a type change rather than deprecation and addition of a new property.

Suggested change
- SigningKey
output-property-type-changed:
- SigningKey

Copilot uses AI. Check for mistakes.


# Format files (.ps1xml) to be loaded when importing this module
FormatsToProcess = 'Dns.Autorest\Az.Dns.format.ps1xml'
FormatsToProcess = 'Dns.Autorest/Az.Dns.format.ps1xml'
Copy link
Preview

Copilot AI Aug 11, 2025

Choose a reason for hiding this comment

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

The path separator has been changed from backslash to forward slash. This should be consistent throughout the file for cross-platform compatibility.

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change Release This PR contains breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant