Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into api-learn-api-act…
Browse files Browse the repository at this point in the history
…ivity
  • Loading branch information
annelo-msft committed Sep 19, 2020
2 parents 8b7b2d6 + acb51ab commit e483353
Show file tree
Hide file tree
Showing 6,491 changed files with 1,381,567 additions and 447,156 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
22 changes: 15 additions & 7 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/sdk/compute/ @bilaakpan-ms @sandido @dkulkarni-ms @haagha @madewithsmiles @MS-syh2qs @grizzlytheodore

# Service teams
# PRLabel: %AzConfig
# PRLabel: %App Configuration
/sdk/appconfiguration/ @annelo-msft @AlexanderSher

# PRLabel: %Batch
Expand All @@ -31,13 +31,13 @@
/sdk/cognitiveservices/vision.face/ @TFR258

# PRLabel: %DigitalTwins
/sdk/digitaltwins/ @drwill-ms @timtay-microsoft @abhipsaMisra @vinagesh @azabbasi @prmathur-microsoft @bikamani @barustum
/sdk/digitaltwins/ @drwill-ms @timtay-microsoft @abhipsaMisra @vinagesh @azabbasi @bikamani @barustum

# PRLabel: %Event Grid
/sdk/eventgrid/ @Kishp01 @ahamad-MS

# PRLabel: %Event Hubs
/sdk/eventhub/ @serkantkaraca @jsquire @kinelski
/sdk/eventhub/ @serkantkaraca @jsquire

# PRLabel: %Azure.Identity
/sdk/identity/ @schaabs @alexanderSher
Expand All @@ -57,25 +57,33 @@
/sdk/servicebus/Microsoft.*/ @nemakam

# PRLabel: %Storage
/sdk/storage/ @amishra-dev @seanmcc-msft @amnguye @kasobol-msft @tg-msft
/sdk/storage/ @tg-msft
/sdk/storage/Azure.Storage.*/ @amishra-dev @seanmcc-msft @amnguye @kasobol-msft @tg-msft

# PRLabel: %Tables
/sdk/tables/ @christothes

# PRLabel: %EngSys
/sdk/template/ @Azure/azure-sdk-eng

# PRLabel: %Cognitive - Text Analytics
/sdk/textanalytics/ @annelo-msft @maririos

# PRLabel: %Cognitive - Form Recognizer
/sdk/formrecognizer/ @annelo-msft @kinelski @maririos

# PRLabel: %Monitor - Exporter
/sdk/monitor/OpenTelemetry.*/ @cijothomas @reyang @rajkumar-rangaraj @TimothyMothra

# Smoke tests
/common/SmokeTests/ @AlexGhiondea @schaabs @heaths @tg-msft @jsquire

# Management Plane
/**/*Management*/ @allenjzhang
/**/*Management*/ @allenjzhang @m-nash @markcowl @YalinLi0312 @bquantump @nisha-bhatia
/**/Azure.ResourceManager*/ @allenjzhang @m-nash @markcowl @YalinLi0312 @bquantump @nisha-bhatia

# Reviewers to double check any API changes
/sdk/**/api/ @KrzysztofCwalina @pakrym @tg-msft
/sdk/**/api/ @KrzysztofCwalina @tg-msft

