Connect your CI

Blue Cave supports just about any CI that you can think of. Here are a few examples of some popular CI systems.

GitHub Actions

Here's a short and concise GitHub action to build, test, analyze, and report coverage for your project to Blue Cave:

name: Java CI with Gradle and Blue Cave

on:
  push:
  pull_request:

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
    - uses: actions/checkout@v4

    - name: Set up JDK 24
      uses: actions/setup-java@v4
      with:
        java-version: '24'
        distribution: 'temurin'

    - name: Build with Gradle Wrapper
      run: ./gradlew --no-daemon build # Also runs tests.

    - name: Analyze and Report Coverage to Blue Cave
      env:
        BLUECAVE_TOKEN: ${{ secrets.BLUECAVE_TOKEN }}
      run: ./gradlew bluecaveReport

Other CI Systems

For some well-known CI systems (such as GitHub), our plugin will automatically detect the appropriate settings. However, if you are using a CI system not listed here, you can still use Blue Cave.

Set BLUECAVE_TOKEN and BLUECAVE_EXTRA_OPTS in your environment before invoking the reporting task:

export BLUECAVE_TOKEN=<your project token>
export BLUECAVE_EXTRA_OPTS="--branch <branch name> --commit-sha <commit SHA> --pull-request <true or false>"
./gradlew bluecaveReport