Skip to content

Fix README

Fix README #512

Workflow file for this run

---
name: Super-Linter
on: # yamllint disable-line rule:truthy
push:
branches: "**"
pull_request:
types:
- opened
- synchronize
- reopened
permissions: {}
jobs:
# Set the job key. The key is displayed as the job name
# when a job name is not provided
super-lint:
# Name the Job
name: Lint code base
# Set the type of machine to run on
runs-on: ubuntu-latest
permissions:
contents: read
packages: read
# To report GitHub Actions status checks
statuses: write
steps:
# Checks out a copy of your repository on the ubuntu-latest machine
- name: Checkout code
uses: actions/checkout@v4
with:
# super-linter needs the full git history to get the
# list of files that changed across commits
fetch-depth: 0
# Runs the Super-Linter action
- name: Run Super-Linter
uses: super-linter/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
LINTER_RULES_PATH: /
PYTHON_ISORT_CONFIG_FILE: pyproject.toml
PYTHON_PYLINT_CONFIG_FILE: pyproject.toml
# Suppressed because it conflicts with clang-format in some cases
VALIDATE_CPP: false
# Suppressed because copy/paste is sometimes required at low level
VALIDATE_JSCPD: false
# Suppressed because it even accuses book titles
VALIDATE_NATURAL_LANGUAGE: false
# Disabled temporarily
VALIDATE_CHECKOV: false