compliance.yml

# SPDX-License-Identifier: BSD-3-Clause
# Copyright (c) 2020 STMicroelectronics

name: open-amp lib compliance checks

on:
  pull_request:
    branches: [ main ]

jobs:
  checkpatch_review:
    name: checkpatch review
    runs-on: ubuntu-latest
    steps:
    - name: Checkout the code
      uses: actions/checkout@v4
      with:
        ref: ${{ github.event.pull_request.head.sha }}
        fetch-depth: 0

    - name: Detect changed files
      id: changes
      run: |
        git fetch origin ${{ github.base_ref }} --depth=1

        files=$(git diff --name-only origin/${{ github.base_ref }}...${{ github.event.pull_request.head.sha }})

        echo "Changed files:"
        printf '%s\n' "$files"

        files_spaced=$(echo "$files" | tr '\n' ' ')
        files_spaced=$(echo "$files_spaced" | sed 's/[[:space:]]*$//')

        echo "files=$files_spaced" >> "$GITHUB_OUTPUT"

    - name: Check if only ignored paths changed
      id: skip
      run: |
        IGNORED_PATHS=("docs/" "scripts/" ".github/")

        only_ignored="true"

        for f in ${{ steps.changes.outputs.files }}; do
          echo "Processing file: $f"
          is_ignored="false"
          for p in "${IGNORED_PATHS[@]}"; do
            if [[ "$f" == "$p"* ]]; then
              is_ignored="true"
              break
            fi
          done

          if [[ "$is_ignored" == "false" ]]; then
            only_ignored="false"
            break
          fi
        done

        echo "only_ignored=$only_ignored" >> "$GITHUB_OUTPUT"

    - name: Skip compliance if only ignored paths changed
      if: steps.skip.outputs.only_ignored == 'true'
      run: |
        echo "Only ignored paths changed; skipping compliance checks."
        echo "<testsuite name=\"compliance\" tests=\"0\" failures=\"0\"/>" > compliance.xml

    - name: Install python dependencies
      if: steps.skip.outputs.only_ignored != 'true'
      run: |
        pip3 install setuptools
        pip3 install python-magic junitparser gitlint codespell lxml

    - name: Run Compliance Tests
      if: steps.skip.outputs.only_ignored != 'true'
      continue-on-error: true
      id: compliance
      env:
        BASE_REF: ${{ github.base_ref }}
      run: |
        export PATH=$PATH:~/.local/bin
        export PROJECT_BASE=$PWD
        git config --global user.email "you@example.com"
        git config --global user.name "Your Name"
        git rebase origin/${BASE_REF}
        git log  --pretty=oneline | head -n 10
        ./scripts/ci/check_compliance.py --annotate -c origin/${BASE_REF}..

    - name: upload-results
      uses: actions/upload-artifact@main
      continue-on-error: True
      with:
        name: compliance.xml
        path: compliance.xml

    - name: check-warns
      if: steps.skip.outputs.only_ignored != 'true'
      run: |
        if [[ ! -s "compliance.xml" ]]; then
          exit 1;
        fi

        files=($(./scripts/ci/check_compliance.py -l))
        for file in "${files[@]}"; do
          f="${file}.txt"
          if [[ -s $f ]]; then
            errors=$(cat "$f")
            errors="${errors//'%'/'%25'}"
            errors="${errors//$'\n'/'%0A'}"
            errors="${errors//$'\r'/'%0D'}"
            echo "::error file=${f}::$errors"
            exit=1
          fi
        done

        if [ "${exit}" == "1" ]; then
          exit 1;
        fi