KEMBAR78
fix: update DocFX profile by alicejli · Pull Request #1603 · googleapis/java-firestore · GitHub
Skip to content

fix: update DocFX profile #1603

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 12, 2024
Merged

fix: update DocFX profile #1603

merged 1 commit into from
Mar 12, 2024

Conversation

@alicejli
Copy link
Contributor

Currently, firestore cloud.google.com DocFX generation fails:

Error: 5:736 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.6.3:aggregate (default-cli) on project google-cloud-firestore-parent: An error has occurred in Javadoc report generation: 
Error: 5:736 [ERROR] Exit code: 1
Error: 5:736 [ERROR] Note: Doclet using locale: en
Error: 5:736 [ERROR] /home/runner/work/java-shared-config/java-shared-config/sdk-platform-java/java-firestore/google-cloud-firestore-admin/src/main/java/com/google/cloud/firestore/v1/package-info.java:66: warning: a package-info.java file has already been seen for package com.google.cloud.firestore.v1
Error: 5:736 [ERROR] package com.google.cloud.firestore.v1;
Error: 5:736 [ERROR]                                   ^

The current DocFX profile excludes that file for this reason: https://github.com/googleapis/java-firestore/blob/main/pom.xml#L263.
However, there was a recent change made to the shared DocFX profile (googleapis/java-shared-config#744) that removed some of these properties due to an unrelated issue caused by the maven-javadoc-plugin upgrade to 3.6.3 that no longer allows null parameters to be passed in. That change caused this property to no longer be respected with DocFX generation.

This PR updates the Firestore profile such that the file exclusion property should be respected during javadoc generation (to be confirmed in googleapis/java-shared-config#771).

@alicejli alicejli requested review from a team as code owners March 11, 2024 14:53
@product-auto-label product-auto-label bot added size: s Pull request size is small. api: firestore Issues related to the googleapis/java-firestore API. labels Mar 11, 2024
@alicejli alicejli added the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 11, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 11, 2024
@alicejli alicejli merged commit 0a2eb16 into main Mar 12, 2024
@alicejli alicejli deleted the updateDocFXconfig branch March 12, 2024 13:39
@release-please release-please bot mentioned this pull request Mar 12, 2024
Merged
@release-please release-please bot mentioned this pull request May 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@burkedavison burkedavison burkedavison approved these changes

Assignees

No one assigned

Labels

api: firestore Issues related to the googleapis/java-firestore API. size: s Pull request size is small.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@alicejli @burkedavison