Skip to content

Conversation

@sima-zhu
Copy link
Contributor

@sima-zhu sima-zhu commented Apr 5, 2022

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.
image
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:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

@check-enforcer
Copy link

check-enforcer bot commented Apr 5, 2022

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:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

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:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run java - [service] - ci

Copy link
Member

@danieljurek danieljurek left a comment

Choose a reason for hiding this comment

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

Two things

  1. How do we make sure the namespaces like com.microsoft.azure.management.resources.fluentcore.utils get put in the right places (either editing Doc-Toc.ps1 or ensuring that the metadata is exported properly)
  2. Resilience against Client Core being somewhere other than items[0]

@sima-zhu sima-zhu requested a review from danieljurek April 8, 2022 22:03
Copy link
Member

@danieljurek danieljurek left a 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.

@sima-zhu sima-zhu enabled auto-merge (squash) April 8, 2022 22:39
@sima-zhu sima-zhu merged commit c06ca71 into Azure:main Apr 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants