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

[Relay] added breaking change. #20930

Merged
merged 3 commits into from
Feb 20, 2023
Merged

[Relay] added breaking change. #20930

merged 3 commits into from
Feb 20, 2023

Conversation

LucasYao93
Copy link
Contributor

@LucasYao93 LucasYao93 commented Feb 15, 2023

Description

Checklist

  • SHOULD select appropriate branch. Cmdlets from Autorest.PowerShell should go to generation branch.
  • SHOULD make the title of PR clear and informative, and in the present imperative tense.
  • SHOULD update ChangeLog.md file(s) appropriately
    • For any service, the ChangeLog.md file can be found at 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. Add changelog in description section if PR goes into generation branch.
    • Should not change ChangeLog.md if no new release is required, such as fixing test case only.
  • SHOULD have approved design review for the changes in this repository (Microsoft internal only) with following situations
    • Create new module from scratch
    • Create new resource types which are not easy to conform to Azure PowerShell Design Guidelines
    • Create new resource type which name doesn't use module name as prefix
    • Have design question before implementation
  • SHOULD regenerate markdown help files if there is cmdlet API change. Instruction
  • SHOULD have proper test coverage for changes in pull request.
  • SHOULD NOT introduce breaking changes in Az minor release except preview version.
  • SHOULD NOT adjust version of module manually in pull request

@LucasYao93 LucasYao93 requested review from isra-fel and a1exwang and removed request for a1exwang February 15, 2023 07:25
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.

Breaking changes should have a targeted date. Will it happen in our next breaking change relase this May?

@LucasYao93
Copy link
Contributor Author

LucasYao93 commented Feb 15, 2023

Breaking changes should have a targeted date. Will it happen in our next breaking change release this May?

Hi yeming,
I want to confirm our release steps.

First, we will release module with breaking change.
Second, we will release generate module.

If the steps are correct. Our target date is May.

@@ -23,6 +24,7 @@ namespace Microsoft.Azure.Commands.Relay.Commands.Namespace
/// <summary>
/// 'Set-AzRelayNamespace' Cmdlet updates the specified Relay Namespace
/// </summary>
[GenericBreakingChange("Set-AzRelayNamespace will be removed in an upcoming breaking change release, you can use Update-AzRelayNamespace in a future release")]
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add a target date or target version in breaking change message.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

@BethanyZhou BethanyZhou left a comment

Choose a reason for hiding this comment

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

The target version should be 2.0.0 for Az.Relay

@BethanyZhou BethanyZhou merged commit 442971b into main Feb 20, 2023
@BethanyZhou BethanyZhou deleted the Relay/BreakingChange branch February 20, 2023 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants