fix(go-feature-flag): Fix javadoc generation blocking release please #1592
Conversation
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>
![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 @thomaspoignant, 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 critical issue preventing the release of the GOFF Java provider by adjusting the Javadoc generation configuration within the pom.xml. It removes previously added exclusions for certain files and packages, which were inadvertently causing build failures during the Javadoc phase. The primary goal is to enable successful Javadoc generation and unblock the release pipeline.
Highlights
- Javadoc Configuration Update: The
pom.xmlfile has been modified to remove specific file and package exclusions from the Javadoc generation process. - Release Blocking Fix: This change directly addresses an issue where Javadoc generation failures were preventing the successful release of the GOFF Java provider.
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. ↩
There was a problem hiding this comment.
Code Review
This pull request aims to fix a Javadoc generation failure by removing exclusions for the go-feature-flag provider in the pom.xml. The change correctly removes the <sourceFileExcludes> and cleans up the <excludePackageNames> to include previously ignored files in the Javadoc process. This is a direct and reasonable approach to resolve the build issue and increase documentation coverage. The changes in the pom.xml are correct and well-formed.
|
@thomaspoignant i think we have to look further back, because this configuration was already in place when i did the other pr - it was just moved. it was introduced in #111 but as this happened in 2022 i think nobody know why anymore :D Maybe @toddbaert knows why |
|
Yes this was a long time ago. |
3 participants
The release of the GOFF java provider did not succeed because of the javadoc generation.
See https://github.com/open-feature/java-sdk-contrib/actions/runs/17834482866/job/50708225137
I've spotted some configuration in the
pom.xmlexcluding some GOFF files (not sure why).In this PR we remove the exclusions.
Those exclusion have been introduced in this PR #1387 and I don't really understand the reason why.
@aepfli if you can help me to understand this would be really great.