[workflow] Build once and run tests against multiple Kubo versions (#272)

* Replace IPFS installation script with Docker Compose action
* Turn Kubo's telemetry off
* Parameterize Kubo's Docker image tag
* Run matrix build against multiple Kubo versions
* Store Kubo's logs for troubleshooting
* Format Docker Compose file with Spotless
* Build project only once and run multiple tests without compilation
* Install Docker Compose explicitly

Author: manandbytes

.github/workflows/ci.yml

@@ -10,9 +10,39 @@ on:
 
 jobs:
   build:
+    runs-on: ubuntu-latest
+    name: Build w/o tests
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up JDK 21
+      uses: actions/setup-java@v5
+      with:
+        distribution: temurin
+        java-version: 21
+        cache: 'maven'
+    - name: Build with Maven
+      run: ./mvnw -V -DskipTests --no-transfer-progress package
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v6
+      with:
+        name: maven-build-artifacts
+        path: target/
+        retention-days: 1
 
+  test:
+    needs: build
     runs-on: ubuntu-latest
 
+    strategy:
+      fail-fast: false
+      matrix:
+        kubo:                   # https://github.com/ipfs/kubo#docker
+          - v0.39.0             # specific release tag
+          - release             # latest stable release
+          - master-latest       # developer preview, HEAD of master branch
+
+    name: Test with Kubo tag ${{matrix.kubo}}
+
     steps:
     - uses: actions/checkout@v6
     - name: Set up JDK 21
@@ -21,7 +51,22 @@ jobs:
         distribution: temurin
         java-version: 21
         cache: 'maven'
-    - name: Install and run IPFS
-      run: ./install-run-ipfs.sh
+    - name: Download compiled artifacts
+      uses: actions/download-artifact@v5
+      with:
+        name: maven-build-artifacts
+        path: target/
+    - name: Set up Docker Compose
+      run: sudo apt-get install docker-compose
+    - name: Run Kubo ${{matrix.kubo}} IPFS daemon
+      env:
+        KUBO_TAG: ${{matrix.kubo}}
+      run: docker compose up -d
     - name: Build & run tests with Maven
-      run: ./mvnw -V verify
+      run: ./mvnw -V --no-transfer-progress -Dmaven.compiler.skip=true verify
+    - name: Kubo logs
+      if: ${{always()}}
+      run: docker compose logs
+    - name: Shut down Docker Compose
+      if: always()
+      run: docker compose down

docker-compose.yml

@@ -1,7 +1,8 @@
-version: '2'
 services:
   ipfs-daemon:
-    image: 'ipfs/kubo:v0.39.0'
+    image: ipfs/kubo:${KUBO_TAG-release} # default is latest release, see https://github.com/ipfs/kubo#docker
+    environment:
+      IPFS_TELEMETRY: off
     ports:
       - "4001:4001"
       - "5001:5001"

pom.xml

@@ -107,6 +107,11 @@
               <quiet>true</quiet>
             </sortPom>
           </pom>
+          <yaml>
+            <includes>
+              <include>docker-compose.yml</include>
+            </includes>
+          </yaml>
           <upToDateChecking>
             <enabled>true</enabled>
           </upToDateChecking>