Skip to content

Conversation

@roipmsft
Copy link
Contributor

@roipmsft roipmsft commented Jun 29, 2021

All SDK Contribution checklist:

Swagger PR Azure/azure-rest-api-specs#14638

This checklist is used to make sure that common guidelines for a pull request are followed.

  • Please open PR in Draft mode if it is:
    • Work in progress or not intended to be merged.
    • Encountering multiple pipeline failures and working on fixes.
  • If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
  • I have read the contribution guidelines.
  • The pull request does not introduce breaking changes.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

SDK Generation Guidelines

  • The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
  • The *.csproj and AssemblyInfo.cs files have been updated with the new version of the SDK. Please double check nuget.org current release version.

Additional management plane SDK specific contribution checklist:

Note: Only applies to Microsoft.Azure.Management.[RP] or Azure.ResourceManager.[RP]

  • Include updated management metadata.
  • Update AzureRP.props to add/remove version info to maintain up to date API versions.

Management plane SDK Troubleshooting

  • If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add new service label and/or contact assigned reviewer.

  • If the check fails at the Verify Code Generation step, please ensure:

    • Do not modify any code in generated folders.
    • Do not selectively include/remove generated files in the PR.
    • Do use generate.ps1/cmd to generate this PR instead of calling autorest directly.
      Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version.

    Note: We have recently updated the PSH module called by generate.ps1 to emit additional data. This would help reduce/eliminate the Code Verification check error. Please run following command:

      `dotnet msbuild eng/mgmt.proj /t:Util /p:UtilityName=InstallPsModules`
    

Old outstanding PR cleanup

Please note:
If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

@allenjzhang
Copy link
Contributor

Please include eng\mgmt\mgmtmetadata\compute_resource-manager.txt so code verification can match the correct commit id.

@Sandido
Copy link
Contributor

Sandido commented Jul 13, 2021

@roipmsft , as per Allen's comment, please make updates to the files needed for the release notes and version.
https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/73168/SDK-(.NET)?anchor=creating-a-pr

@roipmsft roipmsft changed the title Dev/roip/restore point properties bag SDK tests for Restore Points using updated C# SDK Jul 13, 2021
/// customer wishes to exclude from the restore point. If no disks are
/// specified, all disks will be included.</param>
public RestorePoint(string id = default(string), string name = default(string), string type = default(string), RestorePointSourceMetadata sourceMetadata = default(RestorePointSourceMetadata), string provisioningState = default(string), string consistencyMode = default(string), RestorePointProvisioningDetails provisioningDetails = default(RestorePointProvisioningDetails), IList<ApiEntityReference> excludeDisks = default(IList<ApiEntityReference>))
public RestorePoint(string id = default(string), string name = default(string), string type = default(string), IList<ApiEntityReference> excludeDisks = default(IList<ApiEntityReference>), RestorePointSourceMetadata sourceMetadata = default(RestorePointSourceMetadata), string provisioningState = default(string), string consistencyMode = default(string), RestorePointProvisioningDetails provisioningDetails = default(RestorePointProvisioningDetails))

Choose a reason for hiding this comment

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

Why change the parameter orders here? It's a breaking change.

Copy link
Contributor Author

@roipmsft roipmsft Jul 14, 2021

Choose a reason for hiding this comment

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

  1. this was generated automatically by the AutoRest. i did not intentionally change this
  2. This PR (and the Swagger PR on which this PR is based) does have breaking changes. However, Jeffrey Richter and BreakingChanges Review Board team approved it (because no customers are currently using the api. this feature is still in private preview)
    Swagger PR that was merged, with approval by breaking change review board: Move RestorePoint properties into new properties bag for restore point azure-rest-api-specs#14638

@YalinLi0312
Copy link

@roipmsft I see you checked the second box in the checklist, but I don't see the swagger link. Could you provide it?

@roipmsft
Copy link
Contributor Author

@roipmsft I see you checked the second box in the checklist, but I don't see the swagger link. Could you provide it?

sorry here it is. i will add it to PR description too.
the brekaing changes were approved by Jeffrey Richter
Azure/azure-rest-api-specs#14638

Copy link

@YalinLi0312 YalinLi0312 left a comment

Choose a reason for hiding this comment

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

LGTM

@YalinLi0312 YalinLi0312 merged commit 70896b8 into Azure:main Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants