Skip to content

Conversation

@pvillard31
Copy link
Contributor

Description

See #2173 for the initial PR and associated discussion.

This PR is the follow-up of #2182.

  • Design GitHubJackson interface with methods for reading/writing JSON Implement GitHubJackson2 and GitHubJackson3
  • Create DefaultGitHubJackson factory with programmatic selection
  • Create GitHubJacksonException wrapper classes
  • Add GitHubBuilder.withJackson() for configuring Jackson implementation
  • Add testing infrastructure for both Jackson versions

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".

Design GitHubJackson interface with methods for reading/writing JSON
Implement GitHubJackson2 and GitHubJackson3
Create DefaultGitHubJackson factory with programmatic selection
Create GitHubJacksonException wrapper classes
Add GitHubBuilder.withJackson() for configuring Jackson implementation
Add testing infrastructure for both Jackson versions
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.

1 participant