GitHub client works on Jackson 2.21 (merge upstream 1.330)

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,15 +5,16 @@
 # 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](CONTRIBUTING.md) for details.
-- [ ] Add JavaDocs and other comments as appropriate. Consider including links in comments to relevant documentation on https://docs.github.com/en/rest .  
+- [ ] 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](CONTRIBUTING.md) for details.
-- [ ] Run `mvn -D enable-ci clean install site` locally. If this command doesn't succeed, your change will not pass CI.
+- [ ] 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 #<issue number>" lines for each issue. 
-  - [ ] Provide links to relevant documentation on https://docs.github.com/en/rest where possible.
+  - [ ] 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".

.github/workflows/codeql-analysis.yml

@@ -41,12 +41,18 @@ jobs:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
+    - name: Set up JDK
+      uses: actions/setup-java@v5
+      with:
+        distribution: 'temurin'
+        java-version: 17
+
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v5
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -57,7 +63,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -71,4 +77,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

.github/workflows/maven-build.yml

@@ -1,9 +1,10 @@
 name: CI
 
-on: 
+on:
   push:
     branches:
       - main
+      - main-2.x
       - '!/refs/heads/dependabot/*'
   pull_request:
     branches:
@@ -19,79 +20,63 @@ permissions:
 
 jobs:
   build:
-    name: build-only (Java ${{ matrix.java }})
+    name: build-only (Java 17)
     runs-on: ubuntu-latest
     strategy:
-      fail-fast: false
-      matrix:
-        java: [ 17 ]
+      fail-fast: true
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up JDK
-        uses: actions/setup-java@v3
-        with:
-          java-version: ${{ matrix.java }}
-          distribution: 'zulu'
-          cache: 'maven'
-      - name: Maven Install (skipTests)
-        env:
-          MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-        run: mvn -B clean install -DskipTests --file pom.xml
+    - uses: actions/checkout@v5
+    - name: Set up JDK
+      uses: actions/setup-java@v5
+      with:
+        java-version: 17
+        distribution: 'temurin'
+        cache: 'maven'
+    - name: Maven Install (skipTests)
+      env:
+        MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
+      run: mvn -B clean install -DskipTests --file pom.xml
+    - uses: actions/upload-artifact@v4
+      with:
+        name: maven-target-directory
+        path: target/
+        retention-days: 3
   site:
-    name: site (Java ${{ matrix.java }})
+    name: site (Java 17)
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
-      matrix:
-        java: [ 17 ]
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up JDK
-        uses: actions/setup-java@v3
-        with:
-          java-version: ${{ matrix.java }}
-          distribution: 'adopt'
-          cache: 'maven'
-      - name: Maven Site
-        env:
-          MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-        run: mvn -B  clean site -D enable-ci --file pom.xml
-  test-8:
-    name: test (${{ matrix.os }}, Java 8)
-    runs-on: ${{ matrix.os }}-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ ubuntu ]
-        java: [ 8 ]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v5
     - name: Set up JDK
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v5
       with:
-        java-version: ${{ matrix.java }}
-        distribution: 'zulu'
+        java-version: 17
+        distribution: 'temurin'
         cache: 'maven'
-    # JDK 8
-    - name: Maven Install with Code Coverage
-      run: mvn -B clean install -D enable-ci -Djapicmp.skip --file pom.xml
-    - name: Codecov Report 
-      uses: codecov/codecov-action@v3.1.1
+    - name: Maven Site
+      env:
+        MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
+      # running install site seems to more closely imitate real site deployment,
+      # more likely to prevent failed deployment
+      run: mvn -B clean install site -DskipTests --file pom.xml
   test:
     name: test (${{ matrix.os }}, Java ${{ matrix.java }})
+    # Does not require build output, but orders execution to prevent launching test workflows when simple build fails 
+    needs: build
     runs-on: ${{ matrix.os }}-latest
     strategy:
       fail-fast: false
       matrix:
         os: [ ubuntu, windows ]
-        java: [ 11, 17 ]
+        java: [ 17, 21 ]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v5
     - name: Set up JDK
-      uses: actions/setup-java@v3
+      uses: actions/setup-java@v5
       with:
         java-version: ${{ matrix.java }}
-        distribution: 'zulu'
+        distribution: 'temurin'
         cache: 'maven'
     # JDK 11+
     - name: Maven Install without Code Coverage
@@ -104,18 +89,71 @@ jobs:
       env:
         MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
       run: mvn -B clean install -D enable-ci --file pom.xml "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"
