formatting_checks.yml

# This file is part of pydidas.
#
# Copyright 2024, Helmholtz-Zentrum Hereon
# SPDX-License-Identifier: CC-BY-4.0
#
# This workflow will check the formatting of the newly pushed commits
# to verify that all files are corretly formatted.


name: formatting checks

on:
  pull_request:
    branches: [ "master" ]

jobs:
  check_black:
    runs-on: ubuntu-latest   
    steps:
    - name: Check out source repository
      uses: actions/checkout@v3
    - name: Setup python
      uses: actions/setup-python@v4
      with:
        python-version: "3.11"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install black
    - name: Code formatting with black
      run: |
        python -m black . --check
  
  check_flake8:
    runs-on: ubuntu-latest
    steps:
    - name: Check out source repository
      uses: actions/checkout@v3
    - name: Setup python
      uses: actions/setup-python@v4
      with:
        python-version: "3.11"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install flake8
    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        python -m flake8 --config .flake8 --exit-zero
        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide

  check_reuse:
    runs-on: ubuntu-latest
    steps:
    - name: Reuse check
      uses: fsfe/reuse-action@v2

  check_isort:
    runs-on: ubuntu-latest
    steps:
    - name: isort checks
      uses: isort/isort-action@master

  check_copyrights:
    runs-on: ubuntu-latest
    steps:
    - name: Check out source repository
      uses: actions/checkout@v3
      with:
        fetch-depth: 0
    - name: Setup python
      uses: actions/setup-python@v4
      with:
        python-version: "3.11"
    - name: Install dependencies
      run: |
        python -m pip install GitPython
    - name: Check copyrights
      run: |
        python formatter.py --copyright --check --git-only