ci.yaml

name: CI

on:
  push:
    branches: ["*"]
  pull_request:
    branches: ["*"]

jobs:
  determine_version:
    runs-on: ubuntu-latest
    outputs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
      - id: set-matrix
        run: |
          if [[ "${{ github.event_name }}" == 'push' && "${{ github.ref }}" == 'refs/heads/master' ]]; then
            # Push to master branch
            echo 'matrix=["3.7", "3.9", "3.10", "3.11"]' >> $GITHUB_OUTPUT
          elif [[ "${{ github.event_name }}" == 'pull_request' && "${{ github.event.pull_request.base.ref }}" == 'master' ]]; then
            # PR to master branch
            echo 'matrix=["3.7", "3.9", "3.10", "3.11"]' >> $GITHUB_OUTPUT
          else
            echo 'matrix=["3.9"]' >> $GITHUB_OUTPUT
          fi

  build:
    needs: determine_version
    strategy:
      matrix:
        platform: [ubuntu-latest]
        python-version: ${{fromJson(needs.determine_version.outputs.matrix)}}

    runs-on: ${{ matrix.platform }}

    steps:
      - uses: actions/checkout@v4
        with:
          submodules: true

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}

      - uses: actions/cache@v4
        with:
          path: ${{ env.pythonLocation }}
          key: ${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ hashFiles('docs/requirements.txt') }}

      - name: Install dependencies
        run: |
          python -m pip install --upgrade --upgrade-strategy eager pip
          pip install flake8
          pip install coverage
          pip install -r requirements.txt
          pip install -r docs/requirements.txt

      - name: Lint with flake8
        run: |
          # stop the build if there are Python syntax errors or undefined names

          flake8 . --count --show-source --statistics --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics 
          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide

      - name: Test with unittest
        run: |
          HED_GITHUB_TOKEN=${{ secrets.HED_GITHUB_TOKEN }} coverage run -m unittest

      - name: Run spec_test coverage
        run: HED_GITHUB_TOKEN=${{ secrets.HED_GITHUB_TOKEN }} coverage run --append -m unittest spec_tests/test_errors.py
        continue-on-error: true

      - name: Archive code coverage results
        if: ${{matrix.python-version == '3.9'}}
        uses: actions/upload-artifact@v4
        with:
          name: code-coverage-report
          path: .coverage

  check-secret:
    runs-on: ubuntu-latest
    outputs:
      secrets-exist: ${{ steps.check-for-secrets.outputs.defined }}
    steps:
      - name: Check for Secret availability
        id: check-for-secrets
        # perform secret check & put boolean result as an output
        shell: bash
        run: |
          if [ "${{ secrets.CC_TEST_REPORTER_ID }}" != '' ]; then
            echo "defined=true" >> $GITHUB_OUTPUT;
          else
            echo "defined=false" >> $GITHUB_OUTPUT;
          fi

  coverage:
    name: Publish coverage
    needs: [build, check-secret]
    runs-on: ubuntu-latest
    if: needs.check-secret.outputs.secrets-exist == 'true'

    steps:
      - uses: actions/checkout@v4
      - name: Set up Python 3.9
        uses: actions/setup-python@v5
        with:
          python-version: 3.9

      - uses: actions/cache@v4
        with:
          path: ${{ env.pythonLocation }}
          key: ${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ hashFiles('docs/requirements.txt') }}

      - name: Install dependencies
        run: |
          python -m pip install --upgrade --upgrade-strategy eager pip
          pip install flake8
          pip install coverage
          pip install -r requirements.txt
          pip install -r docs/requirements.txt

      - name: Download a single artifact
        uses: actions/download-artifact@v4
        with:
          name: code-coverage-report

      - name: publish-coverages
        with:
          coverageCommand: coverage xml
          debug: true
        uses: paambaati/codeclimate-action@v5.0.0
        env:
          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}