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

Set skipPublishDocMs to true for packages which do not build docs #36385

Merged
merged 3 commits into from
Sep 7, 2023

Conversation

danieljurek
Copy link
Member

@danieljurek danieljurek commented Aug 17, 2023

You are on this PR review because you are a CODEOWNER reviewer. Please have a look at your service and package and let me know if you have concerns about skipping building docs.ms documentation for the following excluded packages.

The following packages do not build docs. This encodes the fact that those packages are not intended to be documented (as opposed to filtering by our validation heuristics).

Impacted packages:

  • sdk/aot
    • azure-aot-graalvm-support
    • azure-aot-graalvm-support-netty
  • sdk/core
    • azure-core-exprimental
    • azure-core-test
  • sdk/cosmos
  • sdk/personalizer
    • azure-ai-personalizer @sharathmalladi -- there are no java docs in this package. Is this intended?
  • sdk/storagemover
    • azure-resourcemanager-storagemover
  • sdk/template -- straightforward: we shouldn't be publishing docs.ms docs for templates
    • azure-sdk-template
    • azure-sdk-template-two
    • azure-sdk-template-three
  • sdk/voiceservices
    • azure-resourcemanager-voiceservices

@joshfree
Copy link
Member

/aot, /core, and /template are fine.

Just need an ack from cosmos (@kushagraThapar), mgmt (@weidongxu-microsoft), and personalizer (@sharathmalladi)

@joshfree joshfree added this to the 2023-10 milestone Aug 30, 2023
@joshfree joshfree added the Central-EngSys This issue is owned by the Engineering System team. label Aug 30, 2023
@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented Aug 31, 2023

Thanks Josh.

Hi Daniel, does voiceservices and storagemover there because the service was deprecated?

I am OK if service of them does not want they get to MsDoc.

@danieljurek
Copy link
Member Author

@weidongxu-microsoft -- From notes in our Language-Settings.ps1 file:

  "azure-resourcemanager-voiceservices" = "Doc build attempts to download a package that does not have published sources.";
  "azure-resourcemanager-storagemover" = "Attempts to azure-sdk-build-tool and fails";

Generally speaking, to make these work in the docs build a new version would need to be released which addresses these issues.

@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented Sep 4, 2023

Thanks @danieljurek. I am OK for the "resourcemanager" packages, if they currently fails.

Is there any way we can test if a new release of them would pass the doc build? (local run of doc build? some pipeline maybe run from dev branch?)

Reason is that there seems nothing special from storagemover or voiceservices. And both lib is fully generated by tool, which is used for other 100+ libs as well. (Maybe the problem is from Javadoc in the code)
https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/storagemover/azure-resourcemanager-storagemover/pom.xml
https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/voiceservices/azure-resourcemanager-voiceservices/pom.xml
Therefore SDK dev may still need to figure out why doc build fails for these 2 libs.


follow-up issue logged #36646 (label: MQ)

@danieljurek
Copy link
Member Author

@weidongxu-microsoft -- Sent email with instructions.

@danieljurek
Copy link
Member Author

I spoke with @kushagraThapar -- this package is intended to be documented so no changes to the ci.yml in this PR.

@danieljurek danieljurek enabled auto-merge (squash) September 6, 2023 18:49
@danieljurek
Copy link
Member Author

Spoke with @alzimmermsft, the test failures in the java - core - ci pipeline are the result of flaky tests (different ones fail on different runs). This PR is OK to merge.

@danieljurek
Copy link
Member Author

/check-enforcer override

@danieljurek danieljurek merged commit f84db5b into main Sep 7, 2023
@danieljurek danieljurek deleted the djurek/ignore-undocumentable-packages branch September 7, 2023 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Azure.Core azure-core Central-EngSys This issue is owned by the Engineering System team. Cosmos EngSys This issue is impacting the engineering system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants