lint.yml

---
###########################
###########################
## Linter GitHub Actions ##
###########################
###########################
name: lint

#
# Documentation:
# https://help.github.com/en/articles/workflow-syntax-for-github-actions
#

#############################
# Start the job on all push #
#############################
on: [ push, pull_request, workflow_dispatch ]

###############
# Set the Job #
###############
jobs:
  build:
    # Name the Job
    name: Lint Code Base
    # Set the agent to run on
    runs-on: ubuntu-latest

    ##################
    # Load all steps #
    ##################
    steps:
      ##########################
      # Checkout the code base #
      ##########################
      - name: Checkout Code
        uses: actions/checkout@v2
        with:
          fetch-depth: 0

      ################################
      # Run Linter against code base #
      ################################
      - name: Lint Code Base
        uses: github/super-linter@latest
        env:
          VALIDATE_ALL_CODEBASE: false
          VALIDATE_PYTHON_PYLINT: false # disable pylint, as we have not configured it
          VALIDATE_PYTHON_MYPY: false # same as above
          VALIDATE_JSCPD: false # Can not exclude specific file: https://github.com/kucherenko/jscpd/issues/215
          PYTHON_FLAKE8_CONFIG_FILE: tox.ini
          PYTHON_BLACK_CONFIG_FILE: pyproject.toml
          PYTHON_ISORT_CONFIG_FILE: pyproject.toml
          EDITORCONFIG_FILE_NAME: ../../.editorconfig
          FILTER_REGEX_INCLUDE: maro/.*
          FILTER_REGEX_EXCLUDE: tests/.*
          DEFAULT_BRANCH: master
          GITHUB_TOKEN: ${{ secrets.LINT_TOKEN }}