maven-ci.yml

#
# The MIT License
# Copyright © 2014-2021 Ilkka Seppälä
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#

# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven

# We are using two jobs here for testing our code on the latest JDK 11 build as well as a more satble build version of 11.0.3
# You can see the full discussion here https://github.com/iluwatar/java-design-patterns/pull/1868#issue-1029459688

name: Java CI

on:
  push:
    branches: [ master ]


jobs:

  # This Workflow Job will build this project and run Sonar analysis using JDK 11.0.3
  build-and-analyze:

    name: Build and Run Sonar analysis on JDK 11.0.3
    runs-on: ubuntu-20.04
    steps:

    - name: Checkout Code
      uses: actions/checkout@v2
      with:
        # Disabling shallow clone for improving relevancy of SonarQube reporting
        fetch-depth: 0

    - name: Set up JDK 11.0.3
      uses: actions/setup-java@v2
      with:
        java-version: 11.0.3
        distribution: 'zulu'
        cache: 'maven'

    # Cache Sonar packages which as used to run anaylysis and collect metrics
    - name: Cache SonarCloud packages
      uses: actions/cache@v2
      with:
        path: ~/.sonar/cache
        key: ${{ runner.os }}-sonar
        restore-keys: ${{ runner.os }}-sonar

    # Some tests need screen access
    - name: Install xvfb
      run: sudo apt-get install -y xvfb

    - name: Build with Maven and run SonarQube analysis
      run: xvfb-run ./mvnw clean verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar
      env:
        # These two env variables are needed for sonar analysis
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

  
  # This Workflow Job is going to build the project on the latest stable JDK 11
  build:

    name: Build and Test on JDK 11
    runs-on: ubuntu-20.04
    steps:

    - name: Checkout Code
      uses: actions/checkout@v2

    - name: Set up JDK 11 (Latest)
      uses: actions/setup-java@v2
      with:
        java-version: 11
        distribution: 'zulu'
        cache: 'maven'

    # Some tests need screen access
    - name: Install xvfb
      run: sudo apt-get install -y xvfb

    - name: Build with Maven
      run: xvfb-run ./mvnw clean verify