Skip to content

Conversation

@haagha
Copy link
Member

@haagha haagha commented Mar 29, 2022

(https://github.com/Azure/azure-powershell-cmdlet-review-pr/issues/1098)

Checklist

  • I have read the Submitting Changes section of CONTRIBUTING.md
  • The title of the PR is clear and informative
  • The appropriate ChangeLog.md file(s) has been updated:
    • 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 -- no new version header should be added
  • The PR does not introduce breaking changes
  • If applicable, the changes made in the PR have proper test coverage
  • For public API changes to cmdlets:
    • a cmdlet design review was approved for the changes in this repository (Microsoft internal only)
      • {Please put the link here}
    • the markdown help files have been regenerated using the commands listed here

@haagha
Copy link
Member Author

haagha commented Mar 29, 2022

@BethanyZhou can you please add this to the March release? Thanks.

public string Name { get; set; }

[Parameter(
Position = 3,
Copy link
Contributor

Choose a reason for hiding this comment

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

Removing position may break user's script, please revert these changes.

@BethanyZhou
Copy link
Contributor

Please fix analyze issues and test issues.

[xUnit.net 00:01:50.05] Microsoft.Azure.Commands.Compute.Test.ScenarioTests.RestorePointsTests.TestRestorePoints [FAIL]

/Users/runner/work/1/s/artifacts//StaticAnalysisResults/BreakingChangeIssues.csv Errors
"AssemblyFileName","ClassName","Target","Severity","ProblemId","Description","Remediation"
"Az.Compute","Microsoft.Azure.Commands.Compute.Automation.NewAzureRestorePoint","New-AzRestorePoint","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzRestorePoint' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzRestorePoint'."
"Az.Compute","Microsoft.Azure.Commands.Compute.Automation.NewAzureRestorePointCollection","New-AzRestorePointCollection","0","1050","The parameter set '__AllParameterSets' for cmdlet 'New-AzRestorePointCollection' has been removed.","Add parameter set '__AllParameterSets' back to cmdlet 'New-AzRestorePointCollection'."

@BethanyZhou
Copy link
Contributor

@BethanyZhou can you please add this to the March release? Thanks.

Our code freeze date is 03/28 and we are building release candidate for March release.

Any special reason to must have this PR in March release? If so, please fix comments above ASAP and let us see this PR whether has change to squeeze into release candidate.

@haagha
Copy link
Member Author

haagha commented Mar 29, 2022

@BethanyZhou yes this is request customers are waiting on, I will fix the PR and let you know.

@haagha
Copy link
Member Author

haagha commented Mar 29, 2022

@BethanyZhou The Static analysis failure seems like a false positive.
It says in this document https://github.com/Azure/azure-powershell/blob/main/documentation/Debugging-StaticAnalysis-Errors.md
"Note: Sometimes the error listed in the .csv file can be a false positive (for example, if you change a parameter attribute to span all parameter sets rather than individual parameter sets)."

@BethanyZhou
Copy link
Contributor

Yes, please suppress them in suppress the breaking change errors in tools/StaticAnalysis/Exceptions/${ModuleName}/BreakingChangeIssues.csv"

@BethanyZhou BethanyZhou changed the base branch from main to release-2022-04-05 March 30, 2022 01:37
@BethanyZhou BethanyZhou added this to the Mar 2022 (2022-04-05) milestone Mar 30, 2022
[[-DisksToExclude] <String[]>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
[<CommonParameters>]
New-AzRestorePoint [-ResourceGroupName] <String> -RestorePointCollectionName <String> -Name <String>
[-Location <String>] -RestorePointId <String> [-DisksToExclude <String[]>]
Copy link
Contributor

Choose a reason for hiding this comment

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

please update markdown files to keep sync with code implementation. The syntax says RestorePointCollectionName is not a positional parameter now. Need be updated.

```
### -Location
{{ Fill Location Description }}
Copy link
Contributor

Choose a reason for hiding this comment

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

The description of Location is missing, please add help message for it.

Position = 3,
Mandatory = false,
ValueFromPipelineByPropertyName = false)]
public string Location { get; set; }
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 help message for new added parameters.

```
### -RestorePointId
{{ Fill RestorePointId Description }}
Copy link
Contributor

Choose a reason for hiding this comment

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

This one needs help message as well.

Aliases:

Required: True
Position: 2
Copy link
Contributor

Choose a reason for hiding this comment

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

Please update markdown files.

```
### -Zone
{{ Fill Zone Description }}
Copy link
Contributor

Choose a reason for hiding this comment

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

Needs description. To add it, please add help message in cs file.

```
### -RestorePointCollectionId
{{ Fill RestorePointCollectionId Description }}
Copy link
Member

Choose a reason for hiding this comment

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

Description is empty.

@haagha
Copy link
Member Author

haagha commented Mar 30, 2022

Added static analysis to breaking changes supression csv and updated descriptions and help files.

@haagha haagha requested a review from BethanyZhou March 30, 2022 02:54
@BethanyZhou
Copy link
Contributor

Seems like you forget to update Repair-AzVmssServiceFabricUpdateDomain.md the description of Zone and PlacementGroupId is empty, please have a look.

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.

All look good to me except Repair-AzVmssServiceFabricUpdateDomain.md

@haagha haagha requested a review from BethanyZhou March 30, 2022 04:05
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.

Looks good to me

@BethanyZhou BethanyZhou merged commit 4ef6279 into release-2022-04-05 Mar 30, 2022
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.

4 participants