workflow.yml

name: 'Run workflow'

on:
  push:
    branches: [main]
    paths:
      - 'src/**'
      - '.github/workflows/workflow.yml'

  pull_request:
    branches: [main]
    paths:
      - 'src/**'
      - '.github/workflows/workflow.yml'

jobs:
  project-build:
    runs-on: ubuntu-latest

    steps:
        # Checkout the code
      - uses: actions/checkout@v4

        # Ensure the gradle-wrapper.jar file is legitimate
        # For explanations, see https://tomgregory.com/gradle/build-gradle-projects-with-github-actions/
      - uses: gradle/wrapper-validation-action@v2

        # Install Java 21, enable Gradle caching
      - name: Set up JDK 21
        uses: actions/setup-java@v4
        with:
          java-version: 21
          distribution: 'temurin'
          cache: gradle

        # Build the project, skipping checkstyle and tests
      - name: Build
        run: ./gradlew build --no-daemon -x checkstyleMain -x checkstyleTest -x test

        # Run checkstyle on main and test
      - name: Run Checkstyle
        run: ./gradlew checkstyleMain checkstyleTest

        # Run all the tests
      - name: Run Tests
        run: ./gradlew test

        # Run coverage with JaCoCo
      - name: Run Coverage
        run: |
          ./gradlew jacocoTestCoverageVerification
          ./gradlew jacocoTestReport

        # Create a JaCoCo Badge with the computed coverage (can be found on the workflow page)
      - name: Generate JaCoCo Badge
        uses: cicirello/jacoco-badge-generator@v2.11.0
        with:
          generate-branches-badge: true
          jacoco-csv-file: build/reports/jacoco/test/jacocoTestReport.csv