fix: javadoc error on-merge action #1599
Conversation
…ty profile Signed-off-by: Alexandra Oberaigner <alexandra.oberaigner@dynatrace.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @alexandraoberaigner, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request aims to resolve a Javadoc generation error in the CI/CD pipeline and improve the Maven build profile structure. It ensures that Javadocs are correctly generated and visible by adjusting the build process and making a specific builder class public for documentation purposes.
Highlights
- Javadoc Generation Fix: Addresses a Javadoc generation error observed in GitHub Actions by moving the Javadoc generation process to the
codequalityMaven profile. This ensures Javadocs are generated during PR checks rather than during thedeploystep. - Maven Profile Restructuring: The
deployMaven profile inpom.xmlhas been refactored. The Javadoc and source generation plugins were moved out of the maindeployprofile, and thecentral-publishing-maven-pluginwas moved into its owndeployprofile. This separation clarifies responsibilities and aligns with the new Javadoc generation strategy. - Javadoc Visibility for Builder: A public static inner class
HookContextWithoutDataBuilderwas added toHookContextWithoutData.javato make the builder visible for Javadoc generation, resolving potential issues with documentation for this component.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
alexandraoberaigner
changed the title
There was a problem hiding this comment.
Code Review
This pull request refactors the Maven build process by moving the Javadoc and source generation to the codequality profile, which is a sensible change to run these tasks during PR checks. Additionally, it correctly exposes a Lombok-generated builder to resolve a visibility issue. My review includes a suggestion to improve the Javadoc for this builder to better describe its purpose to consumers of the API.
| </plugin> | ||
| <!-- End publish to maven central --> | ||
|
|
||
| <!-- Begin source & javadocs being generated --> |
There was a problem hiding this comment.
[INFO] the diff looks a bit weird here. Actually this section source & javadocs being generated was moved from the deploy profile to the codequality profile
See the PR's action logs for the plugin to be run in the verify maven step:
[INFO] Building jar: /home/runner/work/java-sdk/java-sdk/target/sdk-1.17.0-javadoc.jar
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1599 +/- ##
============================================
+ Coverage 92.82% 93.00% +0.18%
- Complexity 487 504 +17
============================================
Files 46 50 +4
Lines 1170 1215 +45
Branches 103 106 +3
============================================
+ Hits 1086 1130 +44
- Misses 54 55 +1
Partials 30 30
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
This PR
fixes this error in the action on merge & moves the javadoc generation to the codequality profile (which is run on the PR and not the deploy step on-merge or release actions)
How to test
should be tested now by PR github actions or run mvn clean verify locally