linter.yml

###########################
###########################
## Linter GitHub Actions ##
###########################
###########################
name: Lint Code Base

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

#############################
# Start the job on all push #
#############################
on:
  push:
    branches-ignore: [main]
    # Remove the line above to run when pushing to master

###############
# 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:
        # Full git history is needed to get a proper list of changed files within `super-linter`
        fetch-depth: 0

    ################################
    # Run Linter against code base #
    ################################
    - name: Lint Code Base
      uses: docker://ghcr.io/github/super-linter:slim-v4
      env:
        VALIDATE_ALL_CODEBASE: false
        DEFAULT_BRANCH: main
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        VALIDATE_SNAKEMAKE_LINT: false
        VALIDATE_SNAKEMAKE_SNAKEFMT: false
        VALIDATE_PYTHON_ISORT: false
        VALIDATE_PYTHON_MYPY: false
        VALIDATE_PYTHON_FLAKE8: false
        VALIDATE_PYTHON_BLACK: false
        VALIDATE_NATURAL_LANGUAGE: false
        VALIDATE_JSCPD: false
        VALIDATE_GITLEAKS: false