Merge branch 'main' into update-gh-verification-statuses-enum

Author: jdhayford

.github/PULL_REQUEST_TEMPLATE.md

@@ -3,14 +3,17 @@
 <!-- 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 `main`. 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.
+- [ ] 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 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.
 
 # When creating a PR: 
 
-- [ ] Fill in the "Description" above.
+- [ ] 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.
+- [ ] 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/dependabot.yml

@@ -1,12 +1,14 @@
 version: 2
 updates:
-  - package-ecosystem: "maven"
-    directory: "/"
-    schedule:
-      interval: "monthly"
-      time: "02:00"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "monthly"
-      time: "02:00"
+- package-ecosystem: "maven"
+  directory: "/"
+  rebase-strategy: "disabled"
+  schedule:
+    interval: "monthly"
+    time: "02:00"
+- package-ecosystem: "github-actions"
+  directory: "/"
+  rebase-strategy: "disabled"
+  schedule:
+    interval: "monthly"
+    time: "02:00"

.github/workflows/codeql-analysis.yml

@@ -20,8 +20,15 @@ on:
   schedule:
     - cron: '20 0 * * 6'
 
+permissions:
+  contents: read
+
 jobs:
   analyze:
+    permissions:
+      actions: read  # for github/codeql-action/init to get workflow details
+      contents: read  # for actions/checkout to fetch code
+      security-events: write  # for github/codeql-action/autobuild to send a status report
     name: Analyze
     runs-on: ubuntu-latest
 
@@ -35,11 +42,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -50,7 +57,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -64,4 +71,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/maven-build.yml

@@ -1,98 +1,121 @@
 name: CI
 
-on: [push, pull_request]
+on: 
+  push:
+    branches:
+      - main
+      - '!/refs/heads/dependabot/*'
+  pull_request:
+    branches:
+      - '*'
+      - '!/refs/heads/patch*'
 
 # this is required by spotless for JDK 16+
 env:
   JAVA_11_PLUS_MAVEN_OPTS: "--add-opens jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED"
 
+permissions:
+  contents: read
+
 jobs:
   build:
     name: build-only (Java ${{ matrix.java }})
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        java: [ 16 ]
+        java: [ 17 ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up JDK
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           java-version: ${{ matrix.java }}
-          distribution: 'adopt'
-      - name: Cached .m2
-        uses: actions/cache@v2.1.6
-        with:
-          path: ~/.m2/repository
-          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
-          restore-keys: |
-            ${{ runner.os }}-maven-
+          distribution: 'zulu'
+          cache: 'maven'
       - name: Maven Install (skipTests)
         env:
           MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-        run: mvn -B install -DskipTests --file pom.xml
+        run: mvn -B clean install -DskipTests --file pom.xml
   site:
     name: site (Java ${{ matrix.java }})
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        java: [ 8, 11 ]
+        java: [ 17 ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up JDK
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           java-version: ${{ matrix.java }}
           distribution: 'adopt'
-      - uses: actions/cache@v2.1.6
-        with:
-          path: ~/.m2/repository
-          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
-          restore-keys: |
-            ${{ runner.os }}-maven-
+          cache: 'maven'
       - name: Maven Site
-        run: mvn -B site -D enable-ci --file pom.xml
-  test:
-    name: test (${{ matrix.os }}, Java ${{ matrix.java }})
+        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, windows ]
-        java: [ 8, 11, 16 ]
+        os: [ ubuntu ]
+        java: [ 8 ]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up JDK
-      uses: actions/setup-java@v2
+      uses: actions/setup-java@v3
       with:
         java-version: ${{ matrix.java }}
-        distribution: 'adopt'
-    - uses: actions/cache@v2.1.6
-      with:
-        path: ~/.m2/repository
-        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
-        restore-keys: |
-          ${{ runner.os }}-maven-
+        distribution: 'zulu'
+        cache: 'maven'
     # JDK 8
-    - name: Maven Install without Code Coverage
-      if: matrix.os == 'windows' && matrix.java == '8'
-      run: mvn -B install --file pom.xml
     - name: Maven Install with Code Coverage
-      if: matrix.os != 'windows' && matrix.java == '8'
-      run: mvn -B install -D enable-ci --file pom.xml
+      run: mvn -B clean install -D enable-ci -Djapicmp.skip --file pom.xml
     - name: Codecov Report 
-      if: matrix.os != 'windows' && matrix.java == '8'
-      uses: codecov/codecov-action@v1.5.2  
+      uses: codecov/codecov-action@v3.1.1
+  test:
+    name: test (${{ matrix.os }}, Java ${{ matrix.java }})
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu, windows ]
+        java: [ 11, 17 ]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up JDK
+      uses: actions/setup-java@v3
+      with:
+        java-version: ${{ matrix.java }}
+        distribution: 'zulu'
+        cache: 'maven'
     # JDK 11+
     - name: Maven Install without Code Coverage
-      if: matrix.os == 'windows' && matrix.java != '8'
+      if: matrix.os == 'windows'
       env:
         MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-      run: mvn -B install --file pom.xml "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"
+      run: mvn -B clean install -D japicmp.skip=true --file pom.xml "-Dsurefire.argLine=--add-opens java.base/java.net=ALL-UNNAMED"
     - name: Maven Install with Code Coverage
-      if: matrix.os != 'windows' && matrix.java != '8'
+      if: matrix.os != 'windows'
       env:
         MAVEN_OPTS: ${{ env.JAVA_11_PLUS_MAVEN_OPTS }}
-      run: mvn -B install -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"
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    needs: [build, test-8, test]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-java@v2
+        with:
+          java-version: 8
+          distribution: 'zulu'
+          cache: 'maven'
+      - name: Deploy
+        run: mvn --batch-mode deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-drafter.yml

@@ -6,8 +6,14 @@ on:
     branches:
       - main
 
+permissions:
+  contents: read
+
 jobs:
   update_release_draft:
+    permissions:
+      contents: write  # for release-drafter/release-drafter to create a github release
+      pull-requests: write  # for release-drafter/release-drafter to add label to PR
     runs-on: ubuntu-latest
     steps:
       - name: Release Drafter

CONTRIBUTING.md

@@ -1,5 +1,15 @@
 # Contributing
 
+## Make sure it's spotless
+
+Run `mvn spotless:apply` to fix any formatting, etc issues.
+
+## Make sure you pass CI
+
+If the following does not succeed, you will not pass the pull request checks.
+
+`mvn -D enable-ci clean install site` 
+
 ## Using WireMock and Snapshots
 
 This project has started converting to using WireMock to stub out http responses instead of use live data.

README.md

@@ -7,3 +7,9 @@
 
 
 See https://github-api.kohsuke.org/ for more details
+
+To locally publish changes to this API, update the version in `pom.xml` to a unique identifier.
+Then run `mvn install -Dmaven.test.skip -Dspotless.check.skip=true -Dgpg.skip -Dmaven.javadoc.skip=true -Djacoco.skip=true -Dspotbugs.skip`. 
+To use this dependency in `brain-backend`, update the version of `cortexapps-github-api` in `build.gradle.kts (:web)` to the same identifier.
+
+See this [Notion doc](https://www.notion.so/cortexio/How-to-publish-Github-Api-e80324a13abf4497afaa67e0a215e53a) for how to publish this client.