style_checks.yaml

# Code lint and style checks
#
# This workflow runs code style and lint checks to check if the codes have
# consistent code style and are high-quality.
#
# It is run on every commit to the main and pull request branches. It is also
# scheduled to run daily on the main branch.
#
name: Style Checks

on:
  push:
    branches: [ main ]
  pull_request:
  # Schedule daily tests
  schedule:
    - cron: '0 0 * * *'

jobs:
  style_check:
    name: Style Checks
    runs-on: ubuntu-latest

    steps:
      # Checkout current git repository
      - name: Checkout
        uses: actions/checkout@v4.1.6

      # Setup Python
      - name: Set up Python
        uses: actions/setup-python@v5.1.0
        with:
          python-version: '3.12'

      - name: Install packages
        run: |
          python -m pip install ruff
          python -m pip list
          sudo apt-get install dos2unix

      - name: Formatting check (ruff)
        run: make check

      - name: Ensure files use UNIX line breaks and have 644 permission
        run: |
          git ls-files -z | xargs -0 dos2unix --quiet
          git ls-files -z | xargs -0 chmod 644
          if [[ $(git ls-files -m) ]]; then git --no-pager diff HEAD; exit 1; fi

      - name: Ensure example scripts have at least one code block separator
        run: |
          git ls-files 'examples/**/*.py' | xargs grep --files-without-match '# %%' > output.txt
          nfiles=$(wc --lines output.txt | awk '{print $1}')
          if [[ $nfiles > 0 ]]; then
            echo "Code block separator '# %%' is required in following example files:"
            cat output.txt
            rm output.txt
            exit $nfiles
          fi