Merge tag 'github-api-2.0-rc.4' into release/v2.x

github-api-2.0-rc.4

Author: bitwiseman

.github/workflows/create_release_tag_and_pr.yml

@@ -21,37 +21,39 @@ jobs:
           distribution: 'temurin'
           cache: 'maven'
 
-      - name: Reset staging/main
+      - name: Reset staging
         id: staging
         run: |
-          git checkout -B staging/main
-          git push --set-upstream -f origin staging/main
+          git checkout -B staging/$GITHUB_REF_NAME
+          git push --set-upstream -f origin staging/$GITHUB_REF_NAME
+        env:
+          GITHUB_REF_NAME: ${{ github.ref_name }}
 
       - name: Set Release Version
         id: release
         run: |
           mvn -B versions:set versions:commit -DremoveSnapshot 
           echo "version=$(mvn -B help:evaluate -Dexpression=project.version -q -DforceStdout)" >> $GITHUB_OUTPUT
 
-      - uses: stefanzweifel/git-auto-commit-action@v5
+      - uses: stefanzweifel/git-auto-commit-action@v6
         with:
           commit_message: "Prepare release (${{ github.actor }}): github-api-${{ steps.release.outputs.version }}" 
           tagging_message: 'github-api-${{ steps.release.outputs.version }}'
-          branch: staging/main
+          branch: staging/${{ github.ref_name }}
 
       - name: Increment Snapshot Version
         run: |
           mvn versions:set versions:commit -DnextSnapshot 
 
-      - uses: stefanzweifel/git-auto-commit-action@v5
+      - uses: stefanzweifel/git-auto-commit-action@v6
         with:
           commit_message: "Prepare for next development iteration"
-          branch: staging/main
+          branch: staging/${{ github.ref_name }}
 
-      - name: pull-request to main
+      - name: Create pull-request
         uses: repo-sync/pull-request@v2
         with:
           pr_title: "Prepare release (${{ github.actor }}): github-api-${{ steps.release.outputs.version }}"
-          source_branch: "staging/main"
-          destination_branch: "main"
+          source_branch: "staging/${{ github.ref_name }}"
+          destination_branch: "${{ github.ref_name }}"
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/maven-build.yml

@@ -35,7 +35,7 @@ jobs:
     - name: Maven Install (skipTests)
       env:
         MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-      run: mvn -B clean install -Djapicmp.skip=true -DskipTests --file pom.xml
+      run: mvn -B clean install -DskipTests --file pom.xml
     - uses: actions/upload-artifact@v4
       with:
         name: maven-target-directory
@@ -59,7 +59,7 @@ jobs:
         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 -Djapicmp.skip=true -DskipTests --file pom.xml
+      run: mvn -B clean install site -DskipTests --file pom.xml
   test-bridged:
     name: build-and-test Bridged (Java 17)
     # Does not require build output, but orders execution to prevent launching test workflows when simple build fails 
@@ -78,8 +78,7 @@ jobs:
     - name: Maven Install (skipTests)
       env:
         MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-      #skipping japicmp check for bridged artifact until after next release
-      run: mvn -B clean install -Djapicmp.skip=true -Pbridged -D enable-ci --file pom.xml "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"
+      run: mvn -B clean install -Pbridged -D enable-ci --file pom.xml "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"
   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 
@@ -108,8 +107,7 @@ jobs:
       if: matrix.os != 'windows'
       env:
         MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-      # Disable japicmp until next release
-      run: mvn -B clean install -Djapicmp.skip=true -D enable-ci --file pom.xml "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"
+      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
@@ -128,7 +126,7 @@ jobs:
         name: maven-test-target-directory
         path: target
     - name: Codecov Report
-      uses: codecov/[email protected].0
+      uses: codecov/[email protected].3
       with:
         # Codecov token from https://app.codecov.io/gh/hub4j/github-api/settings
         token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/publish_release_branch.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Maven Install and Site with Code Coverage
         env:
           MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-        run: mvn -B clean install site -Djapicmp.skip=true -D enable-ci --file pom.xml "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"
