Merge tag 'github-api-1.317' into update-kohsuke-client-lib

[maven-release-plugin] copy for tag github-api-1.317

Author: jdhayford

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,7 +5,8 @@
 # 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.
 - [ ] Push your changes to a branch other than `main`. You will create your PR from that branch.
@@ -14,6 +15,6 @@
 
 - [ ] 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

@@ -42,7 +42,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/maven-build.yml

@@ -19,64 +19,44 @@ 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@v4
+    - name: Set up JDK
+      uses: actions/setup-java@v3
+      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@v3
+      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@v4
     - name: Set up JDK
       uses: actions/setup-java@v3
       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 }}
+      run: mvn -B clean site -D enable-ci --file pom.xml
   test:
     name: test (${{ matrix.os }}, Java ${{ matrix.java }})
     runs-on: ${{ matrix.os }}-latest
@@ -86,12 +66,12 @@ jobs:
         os: [ ubuntu, windows ]
         java: [ 11, 17 ]
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up JDK
       uses: actions/setup-java@v3
       with:
         java-version: ${{ matrix.java }}
-        distribution: 'zulu'
+        distribution: 'temurin'
         cache: 'maven'
     # JDK 11+
     - name: Maven Install without Code Coverage

CONTRIBUTING.md

@@ -82,7 +82,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
 

pom.xml

@@ -11,7 +11,7 @@
     <connection>scm:git:git@github.com/hub4j/${project.artifactId}.git</connection>
     <developerConnection>scm:git:ssh://git@github.com/hub4j/${project.artifactId}.git</developerConnection>
     <url>https://github.com/hub4j/github-api/</url>
-    <tag>HEAD</tag>
+    <tag>github-api-1.317</tag>
   </scm>
 
   <distributionManagement>
@@ -38,7 +38,7 @@
     <spotbugs-maven-plugin.failOnError>true</spotbugs-maven-plugin.failOnError>
     <hamcrest.version>2.2</hamcrest.version>
     <okhttp3.version>4.9.2</okhttp3.version>
-    <okio.version>2.10.0</okio.version>
+    <okio.version>3.5.0</okio.version>
     <!-- Using this as the minimum bar for code coverage.  Adding methods without covering them will fail this. -->
     <jacoco.coverage.target.bundle.method>0.70</jacoco.coverage.target.bundle.method>
     <jacoco.coverage.target.class.method>0.50</jacoco.coverage.target.class.method>
@@ -92,17 +92,17 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-source-plugin</artifactId>
-          <version>3.2.1</version>
+          <version>3.3.0</version>
         </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-gpg-plugin</artifactId>
-          <version>3.0.1</version>
+          <version>3.1.0</version>
         </plugin>
         <plugin>
           <groupId>org.jacoco</groupId>
           <artifactId>jacoco-maven-plugin</artifactId>
-          <version>0.8.8</version>
+          <version>0.8.10</version>
           <configuration>
             <!-- no need to get data about external code. It dramatically reduces performance of JaCoCo for nothing -->
             <excludes>
@@ -241,6 +241,9 @@
               <artifactId>java18</artifactId>
               <version>1.0</version>
             </signature>
+            <ignores>
+              java.net.http.*
+            </ignores>
           </configuration>
           <executions>
             <execution>
@@ -278,7 +281,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-project-info-reports-plugin</artifactId>
-        <version>3.4.1</version>
+        <version>3.4.2</version>
         <dependencies>
           <dependency>
             <groupId>org.apache.bcel</groupId>
@@ -301,19 +304,52 @@
             </annotationProcessorPath>
           </annotationProcessorPaths>
         </configuration>
