Skip to content

Conversation

@pvillard31
Copy link

@pvillard31 pvillard31 commented Dec 21, 2025

Description

Following discussion in #2166.
Fixes #2166.

For reference: https://github.com/FasterXML/jackson/blob/main/jackson3/MIGRATING_TO_JACKSON_3.md

These changes are only targeting the 2.x line since it may be considered as containing breaking changes and requires a minimum java version of Java 17.

Before submitting a PR:

  • Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
  • Add JavaDocs and other comments explaining the behavior.
  • When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
  • Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
  • Run mvn -D enable-ci clean install site "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED" locally. If this command doesn't succeed, your change will not pass CI.
  • Push your changes to a branch other than main. You will create your PR from that branch.

When creating a PR:

  • Fill in the "Description" above with clear summary of the changes. This includes:
    • If this PR fixes one or more issues, include "Fixes #" lines for each issue.
    • Provide links to relevant documentation on https://docs.github.com/en/rest where possible. If not including links, explain why not.
  • All lines of new code should be covered by tests as reported by code coverage. Any lines that are not covered must have PR comments explaining why they cannot be covered. For example, "Reaching this particular exception is hard and is not a particular common scenario."
  • Enable "Allow edits from maintainers".

<type>pom</type>
<scope>import</scope>
</dependency>
<!-- Jackson 3.0 requires jackson-annotations 2.20 -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

???

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bitwiseman
Copy link
Member

This is cool. I look forward to you fixing the build errors.

@pvillard31
Copy link
Author

Builds are green locally except for

Error: Failed to execute goal com.github.siom79.japicmp:japicmp-maven-plugin:0.23.1:cmp (default) on project github-api: There is at least one incompatibility: org.kohsuke.github.GitHub.getMappingObjectReader():METHOD_RETURN_TYPE_CHANGED,org.kohsuke.github.GitHub.getMappingObjectWriter():METHOD_RETURN_TYPE_CHANGED -> [Help 1]

which I believe is an expected breaking change.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Compatibility issue with Jackson 2.20 and above

2 participants