+        run: mvn -B clean install site -D enable-ci --file pom.xml "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"
 
       - uses: actions/upload-artifact@v4
         with:
@@ -49,15 +49,15 @@ jobs:
           gpg-passphrase: MAVEN_GPG_PASSPHRASE
 
       - name: Publish package
-        run: mvn -B clean deploy -Djapicmp.skip=true -DskipTests -Prelease
+        run: mvn -B clean deploy -DskipTests -Prelease
         env:
           MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
           MAVEN_USERNAME: ${{ secrets.OSSRH_TOKEN_USERNAME }}
           MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN_PASSWORD }}
           MAVEN_GPG_PASSPHRASE: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSPHRASE }}
 
       - name: Publish package with bridge methods 
-        run: mvn -B clean deploy -Djapicmp.skip=true -DskipTests -Prelease -Pbridged
+        run: mvn -B clean deploy -DskipTests -Prelease -Pbridged
         env:
           MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
           MAVEN_USERNAME: ${{ secrets.OSSRH_TOKEN_USERNAME }}
@@ -90,7 +90,7 @@ jobs:
           cp -r ./target/site/* ./
 
       - name: Publish GH Pages
-        uses: stefanzweifel/git-auto-commit-action@v5
+        uses: stefanzweifel/git-auto-commit-action@v6
         with:
           commit_message: "Release (${{ github.actor }}): v${{ steps.release.outputs.version }}" 
           branch: gh-pages

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>org.kohsuke</groupId>
   <artifactId>${github-api.artifactId}</artifactId>
-  <version>2.0-rc.3</version>
+  <version>2.0-rc.4</version>
   <name>GitHub API for Java</name>
   <description>GitHub API for Java</description>
   <url>https://hub4j.github.io/github-api/</url>
@@ -73,7 +73,7 @@
     <jacoco.surefire.argLine></jacoco.surefire.argLine>
     <jjwt.suite.version>0.12.6</jjwt.suite.version>
     <!-- This project was registered before 2021, so it uses the old server. -->
-    <nexus.serverUrl>https://oss.sonatype.org</nexus.serverUrl>
+    <nexus.serverUrl>https://ossrh-staging-api.central.sonatype.com</nexus.serverUrl>
     <okhttp3.version>4.12.0</okhttp3.version>
     <okio.version>3.10.2</okio.version>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -89,7 +89,7 @@
       <dependency>
         <groupId>com.fasterxml.jackson</groupId>
         <artifactId>jackson-bom</artifactId>
-        <version>2.18.3</version>
+        <version>2.19.1</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -146,11 +146,15 @@
       <groupId>com.fasterxml.jackson.datatype</groupId>
       <artifactId>jackson-datatype-jsr310</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.github.spotbugs</groupId>
+      <artifactId>spotbugs-annotations</artifactId>
+      <version>${spotbugs.version}</version>
+    </dependency>
     <dependency>
       <groupId>com.infradna.tool</groupId>
       <artifactId>bridge-method-annotation</artifactId>
-      <version>1.30</version>
-      <optional>true</optional>
+      <version>1.31</version>
     </dependency>
     <dependency>
       <groupId>com.squareup.okhttp3</groupId>
@@ -190,13 +194,7 @@
     <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-lang3</artifactId>
-      <version>3.17.0</version>
-    </dependency>
-    <dependency>
-      <groupId>com.github.spotbugs</groupId>
-      <artifactId>spotbugs-annotations</artifactId>
-      <version>${spotbugs.version}</version>
-      <scope>provided</scope>
+      <version>3.18.0</version>
     </dependency>
     <dependency>
       <groupId>com.github.npathai</groupId>
@@ -310,7 +308,7 @@
         <plugin>
           <groupId>com.infradna.tool</groupId>
           <artifactId>bridge-method-injector</artifactId>
-          <version>1.30</version>
+          <version>1.31</version>
           <executions>
             <execution>
               <goals>
@@ -475,7 +473,7 @@
       <plugin>
         <groupId>com.diffplug.spotless</groupId>
         <artifactId>spotless-maven-plugin</artifactId>
-        <version>2.44.3</version>
+        <version>2.44.5</version>
         <configuration>
           <java>
             <includes>
@@ -484,13 +482,19 @@
             </includes>
 
             <eclipse>
+              <version>4.35</version>
               <file>${basedir}/src/build/eclipse/formatter.xml</file>
+              <sortMembersEnabled>true</sortMembersEnabled>
+              <sortMembersVisibilityOrderEnabled>true</sortMembersVisibilityOrderEnabled>
+              <sortMembersDoNotSortFields>false</sortMembersDoNotSortFields>
             </eclipse>
 
             <importOrder>
               <file>${basedir}/src/build/eclipse/eclipse.importorder</file>
             </importOrder>
+
             <removeUnusedImports></removeUnusedImports>
+            <formatAnnotations></formatAnnotations>
 
             <trimTrailingWhitespace></trimTrailingWhitespace>
             <endWithNewline></endWithNewline>

src/main/java/org/kohsuke/github/AbstractBuilder.java

@@ -43,13 +43,13 @@
  */
 abstract class AbstractBuilder<R, S> extends GitHubInteractiveObject implements GitHubRequestBuilderDone<R> {
 
-    @Nonnull
-    private final Class<R> returnType;
+    @CheckForNull
+    private final R baseInstance;
 
     private final boolean commitChangesImmediately;
 
-    @CheckForNull
-    private final R baseInstance;
+    @Nonnull
+    private final Class<R> returnType;
 
     /** The requester. */
     @Nonnull
@@ -111,54 +111,54 @@ public R done() throws IOException {
     }
 
     /**
-     * Applies a value to a name for this builder.
+     * Chooses whether to return a continuing builder or an updated data record
      *
      * If {@code S} is the same as {@code R}, this method will commit changes after the first value change and return a
      * {@code R} from {@link #done()}.
      *
      * If {@code S} is not the same as {@code R}, this method will return an {@code S} and letting the caller batch
      * together multiple changes and call {@link #done()} when they are ready.
      *
-     * @param name
-     *            the name of the field
-     * @param value
-     *            the value of the field
      * @return either a continuing builder or an updated data record
      * @throws IOException
      *             if an I/O error occurs
      */
     @Nonnull
     @BetaApi
-    protected S with(@Nonnull String name, Object value) throws IOException {
-        requester.with(name, value);
-        return continueOrDone();
+    protected S continueOrDone() throws IOException {
+        // This little bit of roughness in this base class means all inheriting builders get to create Updater and
+        // Setter classes from almost identical code. Creator can often be implemented with significant code reuse as
+        // well.
+        if (commitChangesImmediately) {
+            // These casts look strange and risky, but they they're actually guaranteed safe due to the return path
+            // being based on the previous comparison of class instances passed to the constructor.
+            return (S) done();
+        } else {
+            return (S) this;
+        }
     }
 
     /**
-     * Chooses whether to return a continuing builder or an updated data record
+     * Applies a value to a name for this builder.
      *
      * If {@code S} is the same as {@code R}, this method will commit changes after the first value change and return a
      * {@code R} from {@link #done()}.
      *
      * If {@code S} is not the same as {@code R}, this method will return an {@code S} and letting the caller batch
      * together multiple changes and call {@link #done()} when they are ready.
      *
+     * @param name
+     *            the name of the field
+     * @param value
+     *            the value of the field
      * @return either a continuing builder or an updated data record
      * @throws IOException
      *             if an I/O error occurs
      */
     @Nonnull
     @BetaApi
-    protected S continueOrDone() throws IOException {
-        // This little bit of roughness in this base class means all inheriting builders get to create Updater and
-        // Setter classes from almost identical code. Creator can often be implemented with significant code reuse as
-        // well.
-        if (commitChangesImmediately) {
-            // These casts look strange and risky, but they they're actually guaranteed safe due to the return path
-            // being based on the previous comparison of class instances passed to the constructor.
-            return (S) done();
-        } else {
-            return (S) this;
-        }
+    protected S with(@Nonnull String name, Object value) throws IOException {
+        requester.with(name, value);
+        return continueOrDone();
     }
 }

src/main/java/org/kohsuke/github/EnterpriseManagedSupport.java

@@ -14,18 +14,38 @@
  */
 class EnterpriseManagedSupport {
 
+    private static final Logger LOGGER = Logger.getLogger(EnterpriseManagedSupport.class.getName());
     static final String COULD_NOT_RETRIEVE_ORGANIZATION_EXTERNAL_GROUPS = "Could not retrieve organization external groups";
     static final String NOT_PART_OF_EXTERNALLY_MANAGED_ENTERPRISE_ERROR = "This organization is not part of externally managed enterprise.";
+
     static final String TEAM_CANNOT_BE_EXTERNALLY_MANAGED_ERROR = "This team cannot be externally managed since it has explicit members.";
 
-    private static final Logger LOGGER = Logger.getLogger(EnterpriseManagedSupport.class.getName());
+    private static String logUnexpectedFailure(final JsonProcessingException exception, final String payload) {
+        final StringWriter sw = new StringWriter();
+        final PrintWriter pw = new PrintWriter(sw);
+        exception.printStackTrace(pw);
+        return String.format("Could not parse GitHub error response: '%s'. Full stacktrace follows:%n%s", payload, sw);
+    }
+
+    static EnterpriseManagedSupport forOrganization(final GHOrganization org) {
+        return new EnterpriseManagedSupport(org);
+    }
 
     private final GHOrganization organization;
 
     private EnterpriseManagedSupport(GHOrganization organization) {
         this.organization = organization;
     }
 
+    Optional<GHException> filterException(final GHException e) {
+        if (e.getCause() instanceof HttpException) {
+            final HttpException he = (HttpException) e.getCause();
+            return filterException(he, COULD_NOT_RETRIEVE_ORGANIZATION_EXTERNAL_GROUPS)
+                    .map(translated -> new GHException(COULD_NOT_RETRIEVE_ORGANIZATION_EXTERNAL_GROUPS, translated));
+        }
+        return Optional.empty();
+    }
+
     Optional<GHIOException> filterException(final HttpException he, final String scenario) {
         if (he.getResponseCode() == 400) {
             final String responseMessage = he.getMessage();
@@ -46,24 +66,4 @@ Optional<GHIOException> filterException(final HttpException he, final String sce
         return Optional.empty();
     }
 
-    Optional<GHException> filterException(final GHException e) {
-        if (e.getCause() instanceof HttpException) {
-            final HttpException he = (HttpException) e.getCause();
-            return filterException(he, COULD_NOT_RETRIEVE_ORGANIZATION_EXTERNAL_GROUPS)
-                    .map(translated -> new GHException(COULD_NOT_RETRIEVE_ORGANIZATION_EXTERNAL_GROUPS, translated));
-        }
-        return Optional.empty();
-    }
-
-    static EnterpriseManagedSupport forOrganization(final GHOrganization org) {
-        return new EnterpriseManagedSupport(org);
-    }
-
-    private static String logUnexpectedFailure(final JsonProcessingException exception, final String payload) {
-        final StringWriter sw = new StringWriter();
-        final PrintWriter pw = new PrintWriter(sw);
-        exception.printStackTrace(pw);
-        return String.format("Could not parse GitHub error response: '%s'. Full stacktrace follows:%n%s", payload, sw);
-    }
-
 }