sonar-analysis.yml

name: "SonarCloud"

on:
  workflow_run:
    workflows: [ Build ]
    types: [ completed ]

jobs:
  debug:
    runs-on: ubuntu-latest
    name: Display Context
    steps:
      - name: Display Github Event Context
        run: echo "$GITHUB_CONTEXT"
        env:
          GITHUB_CONTEXT: ${{ toJson(github) }}

  analyze:
    if: ${{ github.repository == 'eyefloaters/console' && github.event.workflow_run.conclusion == 'success' }}
    runs-on: ubuntu-latest
    name: Analyze
    steps:
      - name: Display Github Event Context
        run: echo "$GITHUB_CONTEXT"
        env:
          GITHUB_CONTEXT: ${{ toJson(github) }}

      ## Checkout the source of the event that triggered this workflow,
      ## PR commit (pull_request event) or commit (push event).
      - name: Checkout
        uses: actions/checkout@v4
        with:
          repository: ${{ github.event.workflow_run.head_repository.full_name }}
          ref: ${{ github.event.workflow_run.head_sha }}
          fetch-depth: 0

      ## Retrieve the `target` directory from the build job
      - name: Fetch Build Result
        uses: actions/github-script@v7
        with:
          script: |
            var artifacts = await github.rest.actions.listWorkflowRunArtifacts({
               owner: context.repo.owner,
               repo: context.repo.repo,
               run_id: ${{ github.event.workflow_run.id }},
            });
            var matchArtifact = artifacts.data.artifacts.filter((artifact) => {
              return artifact.name == "target"
            })[0];
            var download = await github.rest.actions.downloadArtifact({
               owner: context.repo.owner,
               repo: context.repo.repo,
               artifact_id: matchArtifact.id,
               archive_format: 'zip',
            });
            var fs = require('fs');
            fs.writeFileSync('${{github.workspace}}/api/target.zip', Buffer.from(download.data));

      ## Extract the `target` directory from the build job
      - name: Extract Build Result
        run: |
          unzip api/target.zip

      ## Load the context from the build job - runs for any trigger to allow templates with `steps.build_context.outputs.content` 
      ## to be accepted by GitHub Actions.
      - name: Read Build Context
        id: build_context
        uses: juliangruber/read-file-action@v1
        with:
          path: ./api/target/build-context.json

      ## (PRs Only) Check out the base branch (target of the PR)
      - name: Checkout Base Branch (PR Only)
        if: github.event.workflow_run.event == 'pull_request'
        env:
          BASE_BRANCH: ${{ fromJson(steps.build_context.outputs.content).base_ref }}
        run: |
          git remote add upstream ${{ github.event.repository.clone_url }}
          git fetch upstream --prune --tags --force
          git checkout -B $BASE_BRANCH upstream/$BASE_BRANCH

          git checkout ${{ github.event.workflow_run.head_sha }}

          git clean -ffdx --exclude=target/ && git reset --hard HEAD

      - name: Setup JDK
        uses: actions/setup-java@v4
        with:
          java-version: '17'
          distribution: 'adopt'

      - name: Cache SonarCloud packages
        uses: actions/cache@v4
        with:
          path: ~/.sonar/cache
          key: ${{ runner.os }}-sonar
          restore-keys: ${{ runner.os }}-sonar

      - name: Cache Maven packages
        uses: actions/cache@v4
        with:
          path: ~/.m2
          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
          restore-keys: ${{ runner.os }}-m2

      ## (PRs Only) Run Sonar analysis against the results of the build job, providing PR information
      - name: SonarCloud Analysis (PR Only)
        if: github.event.workflow_run.event == 'pull_request'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
        run: |
          mvn -B --no-transfer-progress org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -f api/pom.xml \
            -Dsonar.projectKey=eyefloaters_console  \
            -Dsonar.token=${SONAR_TOKEN} \
            -Dsonar.scm.revision=${{ github.event.workflow_run.head_sha }} \
            -Dsonar.pullrequest.key=${{ fromJson(steps.build_context.outputs.content).event.number }} \
            -Dsonar.pullrequest.branch=${{ fromJson(steps.build_context.outputs.content).head_ref }} \
            -Dsonar.pullrequest.base=${{ fromJson(steps.build_context.outputs.content).base_ref }}

      ## (Push Only) Run Sonar analysis against the results of the build job
      - name: SonarCloud Analysis (Push Only)
        if: github.event.workflow_run.event == 'push'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
        run: |
          mvn -B --no-transfer-progress org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -f api/pom.xml \
            -Dsonar.projectKey=eyefloaters_console \
            -Dsonar.token=${SONAR_TOKEN} \
            -Dsonar.scm.revision=${{ github.event.workflow_run.head_sha }} \
            -Dsonar.branch.name=${{ github.event.workflow_run.head_branch }}