Skip to content

Fix bug where parameters could not be toggled off #24705

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

Closed
wants to merge 5 commits into from

Conversation

dannysongg
Copy link
Member

Description

Some parameters for the Publish-AzWebApp cmdlet need to be able to be set to false. The current parameters are of type SwitchParameters so they can only be set to true. This change will change some parameters to the type nullable boolean. This is a bug fix.

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 Apr 23, 2024

️✔️Az.Accounts
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Az.Network
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
❌Az.Websites
️✔️Build
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
❌Breaking Change Check
❌PowerShell Core - Windows
Type Cmdlet Description Remediation
Publish-AzWebApp The cmdlet 'Publish-AzWebApp' no longer supports the type 'System.Management.Automation.SwitchParameter' for parameter 'Clean'. Change the type for parameter 'Clean' back to 'System.Management.Automation.SwitchParameter'.
Publish-AzWebApp The cmdlet 'Publish-AzWebApp' no longer supports the type 'System.Management.Automation.SwitchParameter' for parameter 'Async'. Change the type for parameter 'Async' back to 'System.Management.Automation.SwitchParameter'.
Publish-AzWebApp The cmdlet 'Publish-AzWebApp' no longer supports the type 'System.Management.Automation.SwitchParameter' for parameter 'Restart'. Change the type for parameter 'Restart' back to 'System.Management.Automation.SwitchParameter'.
❌Windows PowerShell - Windows
Type Cmdlet Description Remediation
Publish-AzWebApp The cmdlet 'Publish-AzWebApp' no longer supports the type 'System.Management.Automation.SwitchParameter' for parameter 'Clean'. Change the type for parameter 'Clean' back to 'System.Management.Automation.SwitchParameter'.
Publish-AzWebApp The cmdlet 'Publish-AzWebApp' no longer supports the type 'System.Management.Automation.SwitchParameter' for parameter 'Async'. Change the type for parameter 'Async' back to 'System.Management.Automation.SwitchParameter'.
Publish-AzWebApp The cmdlet 'Publish-AzWebApp' no longer supports the type 'System.Management.Automation.SwitchParameter' for parameter 'Restart'. Change the type for parameter 'Restart' back to 'System.Management.Automation.SwitchParameter'.
️✔️Signature Check
️✔️PowerShell Core - Windows
️✔️Windows PowerShell - Windows
️✔️Help Example 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

@YanaXu YanaXu added the Breaking Change Release This PR contains breaking change label Apr 25, 2024
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.

@YanaXu
Copy link
Contributor

YanaXu commented Apr 25, 2024

Hi @dannysongg, this PR introduce breaking changes which were not pre-announced in the former 2 releases. Please take the 2 PRs for example: Add upcoming Breaking Change message and the breaking change update.

First, you have add the upcoming breaking change message in Az 12.1.0 (2024-07-02).
Second, you can submit this PR in Az 13.0.0.

Copy link

‼️ DO NOT MERGE THIS PR ‼️
This PR was labeled "Do Not Merge" because it contains code change that cannot be merged. Please contact the reviewer for more information.

@dannysongg
Copy link
Member Author

@YanaXu this is a bug fix that fixes a CRI. Cx needs change released ASAP

@YanaXu
Copy link
Contributor

YanaXu commented May 7, 2024

Hi @dannysongg, please confirm this: it's a bug fix, which means the cmdlet is not working before. Is this correct?
If yes, please suppress the breaking chagnes.
If no, it's a breaking change and we need to hold it.

@YanaXu
Copy link
Contributor

YanaXu commented May 8, 2024

/azp run

@YanaXu
Copy link
Contributor

YanaXu commented May 9, 2024

Hi @dannysongg, please confirm this: it's a bug fix, which means the cmdlet is not working before. Is this correct? If yes, please suppress the breaking chagnes. If no, it's a breaking change and we need to hold it.

Hi @dannysongg, please confirm this comment. FYI, the code freeze date is next Monday.

@dannysongg
Copy link
Member Author

@YanaXu yes this is a bug fix. This is fixing an unintended behavior reported by Cx. I will suppress the breaking change.

@dannysongg dannysongg closed this Sep 26, 2024
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 Do Not Merge 🚫
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants