Skip to content

Commit

Permalink
Adding new path-based rule for the Compute API (Azure#10253)
Browse files Browse the repository at this point in the history
This is a new yml rule that specifies a configuration helpful to the cplat (Compute Platform) sdk team. This configuration rule mainly specifies a path, here the Compute Management library's path, and an email that will be sent by the bot whenever a PR is opened and the PR changes are in the Compute Management library's path.
  • Loading branch information
madewithsmiles authored and 00Kai0 committed Oct 12, 2020
1 parent cf74628 commit a29a737
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/sla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,18 @@
subject: "Action Required: Please respond to issue ${URL}"
to: ${ASSIGNEE}
cc: vscswagger@microsoft.com

- scheduleTask:
action: sendEmail
scope: pull_request
name: "send email given path change"
trigger:
- path
args:
message: '<p>You have just completed the first step towards onboarding your API change to the Compute Management library.</p><p>We (<a href="mailto:cplatsdkdev@microsoft.com">the CPlatSDK/PowerShell team</a>) manage the Compute library&#39;s API and SDK for the following clients: Swagger (REST api), .NET SDK, and Azure PowerShell.</p><p>You&#39;ve just opened a PR making changes in the Compute Management Library&#39;s path of the Azure REST Api Specs repository.</p><p>What&#39;s next?</p><ol type="1"><li value="1">Your api specs need to be reviewed and approved by us and the ARM team</li><li>Make sure you that can generate the .NET SDK from your API specs using the Autorest tool (<a href="https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/73168/SDK-(.NET)?anchor=how-to-generate-the-sdk%3F">NET SDK autogeneration</a>)</li><li>While your specs are getting reviewed, you should be working on the .NET SDK. (<a href="https://github.com/Azure/azure-sdk-for-net/">SDK repo</a>)</li><ol type="a"><li value="1">Once you generate the .NET SDK, you need to create the SDK tests and perform recordings and playbacks. (<a href="https://dev.azure.com/msazure/AzureWiki/_wiki/wikis/AzureWiki.wiki/73168/SDK-(.NET)?anchor=how-to-set-up-testing-and-record-tests%3F">NET SDK testing</a>)</li><li>With the newly generated SDK with tests, you can make a pull request to the SDK repository.<br /> Make sure to add a reference to your Swagger pull request in the comments.</li></ol><li>[If applicable] At this stage, you can get started on the Azure PowerShell part.<ol type="a"><li value="1">All you need to do is send a design doc of any change/new Azure PowerShell cmdlet related to your api by creating an issue with your design <a href="https://github.com/Azure/azure-powershell-cmdlet-review-pr/issues">here</a>.<br>Then, send an email to <a href="mailto:azdevxpsdr@microsoft.com">azdevxpsdr@microsoft.com</a> with the issue number and cc our dl (<a href="mailto:cplatsdkdev@microsoft.com">cplatsdkdev@microsoft.com</a>) on the email, so we can leave comments on your design doc as well.</li><li>Once your PowerShell cmdlet design has been approved, send an email to&nbsp;<a href="mailto:cplatsdkdev@microsoft.com?subject=PowerShell%20Design%20Review%20Approved">our team</a><br /> We will implement and test the PowerShell cmdlet following the approved design. We will then make a pull request to the appropriate repository</li></ol><li>[If applicable] You can also get started on any Azure CLI module or extension for your API change. Find more information about next steps on that process <a href="https://github.com/Azure/azure-cli/blob/dev/doc/onboarding_guide.md">here</a>.</li></ol><hr><ul type="disc"><li>To view the full CPlat SDK PowerShell API onboarding wiki, please visit <a href="https://aka.ms/cplatsdk">aka.ms/cplatsdk</a></li></ul><p>This email was automatically sent. Please send an email to&nbsp;<a href="mailto:cplatsdkdev@microsoft.com">cplatsdkdev@microsoft.com</a>&nbsp;if you have any questions.</p>'
targetPaths:
- "specification/compute/resource-manager/Microsoft.Compute/**"
subject: "[Action Required] CPlat Swagger Pull Request opened: Next steps"
to: ${AUTHOR}
cc:
- cplatsdkdev@microsoft.com

0 comments on commit a29a737

Please sign in to comment.