Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add support for Gradle Apt Plugin

Open
#134 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
java

Research direction

Start with the documented Gradle annotation-processing solution and compare it with the Gradle Apt Plugin configuration shown in the issue. Document how to configure Vert.x code generation with the plugin and Java 8 source compatibility so the reported processor warnings are addressed; done means the relevant documentation includes a working equivalent configuration.

Written by the indexing model from the issue text.

Description

I already have another package that uses annotation processing (immutables), and it doesn't play nicely with the documented Gradle solution for adding annotation processing.

immutables plugs in directly to the Gradle Apt Plugin (https://github.com/tbroyer/gradle-apt-plugin)

It would be nice if the CodeGen worked similarly for vertx.. I have it working with Warnings only via:

dependencies {
  compileOnly "org.immutables:value:2.4.4:annotations"
  apt group: 'org.immutables', name: 'value', version: '2.4.4'

  compileOnly group: 'io.vertx', name: 'vertx-codegen', version: vertxVersion
  apt group: 'io.vertx', name: 'vertx-codegen', version: vertxVersion
  apt group: 'io.vertx', name: 'vertx-docgen', version: vertxVersion
  apt group: 'io.vertx', name:'vertx-service-proxy', version:vertxVersion, classifier: 'processor'
}

This generates both sets of classes but my gradle output is littered with warnings:

warning: No SupportedSourceVersion annotation found on io.vertx.serviceproxy.ServiceProxyProcessor, returning RELEASE_6.
warning: Supported source version 'RELEASE_6' from annotation processor 'io.vertx.serviceproxy.ServiceProxyProcessor' less than -source '1.8'

I have java code and source compatibility set to 1.8 but can't figure out how to feed this in to avoid the warning. Hopefully this is just a documentation issue, would be helpful to add this as an option to the documentation for anyone else using the apt plugin.

Dominant language
Java
Stars
111
Forks
88
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from eclipse-vertx/vertx-codegen

All issues in eclipse-vertx/vertx-codegen

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.