Merge pull request #1939 from bitwiseman/feature/ci-site

Re-enable site for v2.x

.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 

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

pom.xml

@@ -202,8 +202,9 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
-          <version>3.8.0</version>
+          <version>3.10.0</version>
           <configuration>
+            <source>11</source>
             <release>11</release>
             <failOnWarnings>true</failOnWarnings>
             <doclint>all</doclint>
@@ -279,6 +280,7 @@
         <configuration>
           <source>11</source>
           <target>11</target>
+          <release>11</release>
           <annotationProcessorPaths>
             <annotationProcessorPath>
               <groupId>org.jenkins-ci</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/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

@@ -11,6 +11,13 @@
  * @see GHAppInstallation#createToken() GHAppInstallation#createToken()
  */
 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;

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

@@ -12,6 +12,12 @@
  */
 public class GHAsset extends GHObject {
 
+    /**
+     * Create default GHAsset instance
+     */
+    public GHAsset() {
+    }
+
     /** The owner. */
     GHRepository owner;
     private String name;

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

@@ -17,6 +17,12 @@
  */
 public class GHAuthorization extends GHObject {
 
+    /**
+     * Create default GHAuthorization instance
+     */
+    public GHAuthorization() {
+    }
+
     /** The Constant USER. */
     public static final String USER = "user";
 

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

@@ -16,6 +16,13 @@
  * @see <a href="https://developer.github.com/v3/git/blobs/#get-a-blob">Get a blob</a>
  */
 public class GHBlob {
+
+    /**
+     * Create default GHBlob instance
+     */
+    public GHBlob() {
+    }
+
     private String content, encoding, url, sha;
     private long size;
 

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

@@ -48,6 +48,12 @@ public class GHBranch extends GitHubInteractiveObject {
      */
     public static class Commit {
 
+        /**
+         * Create default Commit instance
+         */
+        public Commit() {
+        }
+
         /** The sha. */
         String sha;
 

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

@@ -19,6 +19,13 @@
                 "URF_UNREAD_FIELD" },
         justification = "JSON API")
 public class GHBranchProtection extends GitHubInteractiveObject {
+
+    /**
+     * Create default GHBranchProtection instance
+     */
+    public GHBranchProtection() {
+    }
+
     private static final String REQUIRE_SIGNATURES_URI = "/required_signatures";
 
     @JsonProperty
@@ -204,6 +211,13 @@ private Requester requester() {
      * The type AllowDeletions.
      */
     public static class AllowDeletions {
+
+        /**
+         * Create default AllowDeletions instance
+         */
+        public AllowDeletions() {
+        }
+
         @JsonProperty
         private boolean enabled;
 
@@ -270,6 +284,13 @@ public Integer getAppId() {
      * The type AllowForcePushes.
      */
     public static class AllowForcePushes {
+
+        /**
+         * Create default AllowForcePushes instance
+         */
+        public AllowForcePushes() {
+        }
+
         @JsonProperty
         private boolean enabled;
 
@@ -287,6 +308,13 @@ public boolean isEnabled() {
      * The type AllowForkSyncing.
      */
     public static class AllowForkSyncing {
+
+        /**
+         * Create default AllowForkSyncing instance
+         */
+        public AllowForkSyncing() {
+        }
+
         @JsonProperty
         private boolean enabled;
 
@@ -304,6 +332,13 @@ public boolean isEnabled() {
      * The type BlockCreations.
      */
     public static class BlockCreations {
+
+        /**
+         * Create default BlockCreations instance
+         */
+        public BlockCreations() {
+        }
+
         @JsonProperty
         private boolean enabled;
 
@@ -321,6 +356,13 @@ public boolean isEnabled() {
      * The type EnforceAdmins.
      */
     public static class EnforceAdmins {
+
+        /**
+         * Create default EnforceAdmins instance
+         */
+        public EnforceAdmins() {
+        }
+
         @JsonProperty
         private boolean enabled;
 
@@ -350,6 +392,13 @@ public boolean isEnabled() {
      * The type LockBranch.
      */
     public static class LockBranch {
+
+        /**
+         * Create default LockBranch instance
+         */
+        public LockBranch() {
+        }
+
         @JsonProperty
         private boolean enabled;
 
@@ -367,6 +416,13 @@ public boolean isEnabled() {
      * The type RequiredConversationResolution.
      */
     public static class RequiredConversationResolution {
+
+        /**
+         * Create default RequiredConversationResolution instance
+         */
+        public RequiredConversationResolution() {
+        }
+
         @JsonProperty
         private boolean enabled;
 
@@ -384,6 +440,13 @@ public boolean isEnabled() {
      * The type RequiredLinearHistory.
      */
     public static class RequiredLinearHistory {
+
+        /**
+         * Create default RequiredLinearHistory instance
+         */
+        public RequiredLinearHistory() {
+        }
+
         @JsonProperty
         private boolean enabled;
 
@@ -401,6 +464,13 @@ public boolean isEnabled() {
      * The type RequiredReviews.
      */
     public static class RequiredReviews {
+
+        /**
+         * Create default RequiredReviews instance
+         */
+        public RequiredReviews() {
+        }
+
         @JsonProperty("dismissal_restrictions")
         private Restrictions dismissalRestriction;
 
@@ -504,6 +574,13 @@ public boolean isEnabled() {
      * The type RequiredStatusChecks.
      */
     public static class RequiredStatusChecks {
+
+        /**
+         * Create default RequiredStatusChecks instance
+         */
+        public RequiredStatusChecks() {
+        }
+
         @JsonProperty
         private Collection<String> contexts;
 
@@ -557,6 +634,13 @@ public boolean isRequiresBranchUpToDate() {
      * The type Restrictions.
      */
     public static class Restrictions {
+
+        /**
+         * Create default Restrictions instance
+         */
+        public Restrictions() {
+        }
+
         @JsonProperty
         private Collection<GHTeam> teams;
 

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

@@ -7,6 +7,12 @@
  */
 public class GHBranchSync extends GitHubInteractiveObject {
 
+    /**
+     * Create default GHBranchSync instance
+     */
+    public GHBranchSync() {
+    }
+
     /**
      * The Repository that this branch is in.
      */