Merge branch 'master' into BranchMissing

hub4j · Nov 15, 2019 · 18aa067 · 18aa067
2 parents 8d50b33 + d3564a9
commit 18aa067
Show file tree

Hide file tree

Showing 297 changed files with 17,898 additions and 5,033 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,10 @@
+# Description 
+** Describe your change here** 
+
+# Before submitting a PR:
+We love getting PRs, but we hate asking people for the same basic changes every time. 
+
+- [ ] Push your changes to a branch other than `master`. Create your PR from that branch.    
+- [ ] Add JavaDocs and other comments
+- [ ] Write tests that run and pass in CI. See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to capture snapshot data.
+- [ ] Run `mvn install site` locally. This may reformat your code, commit those changes. If this command doesn't succeed, your change will not pass CI.
diff --git a/.github/workflows/maven-build.yml b/.github/workflows/maven-build.yml
@@ -19,4 +19,4 @@ jobs:
     - name: Maven Download all dependencies
       run: mvn -B org.apache.maven.plugins:maven-dependency-plugin:3.1.1:go-offline
     - name: Maven Build
-      run: mvn -B package --file pom.xml
+      run: mvn -B install site -P ci --file pom.xml
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -1,3 +1,7 @@
-Java API for GitHub
+# Java API for GitHub
+
+[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/org.kohsuke/github-api?server=https%3A%2F%2Foss.sonatype.org)](https://mvnrepository.com/artifact/org.kohsuke/github-api)
+[![Join the chat at https://gitter.im/github-api/github-api](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/github-api/github-api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 
 See https://github-api.kohsuke.org/ for more details
diff --git a/pom.xml b/pom.xml
@@ -8,7 +8,7 @@
   </parent>
 
   <artifactId>github-api</artifactId>
-  <version>1.96-SNAPSHOT</version>
+  <version>1.100-SNAPSHOT</version>
   <name>GitHub API for Java</name>
   <url>https://github-api.kohsuke.org/</url>
   <description>GitHub API for Java</description>
@@ -33,8 +33,9 @@
     <spotbugs.version>3.1.12</spotbugs.version>
     <spotbugs-maven-plugin.failOnError>true</spotbugs-maven-plugin.failOnError>
     <hamcrest.version>2.2</hamcrest.version>
-    <okhttp3.version>3.12.3</okhttp3.version>
+    <okhttp3.version>4.2.2</okhttp3.version>
     <okio.version>2.4.1</okio.version>
+    <formatter-maven-plugin.goal>format</formatter-maven-plugin.goal>
     <jacoco.coverage.target.class>.80</jacoco.coverage.target.class>
     <jacoco.coverage.target.method>0.20</jacoco.coverage.target.method>
     <jacoco.coverage.target.line>0.50</jacoco.coverage.target.line>
@@ -44,6 +45,18 @@
   </properties>
 
   <build>
+    <extensions>
+      <extension>
+        <groupId>org.apache.maven.scm</groupId>
+        <artifactId>maven-scm-provider-gitexe</artifactId>
+        <version>1.11.2</version>
+      </extension>
+      <extension>
+        <groupId>org.apache.maven.scm</groupId>
+        <artifactId>maven-scm-manager-plexus</artifactId>
+        <version>1.11.2</version>
+      </extension>
+    </extensions>
     <testResources>
       <testResource>
         <directory>src/test/resources</directory>
@@ -60,9 +73,46 @@
           <artifactId>jacoco-maven-plugin</artifactId>
           <version>0.8.5</version>
         </plugin>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-javadoc-plugin</artifactId>
+          <version>3.1.1</version>
+          <configuration>
+            <source>8</source>
+            <failOnWarnings>true</failOnWarnings>
+          </configuration>
+        </plugin>
       </plugins>
     </pluginManagement>
     <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-site-plugin</artifactId>
+        <version>3.8.2</version>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-release-plugin</artifactId>
+        <version>2.5.3</version>
+        <configuration>
+          <autoVersionSubmodules>true</autoVersionSubmodules>
+          <useReleaseProfile>false</useReleaseProfile>
+          <releaseProfiles>release</releaseProfiles>
+          <goals>deploy</goals>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-project-info-reports-plugin</artifactId>
+        <version>3.0.0</version>
+        <dependencies>
+          <dependency>
+            <groupId>org.apache.bcel</groupId>
+            <artifactId>bcel</artifactId>
+            <version>6.4.1</version>
+          </dependency>
+        </dependencies>
+      </plugin>
       <plugin>
         <artifactId>maven-compiler-plugin</artifactId>
         <version>3.8.1</version>
@@ -104,17 +154,29 @@
           </execution>
         </executions>
       </plugin>
-      <plugin>	
-        <groupId>com.infradna.tool</groupId>	
-        <artifactId>bridge-method-injector</artifactId>	
-        <version>1.18</version>	
-        <executions>	
-          <execution>	
-            <goals>	
-              <goal>process</goal>	
-            </goals>	
-          </execution>	
-        </executions>	
+      <plugin>
+        <groupId>com.infradna.tool</groupId>
+        <artifactId>bridge-method-injector</artifactId>
+        <version>1.18</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>process</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>net.revelc.code.formatter</groupId>
+        <artifactId>formatter-maven-plugin</artifactId>
+        <version>2.11.0</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>${formatter-maven-plugin.goal}</goal>
+            </goals>
+          </execution>
+        </executions>
       </plugin>
       <plugin>
         <groupId>com.github.spotbugs</groupId>
@@ -195,7 +257,7 @@
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-databind</artifactId>
-      <version>2.10.0</version>
+      <version>2.10.1</version>
     </dependency>
     <dependency>
       <groupId>commons-io</groupId>
@@ -232,10 +294,12 @@
       <version>${okhttp3.version}</version>
       <optional>true</optional>
     </dependency>
+    <!-- This is the last version of okhttp3 that support UrlConnection -->
+    <!-- The class using this has been deprecated, this dependency can be remove when that class is. -->
     <dependency>
       <groupId>com.squareup.okhttp3</groupId>
       <artifactId>okhttp-urlconnection</artifactId>
-      <version>${okhttp3.version}</version>
+      <version>3.12.3</version>
       <optional>true</optional>
     </dependency>
     <dependency>
@@ -288,11 +352,19 @@
     </pluginRepository>
   </pluginRepositories>
   <profiles>
+    <profile>
+      <id>ci</id>
+      <properties>
+        <formatter-maven-plugin.goal>validate</formatter-maven-plugin.goal>
+      </properties>
+      <build>
+      </build>
+    </profile>
     <profile>
       <id>jacoco</id>
       <activation>
         <property>
-          <name>!jacoco.disabled</name>
+          <name>enable-jacoco</name>
         </property>
       </activation>
       <build>
@@ -385,13 +457,49 @@
         </plugins>
       </build>
     </profile>
+    <profile>
+    <id>release</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-gpg-plugin</artifactId>
+            <version>1.6</version>
+            <executions>
+              <execution>
+                <id>sign-artifacts</id>
+                <phase>verify</phase>
+                <goals>
+                  <goal>sign</goal>
+                </goals>
+                <configuration>
+                  <gpgArguments>
+                    <arg>--pinentry-mode</arg>
+                    <arg>loopback</arg>
+                  </gpgArguments>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-source-plugin</artifactId>
+            <version>3.2.0</version>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
   </profiles>
   <reporting>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-project-info-reports-plugin</artifactId>
+      </plugin>
     </plugins>
   </reporting>
 

diff --git a/src/main/java/org/kohsuke/github/AbuseLimitHandler.java b/src/main/java/org/kohsuke/github/AbuseLimitHandler.java
@@ -8,7 +8,7 @@
  * Pluggable strategy to determine what to do when the API abuse limit is hit.
  *
  * @author Kohsuke Kawaguchi
- * @see GitHubBuilder#withAbuseLimitHandler(AbuseLimitHandler)
+ * @see GitHubBuilder#withAbuseLimitHandler(AbuseLimitHandler) GitHubBuilder#withAbuseLimitHandler(AbuseLimitHandler)
  * @see <a href="https://developer.github.com/v3/#abuse-rate-limits">documentation</a>
  * @see RateLimitHandler
  */
@@ -17,16 +17,18 @@ public abstract class AbuseLimitHandler {
      * Called when the library encounters HTTP error indicating that the API abuse limit is reached.
      *
      * <p>
-     * Any exception thrown from this method will cause the request to fail, and the caller of github-api
-     * will receive an exception. If this method returns normally, another request will be attempted.
-     * For that to make sense, the implementation needs to wait for some time.
+     * Any exception thrown from this method will cause the request to fail, and the caller of github-api will receive
+     * an exception. If this method returns normally, another request will be attempted. For that to make sense, the
+     * implementation needs to wait for some time.
      *
-     * @see <a href="https://developer.github.com/v3/#abuse-rate-limits">API documentation from GitHub</a>
      * @param e
-     *      Exception from Java I/O layer. If you decide to fail the processing, you can throw
-     *      this exception (or wrap this exception into another exception and throw it).
+     *            Exception from Java I/O layer. If you decide to fail the processing, you can throw this exception (or
+     *            wrap this exception into another exception and throw it).
      * @param uc
-     *      Connection that resulted in an error. Useful for accessing other response headers.
+     *            Connection that resulted in an error. Useful for accessing other response headers.
+     * @throws IOException
+     *             on failure
+     * @see <a href="https://developer.github.com/v3/#abuse-rate-limits">API documentation from GitHub</a>
      */
     public abstract void onError(IOException e, HttpURLConnection uc) throws IOException;
 
@@ -38,16 +40,17 @@ public abstract class AbuseLimitHandler {
         public void onError(IOException e, HttpURLConnection uc) throws IOException {
             try {
                 Thread.sleep(parseWaitTime(uc));
-            } catch (InterruptedException _) {
-                throw (InterruptedIOException)new InterruptedIOException().initCause(e);
+            } catch (InterruptedException ex) {
+                throw (InterruptedIOException) new InterruptedIOException().initCause(e);
             }
         }
 
         private long parseWaitTime(HttpURLConnection uc) {
             String v = uc.getHeaderField("Retry-After");
-            if (v==null)    return 60 * 1000;   // can't tell, return 1 min
+            if (v == null)
+                return 60 * 1000; // can't tell, return 1 min
 
-            return Math.max(1000, Long.parseLong(v)*1000);
+            return Math.max(1000, Long.parseLong(v) * 1000);
         }
     };
 
@@ -57,7 +60,7 @@ private long parseWaitTime(HttpURLConnection uc) {
     public static final AbuseLimitHandler FAIL = new AbuseLimitHandler() {
         @Override
         public void onError(IOException e, HttpURLConnection uc) throws IOException {
-            throw (IOException)new IOException("Abuse limit reached").initCause(e);
+            throw (IOException) new IOException("Abuse limit reached").initCause(e);
         }
     };
 }
diff --git a/src/main/java/org/kohsuke/github/DeleteToken.java b/src/main/java/org/kohsuke/github/DeleteToken.java
@@ -28,8 +28,7 @@
 /**
  * @author Kohsuke Kawaguchi
  */
-@SuppressFBWarnings(value = "UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD", 
-        justification = "Being constructed by JSON deserialization")
+@SuppressFBWarnings(value = "UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD", justification = "Being constructed by JSON deserialization")
 class DeleteToken {
     public String delete_token;
 }