workflow.yml

name: Development
on: push

jobs:
  setup-requirements:
    name: Get Requirements
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      # Setup Python (faster than using Python container)
      - name: Setup Python
        uses: actions/setup-python@v5.3.0
        with:
          python-version: "3.12.0"

      - name: Check out repository code
        uses: actions/checkout@v4.2.2
      
      - name: Install Hatch
        run: python -m pip install --upgrade hatch

      - name: Get Hatch Dependency Hash
        run: echo "HATCH_DEP_HASH=$(hatch dep hash)" >> $GITHUB_ENV

      - name: Cache Hatch environment
        uses: actions/cache@v4.1.2
        with:
          path: |
            ~/.cache/hatch
            ~/.local/share/hatch
          key: ${{ runner.os }}-hatch-${{ env.HATCH_DEP_HASH }}

      - name: Generate Requirements
        run: python -m hatch dep show requirements > requirements.txt
        
      # Upload requirements to have them
      - name: Upload Requirements
        uses: actions/upload-artifact@v4.4.3
        with:
          name: requirements
          path: requirements.txt

  pylint:
    name: PyLint
    runs-on: ubuntu-latest
    needs: setup-requirements
    timeout-minutes: 10

    steps:
      - name: Check out repository code
        uses: actions/checkout@v4.2.2

      # Setup Python (faster than using Python container)
      - name: Setup Python
        uses: actions/setup-python@v5.3.0
        with:
          python-version: "3.12.0"

      - name: Install Hatch
        if: steps.cache-hatch.outputs.cache-hit != 'true'
        run: python -m pip install --upgrade hatch

      - name: Cache Hatch environment
        uses: actions/cache@v4.1.2
        with:
          path: |
            ~/.cache/hatch
            ~/.local/share/hatch
          key: ${{ runner.os }}-hatch-${{ env.HATCH_DEP_HASH }}

      # Don't fail just output, since we want the score to be above 9 not 10.0
      # Don’t let the Perfect be the Enemy of the Good
      - name: Pylint on esbmc_ai
        run: hatch run pylint esbmc_ai || true
      
      # Check if pass, the test command only takes integers so truncate decimals
      - name: Check If Pass (90%)
        run: |
          SCORE="$(sed -n '$s/[^0-9]*\([0-9.]*\).*/\1/p' <<< "$(hatch run pylint esbmc_ai)")"
          test "${SCORE%.*}" -ge 9

  test:
    name: PyTest
    needs: setup-requirements
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - name: Check out repository code
        uses: actions/checkout@v4.2.2

      # Setup Python (faster than using Python container)
      - name: Setup Python
        uses: actions/setup-python@v5.3.0
        with:
          python-version: "3.12.0"

      - name: Install Hatch
        if: steps.cache-hatch.outputs.cache-hit != 'true'
        run: python -m pip install --upgrade hatch

      - name: Cache Hatch environment
        uses: actions/cache@v4.1.2
        with:
          path: |
            ~/.cache/hatch
            ~/.local/share/hatch
          key: ${{ runner.os }}-hatch-${{ env.HATCH_DEP_HASH }}

      - name: Run test suite
        run: hatch run pytest

  # incremenet_version:
  #   name: Increment Version
  #   runs-on: ubuntu-latest
  #   needs: setup-requirements
  #   timeout-minutes: 10
  #   # Configure permissions for git push
  #   permissions:
  #     contents: write

  #   steps:
  #     - name: Check out repository code
  #       uses: actions/checkout@v4.2.2
  #       with:
  #         persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
  #         fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.

  #     # Setup Python (faster than using Python container)
  #     - name: Setup Python
  #       uses: actions/setup-python@v5.3.0
  #       with:
  #         python-version: "3.12.0"

  #     - name: Install Hatch
  #       if: steps.cache-hatch.outputs.cache-hit != 'true'
  #       run: python -m pip install --upgrade hatch

  #     - name: Cache Hatch environment
  #       uses: actions/cache@v4.1.2
  #       with:
  #         path: |
  #           ~/.cache/hatch
  #           ~/.local/share/hatch
  #         key: ${{ runner.os }}-hatch-${{ env.HATCH_DEP_HASH }}
      
  #     - name: Invrement Version
  #       run: hatch version dev

  #     - name: Configure Git
  #       run: |
  #         git config --global user.email "github-actions[bot]@users.noreply.github.com"
  #         git config --global user.name "github-actions[bot]"

  #     # Add and commit without changing message
  #     - name: Git Add
  #       run: |
  #         git add esbmc_ai/__about__.py
  #         git commit -m "Increment version"

  #     - name: GitHub Push
  #       if: github.ref != 'refs/heads/master'
  #       uses: ad-m/github-push-action@v0.8.0
  #       with:
  #         github_token: ${{ secrets.GITHUB_TOKEN }}
  #         branch: ${{ github.ref }}

  build:
    name: Build
    runs-on: ubuntu-latest
    needs: setup-requirements
    timeout-minutes: 10

    steps:
      - name: Check out repository code
        uses: actions/checkout@v4.2.2

      # Setup Python (faster than using Python container)
      - name: Setup Python
        uses: actions/setup-python@v5.3.0
        with:
          python-version: "3.12.0"

      - name: Install Hatch
        if: steps.cache-hatch.outputs.cache-hit != 'true'
        run: python -m pip install --upgrade hatch

      - name: Cache Hatch environment
        uses: actions/cache@v4.1.2
        with:
          path: |
            ~/.cache/hatch
            ~/.local/share/hatch
          key: ${{ runner.os }}-hatch-${{ env.HATCH_DEP_HASH }}

      - name: Hatch build
        run: hatch build
      
      - name: Upload build files
        uses: actions/upload-artifact@v4.4.3
        with:
          name: build
          path: dist