Merge pull request #1808 from jcabi/1807

Migrate to to jakarta.json and JUnit5

Author: yegor256

.github/workflows/license.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-24.04, windows-2022, macos-15]
-        java: [11, 21]
+        java: [17, 24]
     steps:
       - uses: actions/checkout@v5
       - uses: actions/setup-java@v4

.github/workflows/mvn.yml

@@ -1,10 +1,11 @@
+*.iml
 .classpath
+.claude/
 .DS_Store
 .idea/
 .log
 .project
 .settings/
-*.iml
 /.settings
 /bin
 node_modules/

.gitignore

@@ -1,4 +1,4 @@
-<img alt="logo" src="https://www.jcabi.com/logo-square.svg" width="64px" height="64px" />
+# GitHub API Object-Oriented Java Client
 
 [![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
 [![DevOps By Rultor.com](https://www.rultor.com/b/jcabi/jcabi-github)](https://www.rultor.com/p/jcabi/jcabi-github)
@@ -12,14 +12,15 @@
 [![Hits-of-Code](https://hitsofcode.com/github/jcabi/jcabi-github)](https://hitsofcode.com/view/github/jcabi/jcabi-github)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/jcabi/jcabi-github/blob/master/LICENSE.txt)
 
-This is a Java adapter to the [GitHub RESTful API](https://developer.github.com/v3/).
-There are a few other similar implementations on the market, but jcabi-github has a very strong
-focus on object-oriented principles of programming. On top of that,
-we have a unique implemenation of GitHub server-side functionality,
+This is a Java adapter to the [GitHub RESTful API].
+There are a few other similar implementations on the market,
+but jcabi-github has a very strong focus on
+object-oriented principles of programming. On top of that,
+we have a unique implementation of GitHub server-side functionality,
 which you can use in your unit tests, eliminating the necessity to connect
 to GitHub during unit/integration testing.
 Please, read the blog post
-[_Object-Oriented Github API_](https://www.yegor256.com/2014/05/14/object-oriented-github-java-sdk.html)
+[_Object-Oriented GitHub API_][blog]
 by [Yegor Bugayenko](https://www.yegor256.com), the creator of this library.
 
 Java 8 or higher is required.
@@ -29,69 +30,73 @@ More details are here: [github.jcabi.com](https://github.jcabi.com/).
 You may also get help in this [Telegram chat](https://t.me/elegantobjects).
 
 The set of classes in the
-[`com.jcabi.github`](https://static.javadoc.io/com.jcabi/jcabi-github/1.0/com/jcabi/github/package-frame.html)
+[`com.jcabi.github`][package]
 package is the object-oriented API. Use it like this:
 
-## Work with Github's API
-
-By default, the library works with Github's API (https://api.github.com)
+By default, the library works with [GitHub RESTful API]:
 
 ```java
 import com.jcabi.github.*;
 public class Main {
   public static void main(String[] args) throws IOException {
-    Github github = new RtGithub(".. your OAuth token ..");
+    GitHub github = new RtGitHub(".. your OAuth token ..");
     Repo repo = github.repos().get(
         new Coordinates.Simple("octocat/Hello-World")
     );
-    Issue issue = repo.issues().create("Test title", "Test description");
+    final Issue issue = repo.issues().create("Test title", "Test description");
     issue.comments().post("My first comment!");
   }
 }
 ```
 
-## Work with Github Enterprise or other
-
-If you want to work with Github's API through another domain, you can use the URI-constructors
-of class ``RtGithub``. For instance, if you have your own instance of Github deployed under the
-domain ``https://github.mydomain.com``, do the following:
+If you want to work with GitHub's API through another domain,
+you can use the URI-constructors
+of class `RtGitHub`. For instance, if you have your own instance
+of GitHub deployed under the
+domain `https://github.mydomain.com`, do the following:
 
 ```java
-final Github github = new RtGithub(URI.create("https://github.mydomain.com"));
+final GitHub github = new RtGitHub(URI.create("https://github.mydomain.com"));
 
 //OR
 
-final Github github = new RtGithub(
+final GitHub github = new RtGitHub(
     "<<oauth2_token>>",
     URI.create("https://github.mydomain.com")
 );
 
 //OR
 
-final Github github = new RtGithub(
+final GitHub github = new RtGitHub(
     "username", "password",
     URI.create("https://github.mydomain.com")
 );
 ```
 
-**DO NOT** change or mask your URIs! Using Github under a different domain is fine but do not
-change the URI **paths**. Changing the requests' paths is not possible since the whole architecture
-of this library relies on Github's URI paths.
+**DO NOT** change or mask your URIs!
+Using GitHub under a different domain is fine but do not
+change the URI **paths**. Changing the requests'
+paths is not possible since the whole architecture
+of this library relies on GitHub's URI paths.
 
-For more complex configurations, you can instantiate ``RtGithub`` with your own custom ``Request``, by using the [RtGithub(Request)](https://github.com/jcabi/jcabi-github/blob/master/src/main/java/com/jcabi/github/RtGithub.java#L147) constructor.
-Be sure to configure the ``Request`` properly. See how the [default Request](https://github.com/jcabi/jcabi-github/blob/master/src/main/java/com/jcabi/github/RtGithub.java#L82) is created -- you basically have to do the same thing.
+For more complex configurations, you can instantiate
+`RtGitHub` with your own custom `Request`,
+by using the [RtGitHub(Request)][RtGitHub] constructor.
+Be sure to configure the `Request` properly.
+See how the [default Request][Request]
+is created -- you basically have to do the same thing.
 
 ## Mock Implementation Of The API
 
-We also provide [`MkGithub`](https://static.javadoc.io/com.jcabi/jcabi-github/1.0/com/jcabi/github/mock/MkGithub.html),
+We also provide [MkGitHub],
 a mock version of the GitHub server, which
 you can use in your unit tests, for example:
 
 ```java
 import com.jcabi.github.*;
 public class FooTest {
-  public void submitsCommentToGithubIssue() {
-    final Repo repo = new MkGithub().repos().create(
+  public void submitsCommentToGitHubIssue() {
+    final Repo repo = new MkGitHub().repos().create(
       Json.createObjectBuilder().add("name", "test").build()
     );
     final Issue issue = repo.issues().create("how are you?", "");
@@ -112,45 +117,61 @@ the `master` branch, if they look correct.
 
 Please run Maven (3.1 or higher!) build before submitting a pull request:
 
-```
-$ mvn clean install -Pqulice
+```bash
+mvn clean install -Pqulice
 ```
 
 There are many integration tests that check our classes against
-live Github accounts. In order to run them, you should create
-a new Github OAuth access tokens
-([how?](https://help.github.com/articles/creating-an-access-token-for-command-line-use)),
+live GitHub accounts. In order to run them, you should create
+a new GitHub OAuth access tokens
+([how?][pat]),
 and provide them in command line, like this:
 
-```
-$ mvn clean install -Dit.test=RtGistITCase -Dfailsafe.github.key=<token> -Dfailsafe.github.key.second=<second-token> -Dfailsafe.github.repo=<repo>
+```bash
+mvn clean install -Dit.test=RtGistITCase -Dfailsafe.github.key=<token> \
+  -Dfailsafe.github.key.second=<second-token> -Dfailsafe.github.repo=<repo>
 ```
 
-Replace `<token>` and `<second-token>` with the OAuth access tokens of two different Github
-accounts. This test case will try to fork a gist from first account into second. Replace
-`<repo>` with the name of repository you create in your first account (for test purposes
-only), for example `yegor256/test`. OAuth access tokens should have permissions in their
-respective repos to all scopes needed by the integration test suite you want to run
+Replace `<token>` and `<second-token>` with the OAuth access tokens
+  of two different GitHub
+accounts. This test case will try to fork a gist from first account
+into second. Replace
+`<repo>` with the name of repository you create in your first account
+(for test purposes only), for example `yegor256/test`.
+OAuth access tokens should have permissions in their
+respective repos to all scopes needed by the integration test
+suite you want to run
 (including `delete_repo`, which is not set by default!).
 
-Please note that different integration tests may need keys with permissions to different
-[scopes](https://developer.github.com/v3/oauth/#scopes). To run all integration tests, the key should
+Please note that different integration tests may need keys with
+permissions to different
+[scopes](https://developer.github.com/v3/oauth/#scopes).
+To run all integration tests, the key should
 have the following OAuth scopes:
 
-  - `read:org`
-  - `repo`
-  - `delete_repo`
-  - `admin:public_key`
-  - `gist`
-  - `admin:repo_hook`
-  - `user`
-  - `user:email`
-
-`RtForksITCase` requires additional parameter `-Dfailsafe.github.organization=<organization>`
+- `read:org`
+- `repo`
+- `delete_repo`
+- `admin:public_key`
+- `gist`
+- `admin:repo_hook`
+- `user`
+- `user:email`
+
+`RtForksITCase` requires additional
+parameter `-Dfailsafe.github.organization=<organization>`
 where `<organization>` is an organization name to fork test github repository.
 
 In order to run static analysis checks only use this:
 
+```bash
+mvn clean install -DskipTests -Dinvoker.skip=true -Pqulice
 ```
-$ mvn clean install -DskipTests -Dinvoker.skip=true -Pqulice
-```
+
+[GitHub RESTful API]: https://developer.github.com/v3/
+[blog]: https://www.yegor256.com/2014/05/14/object-oriented-github-java-sdk.html
+[pat]: https://help.github.com/articles/creating-an-access-token-for-command-line-use
+[MkGitHub]: https://static.javadoc.io/com.jcabi/jcabi-github/1.0/com/jcabi/github/mock/MkGitHub.html
+[RtGitHub]: https://github.com/jcabi/jcabi-github/blob/master/src/main/java/com/jcabi/github/RtGitHub.java#L147
+[package]: https://static.javadoc.io/com.jcabi/jcabi-github/1.0/com/jcabi/github/package-frame.html
+[Request]: https://github.com/jcabi/jcabi-github/blob/master/src/main/java/com/jcabi/github/RtGitHub.java#L82

README.md

@@ -30,6 +30,7 @@ path = [
     "MANIFEST.MF",
     "README.md",
     "renovate.json",
+    "src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker"
 ]
 precedence = "override"
 SPDX-FileCopyrightText = "Copyright (c) 2025 Yegor Bugayenko"