Document Badge component experimental feature and exclude feature flags from jar#45
Document Badge component experimental feature and exclude feature flags from jar#45javier-godoy merged 2 commits intomasterfrom
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 51 minutes and 10 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe changes address enabling the Badge component as an experimental Vaadin feature. README documentation was added describing the Badge component requirement and two enablement methods. The Maven build configuration was updated to exclude the vaadin-featureflags.properties file from add-on artifacts. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pom.xml (1)
305-315:⚠️ Potential issue | 🟠 MajorMove the feature-flag exclusion to the top-level JAR configuration.
The
**/vaadin-featureflags.propertiesexclusion at line 313 applies only when thedirectoryprofile is active. Since this profile is not active by default, standard Maven builds (mvn package,mvn install) will include the feature flag file in the main add-on JAR. Move the exclusion to the globalmaven-jar-pluginconfig (lines 198–214) and leave theflow-build-info.jsonexclusion in the profile-specific configuration.🔧 Proposed fix
@@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>3.1.2</version> <configuration> + <excludes> + <exclude>**/vaadin-featureflags.properties</exclude> + </excludes> <archive> <index>true</index> @@ <!-- Generated file that shouldn't be included in add-ons --> <excludes> <exclude>META-INF/VAADIN/config/flow-build-info.json</exclude> - <exclude>**/vaadin-featureflags.properties</exclude> </excludes> </configuration>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@pom.xml` around lines 305 - 315, Move the <exclude>**/vaadin-featureflags.properties</exclude> entry out of the profile-specific <plugin> configuration and into the top-level maven-jar-plugin configuration so the vaadin-featureflags.properties file is excluded for standard builds; keep the <exclude>META-INF/VAADIN/config/flow-build-info.json</exclude> in the profile-specific plugin config. Update the global maven-jar-plugin (artifactId maven-jar-plugin) <excludes> to include **/vaadin-featureflags.properties and remove that exclude from the profile's maven-jar-plugin block.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 116-118: Wrap the feature-flag line
com.vaadin.experimental.badgeComponent=true in a fenced code block marked with
the properties language (i.e., add ```properties before and ``` after) so the
snippet renders consistently and resolves the MD040 markdownlint warning; update
the README.md snippet accordingly.
---
Outside diff comments:
In `@pom.xml`:
- Around line 305-315: Move the
<exclude>**/vaadin-featureflags.properties</exclude> entry out of the
profile-specific <plugin> configuration and into the top-level maven-jar-plugin
configuration so the vaadin-featureflags.properties file is excluded for
standard builds; keep the
<exclude>META-INF/VAADIN/config/flow-build-info.json</exclude> in the
profile-specific plugin config. Update the global maven-jar-plugin (artifactId
maven-jar-plugin) <excludes> to include **/vaadin-featureflags.properties and
remove that exclude from the profile's maven-jar-plugin block.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
github-project-automation
Bot
moved this from To Do
to Pending release
in Flowing Code Addons
2 participants
Close #43
Summary by CodeRabbit