Merge tag 'github-api-1.326' into release/v1.x

github-api-1.326

Author: bitwiseman

.github/workflows/maven-build.yml

@@ -57,7 +57,9 @@ jobs:
     - name: Maven Site
       env:
         MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-      run: mvn -B clean site -D enable-ci --file pom.xml
+      # 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 
@@ -144,7 +146,7 @@ jobs:
     - name: Set up JDK
       uses: actions/setup-java@v4
       with:
-        java-version: 8
+        java-version: 11
         distribution: 'temurin'
         cache: 'maven'
     - name: Maven Test (no build) Java 11

.github/workflows/publish_release_branch.yml

@@ -59,7 +59,7 @@ jobs:
   publish_gh_pages:
     runs-on: ubuntu-latest
     needs: build
-    if:  ${{ github.ref == 'refs/heads/release/v1.x' }}
+    if:  ${{ github.ref == 'refs/heads/release/v2.x' }}
     steps:
       - uses: actions/checkout@v4
         with:

pom.xml

@@ -2,7 +2,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>org.kohsuke</groupId>
   <artifactId>github-api</artifactId>
-  <version>1.325</version>
+  <version>1.326</version>
   <name>GitHub API for Java</name>
   <url>https://github-api.kohsuke.org/</url>
   <description>GitHub API for Java</description>
@@ -34,7 +34,7 @@
   <properties>
     <spring.boot.version>3.3.3</spring.boot.version>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <spotbugs-maven-plugin.version>4.8.6.1</spotbugs-maven-plugin.version>
+    <spotbugs-maven-plugin.version>4.8.6.3</spotbugs-maven-plugin.version>
     <spotbugs.version>4.8.6</spotbugs.version>
     <spotbugs-maven-plugin.failOnError>true</spotbugs-maven-plugin.failOnError>
     <hamcrest.version>3.0</hamcrest.version>
@@ -94,7 +94,7 @@
         </plugin>
         <plugin>
           <artifactId>maven-surefire-plugin</artifactId>
-          <version>3.2.3</version>
+          <version>3.5.0</version>
           <configuration>
             <!-- SUREFIRE-1226 workaround -->
             <trimStackTrace>false</trimStackTrace>
@@ -108,7 +108,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-gpg-plugin</artifactId>
-          <version>3.2.4</version>
+          <version>3.2.6</version>
         </plugin>
         <plugin>
           <groupId>org.jacoco</groupId>
@@ -223,7 +223,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
-          <version>3.8.0</version>
+          <version>3.10.0</version>
           <configuration>
             <release>8</release>
             <failOnWarnings>true</failOnWarnings>
@@ -247,7 +247,7 @@
       <!--
       This plugin is used to generate AOT metadata during tests so that it can be
       compared against those in META-INF/native-image/org.kohsuke/github-api/*.
-      The tests are located in src/test/java/org.kohsuke.aot
+      The tests are start with the name "Aot..." 
       -->
       <plugin>
         <groupId>org.springframework.boot</groupId>
@@ -290,7 +290,7 @@
           <dependency>
             <groupId>org.apache.bcel</groupId>
             <artifactId>bcel</artifactId>
-            <version>6.9.0</version>
+            <version>6.10.0</version>
           </dependency>
         </dependencies>
       </plugin>
@@ -436,8 +436,16 @@
       <plugin>
         <groupId>com.github.siom79.japicmp</groupId>
         <artifactId>japicmp-maven-plugin</artifactId>
-        <version>0.17.2</version>
+        <version>0.23.0</version>
         <configuration>
+          <oldVersion>
+            <dependency>
+              <groupId>${project.groupId}</groupId>
+              <artifactId>${project.artifactId}</artifactId>
+              <version>1.325</version>
+              <type>jar</type>
+            </dependency>
+          </oldVersion>
           <parameter>
             <breakBuildOnBinaryIncompatibleModifications>true</breakBuildOnBinaryIncompatibleModifications>
             <onlyModified>true</onlyModified>
@@ -478,7 +486,7 @@
     <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-lang3</artifactId>
-      <version>3.14.0</version>
+      <version>3.17.0</version>
     </dependency>
     <dependency>
       <groupId>com.tngtech.archunit</groupId>

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

@@ -7,7 +7,6 @@
 import javax.annotation.CheckForNull;
 import javax.annotation.Nonnull;
 
-// TODO: Auto-generated Javadoc
 /**
  * An abstract data object builder/updater.
  *
@@ -42,7 +41,7 @@
  *            Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If {@link S}
  *            the same as {@link R}, this builder will commit changes after each call to {@link #with(String, Object)}.
  */