+        <executions>
+          <execution>
+            <id>compile-java-11</id>
+            <phase>compile</phase>
+            <goals>
+              <goal>compile</goal>
+            </goals>
+            <configuration>
+              <release>11</release>
+              <source>11</source>
+              <target>11</target>
+              <compileSourceRoots>
+                <compileSourceRoot>${project.basedir}/src/main/java11</compileSourceRoot>
+              </compileSourceRoots>
+              <multiReleaseOutput>true</multiReleaseOutput>
+            </configuration>
+          </execution>
+        </executions>
       </plugin>
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
+        <configuration>
+          <argLine>@{jacoco.surefire.argLine} ${surefire.argLine}</argLine>
+        </configuration>
         <executions>
           <execution>
             <id>default-test</id>
             <configuration>
               <excludesFile>src/test/resources/slow-or-flaky-tests.txt</excludesFile>
-              <argLine>@{jacoco.surefire.argLine} ${surefire.argLine}</argLine>
             </configuration>
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jar-plugin</artifactId>
+        <version>3.3.0</version>
+        <configuration>
+          <archive>
+            <manifestEntries>
+              <Automatic-Module-Name>org.kohsuke.github.api</Automatic-Module-Name>
+              <Multi-Release>true</Multi-Release>
+            </manifestEntries>
+          </archive>
+        </configuration>
+      </plugin>
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>animal-sniffer-maven-plugin</artifactId>
@@ -431,7 +467,7 @@
     <dependency>
       <groupId>com.tngtech.archunit</groupId>
       <artifactId>archunit</artifactId>
-      <version>0.23.1</version>
+      <version>1.1.0</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -453,6 +489,12 @@
       <version>${hamcrest.version}</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.github.npathai</groupId>
+      <artifactId>hamcrest-optional</artifactId>
+      <version>2.0.0</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>
@@ -468,7 +510,7 @@
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-databind</artifactId>
-      <version>2.14.0</version>
+      <version>2.15.2</version>
     </dependency>
     <dependency>
       <groupId>commons-io</groupId>
@@ -485,7 +527,7 @@
     <dependency>
       <groupId>commons-fileupload</groupId>
       <artifactId>commons-fileupload</artifactId>
-      <version>1.4</version>
+      <version>1.5</version>
       <scope>test</scope>
     </dependency>
     <!-- for stapler-jetty -->
@@ -511,7 +553,7 @@
     <dependency>
       <groupId>org.eclipse.jgit</groupId>
       <artifactId>org.eclipse.jgit</artifactId>
-      <version>6.4.0.202211300538-r</version>
+      <version>6.7.0.202309050840-r</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -579,7 +621,7 @@
     <dependency>
       <groupId>com.github.tomakehurst</groupId>
       <artifactId>wiremock-jre8-standalone</artifactId>
-      <version>2.32.0</version>
+      <version>2.35.1</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -591,7 +633,7 @@
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-simple</artifactId>
-      <version>2.0.3</version>
+      <version>2.0.7</version>
       <scope>test</scope>
     </dependency>
   </dependencies>
@@ -610,7 +652,7 @@
   <profiles>
     <!-- only enable slow-or-flaky-test if -Dtest= is not present -->
     <profile>
-      <id>slow-or-flaky-test</id>
+      <id>test-slow-multireleasejar-flaky</id>
       <activation>
         <property>
           <name>!test</name>

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

@@ -0,0 +1,51 @@
+package org.kohsuke.github;
+
+/**
+ * A GitHub App with the additional attributes returned during its creation.
+ *
+ * @author Daniel Baur
+ * @see GitHub#createAppFromManifest(String)
+ */
+public class GHAppFromManifest extends GHApp {
+
+    private String clientId;
+    private String clientSecret;
+    private String webhookSecret;
+    private String pem;
+
+    /**
+     * Gets the client id
+     *
+     * @return the client id
+     */
+    public String getClientId() {
+        return clientId;
+    }
+
+    /**
+     * Gets the client secret
+     *
+     * @return the client secret
+     */
+    public String getClientSecret() {
+        return clientSecret;
+    }
+
+    /**
+     * Gets the webhook secret
+     *
+     * @return the webhook secret
+     */
+    public String getWebhookSecret() {
+        return webhookSecret;
+    }
+
+    /**
+     * Gets the pem
+     *
+     * @return the pem
+     */
+    public String getPem() {
+        return pem;
+    }
+}