# Update AutoRest C#
/eng/CodeGeneration.targets @pakrym @ShivangiReja
Expand All @@ -84,6 +92,6 @@
# Eng Sys
###########
/eng/ @weshaggard @chidozieononiwu @mitchdenny @danieljurek
/eng/mgmt/ @allenjzhang
/eng/mgmt/ @allenjzhang @m-nash @markcowl
/**/tests.yml @danieljurek
/**/ci.yml @mitchdenny
13 changes: 13 additions & 0 deletions .github/pull_request_assignment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
- rule:
# management
paths:
- "sdk/**/Microsoft.Azure.Management*/**"
- "sdk/**/Azure.ResourceManger*/**"
reviewers:
- allenjzhang
- YalinLi0312
- bquantump
- m-nash
- markcowl
- nisha-bhatia
14 changes: 14 additions & 0 deletions .github/sla.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
- scheduleTask:
action: sendEmail
scope: pull_request
name: "send email given path change is in the CPlat SDK path"
trigger:
- path
args:
message: '<p>You have just completed the second step towards onboarding your API change to the Compute Management library.</p><p>You&#39;ve just opened a PR making changes in the Compute Management Library&#39;s path of the Azure .NET SDK repository.</p><p>What&#39;s next?</p><ol type="1"><li value="1">Your PR will be reviewed by a member of the OneSDK team and a member from our team</li><li>[If applicable] If you haven&#39;t already, you should get started on the design doc for your api&#39;s Azure PowerShell cmdlet.</li><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:
- "sdk/compute/**"
subject: "[Action Required] CPlat .NET SDK Pull Request opened: Next steps"
to: ${AUTHOR}
cc:
- cplatsdkdev@microsoft.com
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -164,4 +164,6 @@ node_modules/
msbuild.binlog

# BenchmarkDotNet
BenchmarkDotNet.Artifacts
BenchmarkDotNet.Artifacts