+    - name: Save coverage data
+      if: matrix.os == 'ubuntu' && matrix.java == '17'
+      uses: actions/upload-artifact@v4
+      with:
+        name: maven-test-target-directory
+        path: target/
+        retention-days: 3
+
+  test-java-8:
+    name: test Java 8 (no-build)
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/download-artifact@v4
+      with:
+        name: maven-target-directory
+        path: target
+    - name: Set up JDK
+      uses: actions/setup-java@v4
+      with:
+        java-version: 8
+        distribution: 'temurin'
+        cache: 'maven'
+    - name: Maven Test (no build) Java 8
+      run: mvn -B surefire:test -DfailIfNoTests -Dsurefire.excludesFile=src/test/resources/slow-or-flaky-tests.txt
+
+  test-java-11:
+    name: test Java 11 (no-build)
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+    - uses: actions/download-artifact@v5
+      with:
+        name: maven-target-directory
+        path: target
+    - name: Set up JDK
+      uses: actions/setup-java@v5
+      with:
+        java-version: 11
+        distribution: 'temurin'
+        cache: 'maven'
+    - name: Maven Test (no build) Java 11
+      run: mvn -B surefire:test -DfailIfNoTests -Dsurefire.excludesFile=src/test/resources/slow-or-flaky-tests.txt
+
   deploy:
     name: Deploy
+    # Publish only from main: a pull request run must never claim a version in GitHub Packages.
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: [build, site, test, test-java-8, test-java-11]
     runs-on: ubuntu-latest
-    needs: [build, test-8, test]
+    permissions:
+      contents: read
+      packages: write
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-java@v2
-        with:
-          java-version: 8
-          distribution: 'zulu'
-          cache: 'maven'
-      - name: Deploy
-        run: mvn --batch-mode deploy
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - uses: actions/checkout@v5
+    - name: Set up JDK
+      uses: actions/setup-java@v5
+      with:
+        java-version: 17
+        distribution: 'temurin'
+        cache: 'maven'
+    - name: Deploy
+      env:
+        MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: mvn -B deploy -DskipTests --file pom.xml

.github/workflows/release-drafter.yml

@@ -17,6 +17,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release Drafter
-        uses: release-drafter/release-drafter@v5
+        uses: release-drafter/release-drafter@v6
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}        

.gitignore

@@ -6,6 +6,7 @@ target
 .classpath
 .project
 .settings/
+.metadata/
 .DS_Store
 
 dependency-reduced-pom.xml

CONTRIBUTING.md

@@ -8,7 +8,7 @@ Run `mvn spotless:apply` to fix any formatting, etc issues.
 
 If the following does not succeed, you will not pass the pull request checks.
 
-`mvn -D enable-ci clean install site` 
+`mvn -D enable-ci clean install site "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"` 
 
 ## Using WireMock and Snapshots
 
@@ -73,6 +73,9 @@ a Java VM option). For example:
 The above command will create snapshot WireMock data files under the path `src/test/resources/org/kohsuhke/github/YourTestClassName/wiremock`.
 Each method will get a separate directory that will hold the data files for that test method.
 
+*Note:* if you are using personal github account don't forget to change `getTempRepository()` to `gitHub.getRepository("${your_account}/${test_method_name}")`
+in order to match with snapshot file name for wiremock. To double-check run test without `-Dtest.github.org=false` flag after snapshot is saved.
+
 Add all files including the generated data to your commit and submit a PR.
 
 ### Modifying existing tests
@@ -82,7 +85,7 @@ When modifying existing tests, you can change the stubbed WireMock data files by
 #### Manual editing of data (minor changes only)
 
 If you know what data will change, it is sometimes simplest to make any required changes to the data files manually.
-This can be easier if the changes are minor or when you development environment is not setup to to take updated snapshots.
+This can be easier if the changes are minor or when you development environment is not setup to take updated snapshots.
 
 #### Generating a new snapshot
 

README.md

@@ -6,10 +6,11 @@
 [![codecov](https://codecov.io/gh/hub4j/github-api/branch/main/graph/badge.svg?token=j1jQqydZLJ)](https://codecov.io/gh/hub4j/github-api)
 
 
-See https://github-api.kohsuke.org/ for more details
+See https://hub4j.github.io/github-api/ for more details
 
 To locally publish changes to this API, update the version in `pom.xml` to a unique identifier.
 Then run `mvn install -Dmaven.test.skip -Dspotless.check.skip=true -Dgpg.skip -Dmaven.javadoc.skip=true -Djacoco.skip=true -Dspotbugs.skip`. 
 To use this dependency in `brain-backend`, update the version of `cortexapps-github-api` in `build.gradle.kts (:web)` to the same identifier.
 
-See this [Notion doc](https://www.notion.so/cortexio/How-to-publish-Github-Api-e80324a13abf4497afaa67e0a215e53a) for how to publish this client.
+Merging to `main` publishes the `pom.xml` version to GitHub Packages through the CI `deploy` job, so bump the version in the same PR.
+See this [Notion doc](https://www.notion.so/cortexio/How-to-publish-Github-Api-e80324a13abf4497afaa67e0a215e53a) for more on publishing this client.