Skip to content

README documents Java 8 as the minimum requirement, but the build targets Java 11 #136

Description

@aymenmehri

The README documents a minimum requirement that the project no longer supports.

README.md (section Minimum Requirements) states:

Ensure you have Java 8 or higher installed.

However the build has targeted Java 11 for some time:

  • pom.xml configures maven-compiler-plugin with <release>11</release> (both in the main build and in the errorprone profile).
  • .github/workflows/integration.yml runs the compatibility matrix against java-version: [ '11', '17', '21' ] — Java 8 is never exercised.

Impact

A user who follows the README on a Java 8 toolchain hits a compilation failure with nothing pointing back at the documented requirement being wrong. <release>11</release> also means the published artifact carries class file major version 55, so Java 8 consumers cannot use the released jar either.

Additional inconsistency

maven-javadoc-plugin is still configured with <source>1.8</source> while the compiler targets 11, which is a leftover from the same migration.

Proposed fix

  • State Java 11 as the minimum requirement in the README.
  • Align the javadoc plugin's <source> with the compiler's <release>.

Happy to open a PR for this.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    Priority

    None yet

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions