-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have only 1 nitty comment...
Which is to update the Release Notes :)
@@ -3,7 +3,8 @@ | |||
<Choose> | |||
<When Condition="'$(IsDataPlaneProject)' == 'true'"> | |||
<PropertyGroup> | |||
<VersionPrefix>10.0.0</VersionPrefix> | |||
<VersionPrefix>10.0.1</VersionPrefix> |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
XML docs were accidentally disabled after we shipped version 9.0.1, probably when upgrading to the new engineering system. This is probably why all the content from our .NET API reference went missing. This should hopefully restore it.