artifacts
15 changes: 6 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- Install VS 2019 (Community or higher) and make sure you have the latest updates (https://www.visualstudio.com/).
- Need at least .NET Framework 4.6.1 and 4.7 development tools
- Install the **.NET Core cross-platform development** workloads in VisualStudio
- Install **.NET Core 3.1.101 SDK** or higher for your specific platform. (https://dotnet.microsoft.com/download/dotnet-core/3.1)
- Install **.NET Core 3.1.301 SDK** for your specific platform. (or a higher version within the 3.1.*** band) (https://dotnet.microsoft.com/download/dotnet-core/3.1)
- Install the latest version of git (https://git-scm.com/downloads)
- Install [NodeJS](https://nodejs.org/en/) (13.x.x) if you plan to use [C# code generation](https://github.com/Azure/autorest.csharp).

Expand Down Expand Up @@ -195,7 +195,7 @@ string snippet = "some snippet code";

**\`\`\`**

See the following example of a [snippet C# file](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/Azure.Search.Documents/tests/Samples/HelloWorld.cs) and a [snippet markdown file](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/Azure.Search.Documents/samples/Sample01a_HelloWorld.md).
See the following example of a [snippet C# file](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/Azure.Search.Documents/tests/Samples/Sample01_HelloWorld.cs) and a [snippet markdown file](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/search/Azure.Search.Documents/samples/Sample01a_HelloWorld.md).
Note that snippet names need to be globally unique under a given service directory.

Snippets also can be integrated into XML doc comments. For example:
Expand Down Expand Up @@ -229,18 +229,15 @@ dotnet build eng\service.proj /p:ServiceDirectory=eventhub /p:UpdateSourceOnBuil
.NET is using the [ApiCompat tool](https://github.com/dotnet/arcade/tree/master/src/Microsoft.DotNet.ApiCompat) to enforce API compatibility between versions. Builds of GA'ed libraries will fail locally and in CI if there are breaking changes.

### How it works
We use a dummy project called [ApiCompat](https://github.com/Azure/azure-sdk-for-net/tree/master/eng/ApiCompat/ApiCompat.csproj) to enforce API compatibility between the GA'ed libraries and the most recent version available on Nuget. This project includes package references to the GA'ed library and to Microsoft.DotNet.ApiCompat.
Each library needs to provide a `ApiCompatVersion` property which is set to the last GA'ed version of the library which is used to compare APIs with the current to ensure no breaks
have been introduced.
The `ApiCompatVerification` target defined in `ApiCompat.csproj` is referenced in the [eng/Directory.Build.Data.targets](https://github.com/Azure/azure-sdk-for-net/blob/master/eng/Directory.Build.Data.targets) which causes this target to be executed for each csproj that has the `ApiCompatVersion` property set. For libraries that wish to disable the APICompat check they can remove the `ApiCompatVersion` property from their project. Our version bump automation will automatically add or increment the `ApiCompatVersion` property to the project when it detects that the version it is changing was a GA version which usually indicates that we just shipped that GA version and so it should be the new baseline for api checks.
Each library needs to provide a `ApiCompatVersion` property which is set to the last GA'ed version of the library that will be used to compare APIs with the current to ensure no breaks have been introduced. Projects with this property set will download the specified package and the ApiCompat (Microsoft.DotNet.ApiCompat) tools package as part of the restore step of the project. Then as a post build step of the project it will run ApiCompat to verify the current APIs are compatible with the last GA'ed version of the APIs. For libraries that wish to disable the APICompat check they can remove the `ApiCompatVersion` property from their project. Our version bump automation will automatically add or increment the `ApiCompatVersion` property to the project when it detects that the version it is changing was a GA version which usually indicates that we just shipped that GA version and so it should be the new baseline for API checks.

### Releasing a new version of a GA'ed libary
Since the [eng/Packages.Data.props](https://github.com/Azure/azure-sdk-for-net/blob/master/eng/Packages.Data.props) is currently maintained manually, you will need to update the version number for your library in this file when releasing a new version.

## Dev Feed
We publish daily built packages to a [dev feed](https://dev.azure.com/azure-sdk/public/_packaging?_a=feed&feed=azure-sdk-for-net) which can be consumed by adding the dev feed as a package source in Visual Studio.

Follow instructions provided [here](https://docs.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio#package-sources) and use `https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json` as the source.
Follow instructions provided [here](https://docs.microsoft.com/nuget/consume-packages/install-use-packages-visual-studio#package-sources) and use `https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json` as the source.

You can also achieve this from the command line.

Expand All @@ -258,7 +255,7 @@ Open your NuGet.config file to ensure that the dev feed source comes before the
</configuration>
```

You can then consume packages from this package source, remember to check the [Include prerelease](https://docs.microsoft.com/en-us/nuget/create-packages/prerelease-packages#installing-and-updating-pre-release-packages) box in Visual Studio when searching for the packages.
You can then consume packages from this package source, remember to check the [Include prerelease](https://docs.microsoft.com/nuget/create-packages/prerelease-packages#installing-and-updating-pre-release-packages) box in Visual Studio when searching for the packages.

To see the list of packages you can browse the [dev feed](https://dev.azure.com/azure-sdk/public/_packaging?_a=feed&feed=azure-sdk-for-net) and search for the package you are interested in. Or you can do it from the command line via `nuget.exe list -Prelease -Source "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json"`

Expand Down Expand Up @@ -461,7 +458,7 @@ Much of the management plane SDK code is generated from metadata specs about the

## Versioning

For more information on how we version see [Versioning](doc/dev/Versioning.md)
For more information on how we version see [Versioning](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/dev/Versioning.md)

## Breaking Changes

Expand Down
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<IntermediateOutputPath Condition="'$(PlatformName)' == 'AnyCPU'">$(BaseIntermediateOutputPath)$(Configuration)\</IntermediateOutputPath>
<IntermediateOutputPath Condition="'$(PlatformName)' != 'AnyCPU'">$(BaseIntermediateOutputPath)$(PlatformName)\$(Configuration)\</IntermediateOutputPath>

<PackageOutputPath>$(ArtifactsPackagesDir)</PackageOutputPath>
<PackageOutputPath>$(ArtifactsPackagesDir)/$(MSBuildProjectName)</PackageOutputPath>
</PropertyGroup>

<Import Project="$(RepoEngPath)\mgmt\Directory.Build.Mgmt.props" Condition="'$(IsDataPlaneProject)' != 'true'" />
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

[![Packages](https://img.shields.io/badge/packages-latest-blue.svg)](https://azure.github.io/azure-sdk/releases/latest/dotnet.html) [![Dependencies](https://img.shields.io/badge/dependency-report-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-net/dependencies/dependencies.html) [![Dependencies Graph](https://img.shields.io/badge/dependency-graph-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-net/dependencies/InterdependencyGraph.html)

This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our [public developer docs](https://docs.microsoft.com/en-us/dotnet/azure/) or our versioned [developer docs](https://azure.github.io/azure-sdk-for-net).
This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our [public developer docs](https://docs.microsoft.com/dotnet/azure/) or our versioned [developer docs](https://azure.github.io/azure-sdk-for-net).

## Getting started

To get started with a library, see the README.md file located in the library's project folder. You can find these library folders grouped by service in the /sdk directory.

For tutorials, samples, quick starts, and other documentation, go to [Azure for .NET Developers](https://docs.microsoft.com/en-us/dotnet/azure/).
For tutorials, samples, quick starts, and other documentation, go to [Azure for .NET Developers](https://docs.microsoft.com/dotnet/azure/).

## Packages available
Each service might have a number of libraries available from each of the following categories:
Expand All @@ -19,7 +19,7 @@ Each service might have a number of libraries available from each of the followi

### Client: New Releases

New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries follow the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet/guidelines/) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features at [Azure.Core](sdk/core/Azure.Core/README.md).
New wave of packages that we are announcing as **GA** and several that are currently releasing in **preview**. These libraries follow the [Azure SDK Design Guidelines for .NET](https://azure.github.io/azure-sdk/dotnet/guidelines/) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features at [Azure.Core](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md).

These new client libraries can be identified by the naming used for their folder, package, and namespace. Each will start with `Azure`, followed by the service category, and then the name of the service. For example `Azure.Storage.Blobs`.

Expand All @@ -29,7 +29,7 @@ For a complete list of available packages, please see the [latest available pack
### Client: Previous Versions

Last stable versions of packages that are production-ready. These libraries provide similar functionalities to the preview packages, as they allow you to use and consume existing resources and interact with them, for example: upload a storage blob. Stable library directories typically contain 'Microsoft.Azure' in their names, e.g. 'Microsoft.Azure.KeyVault'. They might not implement the [guidelines](https://azure.github.io/azure-sdk/dotnet_introduction.html) or have the same feature set as the Novemeber releases. They do however offer wider coverage of services.
Last stable versions of packages that are production-ready. These libraries provide similar functionalities to the preview packages, as they allow you to use and consume existing resources and interact with them, for example: upload a storage blob. Stable library directories typically contain 'Microsoft.Azure' in their names, e.g. 'Microsoft.Azure.KeyVault'. They might not implement the [guidelines](https://azure.github.io/azure-sdk/dotnet_introduction.html) or have the same feature set as the November releases. They do however offer wider coverage of services.

### Management: New Releases

Expand All @@ -48,7 +48,7 @@ Documentation and code samples for these libraries can be found [here](https://a
## Need help?

* For reference documentation visit the [Azure SDK for .NET API Reference](http://aka.ms/net-docs).
* For tutorials, samples, quick starts, and other documentation, go to [Azure for .NET Developers](https://docs.microsoft.com/en-us/dotnet/azure/).
* For tutorials, samples, quick starts, and other documentation, go to [Azure for .NET Developers](https://docs.microsoft.com/dotnet/azure/).
* File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-net/issues/new/choose).
* Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on StackOverflow using `azure` and `.net` tags.

Expand All @@ -61,7 +61,7 @@ Documentation and code samples for these libraries can be found [here](https://a
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) <secure@microsoft.com>. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue).

## Contributing
For details on contributing to this repository, see the [contributing guide](CONTRIBUTING.md).
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md).

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit
https://cla.microsoft.com.
Expand Down
12 changes: 0 additions & 12 deletions common/SmokeTests/smoke-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,6 @@ jobs:
steps:
- template: /eng/common/pipelines/templates/steps/verify-agent-os.yml

- task: UseDotNet@2
displayName: "Use .NET Core runtime $(DotNetCoreRuntimeVersion)"
inputs:
packageType: runtime
version: "$(DotNetCoreRuntimeVersion)"

- task: UseDotNet@2
displayName: "Use .NET Core sdk $(DotNetCoreSDKVersion)"
inputs:
packageType: sdk
version: "$(DotNetCoreSDKVersion)"

- task: PowerShell@2
inputs:
targetType: filePath
Expand Down
Loading

0 comments on commit e483353

Please sign in to comment.