Skip to content

[CosmosDB] Add breaking change notification for list connection string output change #24108

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
Feb 7, 2024
Merged

[CosmosDB] Add breaking change notification for list connection string output change #24108

merged 2 commits into from
Feb 7, 2024

Conversation

ghost
Copy link

@ghost ghost commented Feb 5, 2024

Description

We made changes in our 2023-03-15 Cosmos DB RP API version to update the format that our ListConnectionStrings returns. At that time, we were advised that it was a breaking change and needed an advanced notification, so closed the original PR here: #22829

This adds the breaking change notification separately so that we can introduce this change in the next breaking change release.

Here is the new PR for the breaking changes themselves: #24109

Mandatory Checklist

  • SHOULD update ChangeLog.md file(s) appropriately
    • For SDK-based development mode, 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.
    • For autorest-based development mode, include the changelog in the PR description.
    • 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

azure-client-tools-bot-prd bot commented Feb 5, 2024

️✔️Az.Accounts
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.CosmosDB
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Breaking Change Check
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Signature Check
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Help File Existence Check
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️File Change Check
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️UX Metadata Check
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Test
️✔️PowerShell Core - Linux
️✔️PowerShell Core - MacOS
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.KeyVault
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.Network
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.Resources
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows

@ghost ghost changed the title [CosmosDB] Add breaking change notification for list connection string changes [CosmosDB] Add breaking change notification for list connection string output change Feb 5, 2024

namespace Microsoft.Azure.Commands.CosmosDB
{
[GenericBreakingChange("Output type for -Type ConnectionStrings will be changed to List<DatabaseAccountConnectionString> in next major version.")]
Copy link
Contributor

Choose a reason for hiding this comment

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

'GenericBreakingChangeAttribute' is obsolete: 'This attribute is deprecated. Please use GenericBreakingChangeWithVersionAttribute instead

Copy link
Author

Choose a reason for hiding this comment

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

Understood, updated it.

Copy link

github-actions bot commented Feb 6, 2024

This PR was labeled "needs-revision" because it has unresolved review comments or CI failures.
Please resolve all open review comments and make sure all CI checks are green. Refer to our guide to troubleshoot common CI failures.

@ghost ghost requested a review from msJinLei February 6, 2024 18:12
@ghost ghost removed the needs-revision label Feb 6, 2024
@msJinLei msJinLei merged commit 64466a8 into Azure:main Feb 7, 2024
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