-abstract class AbstractBuilder<R, S> extends GitHubInteractiveObject {
+abstract class AbstractBuilder<R, S> extends GitHubInteractiveObject implements GitHubRequestBuilderDone<R> {
 
     @Nonnull
     private final Class<R> returnType;
@@ -58,9 +57,9 @@ abstract class AbstractBuilder<R, S> extends GitHubInteractiveObject {
 
     // TODO: Not sure how update-in-place behavior should be controlled
     // However, it certainly can be controlled dynamically down to the instance level or inherited for all children of
-    // some
+    // some connection.
+
     /** The update in place. */
-    // connection.
     protected boolean updateInPlace;
 
     /**
@@ -96,14 +95,9 @@ protected AbstractBuilder(@Nonnull Class<R> finalReturnType,
     }
 
     /**
-     * Finishes an update, committing changes.
-     *
-     * This method may update-in-place or not. Either way it returns the resulting instance.
-     *
-     * @return an instance with updated current data
-     * @throws IOException
-     *             if there is an I/O Exception
+     * {@inheritDoc}
      */
+    @Override
     @Nonnull
     @BetaApi
     public R done() throws IOException {

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

@@ -25,6 +25,12 @@
 @Deprecated
 public abstract class AbuseLimitHandler extends GitHubAbuseLimitHandler {
 
+    /**
+     * Create default AbuseLimitHandler instance
+     */
+    public AbuseLimitHandler() {
+    }
+
     /**
      * Called when the library encounters HTTP error indicating that the API abuse limit is reached.
      *
@@ -102,6 +108,9 @@ public void onError(IOException e, HttpURLConnection uc) throws IOException {
         }
     };
 
+    // If "Retry-After" missing, wait for unambiguously over one minute per GitHub guidance
+    static long DEFAULT_WAIT_MILLIS = 61 * 1000;
+
     /*
      * Exposed for testability. Given an http response, find the retry-after header field and parse it as either a
      * number or a date (the spec allows both). If no header is found, wait for a reasonably amount of time.
@@ -110,7 +119,7 @@ long parseWaitTime(HttpURLConnection uc) {
         String v = uc.getHeaderField("Retry-After");
         if (v == null) {
             // can't tell, wait for unambiguously over one minute per GitHub guidance
-            return 61 * 1000;
+            return DEFAULT_WAIT_MILLIS;
         }
 
         try {

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

@@ -20,6 +20,12 @@
  */
 public class GHApp extends GHObject {
 
+    /**
+     * Create default GHApp instance
+     */
+    public GHApp() {
+    }
+
     private GHUser owner;
     private String name;
     private String slug;

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

@@ -8,6 +8,12 @@
  */
 public class GHAppFromManifest extends GHApp {
 
+    /**
+     * Create default GHAppFromManifest instance
+     */
+    public GHAppFromManifest() {
+    }
+
     private String clientId;
     private String clientSecret;
     private String webhookSecret;

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

@@ -24,6 +24,13 @@
  * @see GHApp#getInstallationByUser(String) GHApp#getInstallationByUser(String)
  */
 public class GHAppInstallation extends GHObject {
+
+    /**
+     * Create default GHAppInstallation instance
+     */
+    public GHAppInstallation() {
+    }
+
     private GHUser account;
 
     @JsonProperty("access_tokens_url")

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

@@ -14,6 +14,13 @@
  * @see GHAppInstallation#createToken(Map) GHAppInstallation#createToken(Map)
  */
 public class GHAppInstallationToken extends GitHubInteractiveObject {
+
+    /**
+     * Create default GHAppInstallationToken instance
+     */
+    public GHAppInstallationToken() {
+    }
+
     private String token;
 
     /** The expires at. */

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

@@ -20,6 +20,12 @@
  */
 public class GHArtifact extends GHObject {
 
+    /**
+     * Create default GHArtifact instance
+     */
+    public GHArtifact() {
+    }
+
     // Not provided by the API.
     @JsonIgnore
     private GHRepository owner;