Skip to content

Improve README instructions #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
beckermarc wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve README instructions #132

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e07892d
Improve README instructions
beckermarc Oct 30, 2025
aa7d582
Correct approach using annotation processor
beckermarc Oct 30, 2025
669bc0b
JDK 23 instead of 25
beckermarc Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,8 @@ This library requires Java 17 or newer.

Add the following dependency in your POM. (This dependency is not needed at runtime, but it is necessary
for compilation of source code that transitively depend on this, so it is the simplest to just treat
this like a regular library dependency)
this like a regular library dependency. Alternatively declare it as `<optional>true</optional>` to
prevent it from being present at runtime.)

```xml
<dependency>
Expand Down Expand Up @@ -178,3 +179,24 @@ Then put the following fragment in your build to have the byte-code post process
</plugins>
</build>
```

In case you list annotation processors paths explicitly in your `maven-compiler-plugin` configuration (required as of JDK 23),
ensure to include `org.jenkins-ci:annotation-indexer` as well, as it is a prerequisite for the `bridge-method-injector`
Maven plugin to detect classes with `@WithBridgeMethods` annotations.

```xml
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<!-- ... -->
<annotationProcessorPaths>
<!-- ... -->
<path>
<groupId>org.jenkins-ci</groupId>
<artifactId>annotation-indexer</artifactId>
<version>1.18</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
```