-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Remove * to prevent APIs go to wrong categories #28045
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
Conversation
|
This pull request is protected by Check Enforcer. What is Check Enforcer?Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass. Why am I getting this message?You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged. What should I do now?If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows: What if I am onboarding a new service?Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment: |
danieljurek
left a comment
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.
Two things
- How do we make sure the namespaces like
com.microsoft.azure.management.resources.fluentcore.utilsget put in the right places (either editing Doc-Toc.ps1 or ensuring that the metadata is exported properly) - Resilience against Client Core being somewhere other than
items[0]
danieljurek
left a comment
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.
After some further chatting with @JonathanGiles we can safely exclude azure-core-test from generating docs and exclude the remaining namespaces in the onboarding configuration in the docs repo.
Description
Please add an informative description that covers that changes made by the pull request and link all relevant issues.
*after namespaces cause the issue of sweeping the APIs under wrong package. Check the Netty and OkHttp.The fix will make the category correct.
Here is the review after the changes.
This is docindex pipeline:https://dev.azure.com/azure-sdk/internal/_build/results?buildId=1493056&view=results
Javadoc itself may not have the right namespaces.
Here are APIs not able to find toc namespace, and put into uncategorized packages after this change:
com.azure.core.test.annotation
com.azure.core.test.http
com.azure.core.test.models
com.azure.core.test.policy
com.azure.core.test.utils
com.microsoft.azure.management.resources.fluentcore.utils
com.microsoft.azure.sdk.iot.service.digitaltwin.authentication
com.microsoft.azure.sdk.iot.service.digitaltwin.generated
com.microsoft.azure.sdk.iot.service.digitaltwin.helpers
com.microsoft.azure.sdk.iot.service.digitaltwin.generated.models
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.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines
com.azure.core.test.annotation
com.azure.core.test.http
com.azure.core.test.models
com.azure.core.test.policy
com.azure.core.test.utils