Skip to content
This repository was archived by the owner on Feb 6, 2026. It is now read-only.

ci: javadoc job (JDK 17) in ci.yaml (#1819)#1386

Merged
gcf-merge-on-green[bot] merged 3 commits intomainfrom
owl-bot-update-lock-31c8276a1bfb43766597d32645721c029cb94571f1b8d996cb2c290744fe52f9
Jul 7, 2023
Merged

ci: javadoc job (JDK 17) in ci.yaml (#1819)#1386
gcf-merge-on-green[bot] merged 3 commits intomainfrom
owl-bot-update-lock-31c8276a1bfb43766597d32645721c029cb94571f1b8d996cb2c290744fe52f9

Conversation

@gcf-owl-bot
Copy link
Contributor

@gcf-owl-bot gcf-owl-bot bot commented Jun 27, 2023

This also changes the JDK distribution from zulu to temurin
https://github.com/actions/setup-java#eclipse-temurin
Source-Link: googleapis/synthtool@ef9fe2e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:31c8276a1bfb43766597d32645721c029cb94571f1b8d996cb2c290744fe52f9

@gcf-owl-bot
ci: javadoc job (JDK 17) in ci.yaml (#1819)
fff3f50 
This also changes the JDK distribution from zulu to temurin
https://github.com/actions/setup-java#eclipse-temurin
Source-Link: googleapis/synthtool@ef9fe2e
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:31c8276a1bfb43766597d32645721c029cb94571f1b8d996cb2c290744fe52f9
@gcf-owl-bot gcf-owl-bot bot requested review from a team June 27, 2023 18:55
@trusted-contributions-gcf trusted-contributions-gcf bot added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Jun 27, 2023
@product-auto-label product-auto-label bot added size: s Pull request size is small. api: logging Issues related to the googleapis/java-logging API. labels Jun 27, 2023
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 27, 2023
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 27, 2023
@suztomo
Copy link
Member

suztomo commented Jun 28, 2023 •
edited
Loading

Errors : https://github.com/googleapis/java-logging/actions/runs/5393565667/jobs/9793484162?pr=1386

Error:  /home/runner/work/java-logging/java-logging/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java:149: error: reference not found
Error:    /** @deprecated Please use {@link #ofProjectName()} instead */
Error:                                      ^
Error:  /home/runner/work/java-logging/java-logging/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java:160: error: reference not found
Error:    /** @deprecated Please use {@link #ofOrganizationName()} instead */
Error:                                      ^
Error:  /home/runner/work/java-logging/java-logging/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java:171: error: reference not found
Error:    /** @deprecated Please use {@link #ofFolderName()} instead */
Error:                                      ^
Error:  /home/runner/work/java-logging/java-logging/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java:182: error: reference not found
Error:    /** @deprecated Please use {@link #ofBillingAccountName()} instead */
Error:                                      ^
Error:  /home/runner/work/java-logging/java-logging/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java:197: error: reference not found
Error:    /** @deprecated Please use {@link #formatProjectName()} instead */
Error:                                      ^
Error:  /home/runner/work/java-logging/java-logging/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java:208: error: reference not found
Error:    /** @deprecated Please use {@link #formatOrganizationName()} instead */
Error:                                      ^
Error:  /home/runner/work/java-logging/java-logging/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java:219: error: reference not found
Error:    /** @deprecated Please use {@link #formatFolderName()} instead */
Error:                                      ^
Error:  /home/runner/work/java-logging/java-logging/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java:233: error: reference not found
Error:    /** @deprecated Please use {@link #formatBillingAccountName()} instead */
Error:                                      ^

@losalex Would you fix the javadoc failure on JDK 17? If it's too much or you're busy, I can take care of them.

(warnings are just warnings. Focus on errors)

@suztomo
Copy link
Member

suztomo commented Jun 30, 2023

Echanged messages. I'll take care of this.

@losalex losalex removed their assignment Jul 3, 2023
@suztomo
Copy link
Member

suztomo commented Jul 5, 2023

The javadoc was complaining about the missing type parameter in the @link annotation:

  /** @deprecated Please use {@link #ofProjectName()} instead */
  @Deprecated
  public static CmekSettingsName ofProjectCmekSettingsName(String project) {
    return newBuilder().setProject(project).build();
  }

Supplying String there resolves the problem.

image

However, the class is generated by gapic-generator-java and https://github.com/googleapis/java-logging/blob/a3aa2ee2d8588ef2c9c265cb89a41ee68a5b0897/owlbot.py has the following replace rule:

    java.copy_and_rename_method('owl-bot-staging/v2/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java', 'public static CmekSettingsName ofProjectName(String project)', 'ofProjectName', 'ofProjectCmekSettingsName')
    java.deprecate_method('owl-bot-staging/v2/proto-google-cloud-logging-v2/src/main/java/com/google/logging/v2/CmekSettingsName.java','public static CmekSettingsName ofProjectCmekSettingsName(String project)', DEPRECATION_JAVADOC.format(new_method='ofProjectName'))
    s.replace('**/CmekSettingsName.java', 'return ofProjectName', 'return ofProjectCmekSettingsName')

Maybe we remove the @link annotation.

@suztomo
Copy link
Member

suztomo commented Jul 6, 2023 •
edited
Loading

I think owlbot.py should have this formatting below that includes method parameters, rather than existing "()".

>>> """Please use {{@link #{new_method}}} instead""".format(new_method='formatProjectName(String)')
'Please use {@link #formatProjectName(String)} instead'

@product-auto-label product-auto-label bot added size: m Pull request size is medium. and removed size: s Pull request size is small. labels Jul 7, 2023
@trusted-contributions-gcf trusted-contributions-gcf bot added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Jul 7, 2023
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 7, 2023
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 7, 2023
@suztomo
Copy link
Member

suztomo commented Jul 7, 2023 •
edited
Loading

The owlbot.py fix won't take effect until this pull request is merged and #1353 is regenerated. This pull request does not fix the javadoc job.

@suztomo suztomo added the automerge Merge the pull request once unit tests and other checks pass. label Jul 7, 2023
@trusted-contributions-gcf trusted-contributions-gcf bot added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Jul 7, 2023
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 7, 2023
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 7, 2023
@gcf-merge-on-green gcf-merge-on-green bot merged commit 094b3fa into main Jul 7, 2023
@gcf-merge-on-green gcf-merge-on-green bot deleted the owl-bot-update-lock-31c8276a1bfb43766597d32645721c029cb94571f1b8d996cb2c290744fe52f9 branch July 7, 2023 19:32
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Jul 7, 2023
@suztomo suztomo mentioned this pull request Jul 7, 2023
Merged
1 task
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@suztomo suztomo suztomo approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

api: logging Issues related to the googleapis/java-logging API. owl-bot-update-lock size: m Pull request size is medium.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@suztomo @kokoro-team @yoshi-kokoro @losalex