Skip to content
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

[Azure Search] V10.0.1 Re-enable XML docs #7786

Merged
merged 2 commits into from
Sep 27, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion sdk/search/Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
<Choose>
<When Condition="'$(IsDataPlaneProject)' == 'true'">
<PropertyGroup>
<VersionPrefix>10.0.0</VersionPrefix>
<VersionPrefix>10.0.1</VersionPrefix>
Copy link
Member

@weshaggard weshaggard Sep 27, 2019

Choose a reason for hiding this comment

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

As an FYI we are starting to use the versioning guidance we have outline at https://github.com/Azure/azure-sdk/blob/master/docs/policies/releases.md#package-versioning. Which generally means we should bump the minor version after a QA release so that we always have versioning space for hotfixes, it they are necessary. Assuming there aren't any other changes to search then I think this would qualify as a hotfix but I wanted to at least point out our docs if you guys haven't had the chance to review them yet.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for the pointer. I think this qualifies as a hotfix, although we didn't follow the branching guidance this time.

Copy link
Member

Choose a reason for hiding this comment

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

We also have document on the branching workflows at https://github.com/Azure/azure-sdk/blob/master/docs/policies/repobranching.md#hotfix-branches incase you guys haven't seen that either.

<DocumentationFile>$(IntermediateOutputPath)$(TargetFramework)\$(MSBuildProjectName).xml</DocumentationFile>
</PropertyGroup>
</When>
</Choose>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
<AssemblyTitle>Microsoft Azure Search Data Library</AssemblyTitle>
<TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
<PackageReleaseNotes>See the Microsoft.Azure.Search package for detailed release notes on the entire Azure Search .NET SDK.</PackageReleaseNotes>

<!-- Disable warning for missing xml doc comments until we can add all the missing ones -->
<NoWarn>$(NoWarn);1573;1591</NoWarn>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Spatial" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
<AssemblyTitle>Microsoft Azure Search Service Library</AssemblyTitle>
<TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
<PackageReleaseNotes>See the Microsoft.Azure.Search package for detailed release notes on the entire Azure Search .NET SDK.</PackageReleaseNotes>

<!-- Disable warning for missing xml doc comments until we can add all the missing ones -->
<NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Spatial" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ public static class IndexesGetClientExtensions
/// <summary>
/// Creates a new index client for querying and managing documents in a given index.
/// </summary>
/// <param name="operations">The operation group for indexes of the Search service.</param>
/// <param name="indexName">The name of the index.</param>
/// <returns>A new <c cref="Microsoft.Azure.Search.SearchIndexClient">SearchIndexClient</c> instance.</returns>
/// <remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
<VersionPrefix>1.0.0</VersionPrefix>
<TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>

<!-- Disable warning for missing xml doc comments for test projects -->
<NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>

<PropertyGroup>
Expand Down