docs: update docs to reflect min requirements and better explain roles #294
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Python Lint | |
on: | |
push: | |
paths: | |
- 'plugins/**' | |
- '.github/workflows/linting.yml' | |
pull_request: | |
paths: | |
- 'plugins/**' | |
- '.github/workflows/linting.yml' | |
jobs: | |
flake8: | |
runs-on: ubuntu-latest | |
env: | |
PY_COLORS: 1 | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
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: | |
flake8 ./plugins/ | |
pylint: | |
runs-on: ubuntu-latest | |
env: | |
PY_COLORS: 1 | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
python -m pip install pylint | |
- name: Lint with pylint | |
run: | | |
find plugins/ -name "*.py" | xargs pylint | |
bandit: | |
runs-on: ubuntu-latest | |
env: | |
PY_COLORS: 1 | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
python -m pip install bandit | |
- name: Lint with bandit | |
run: | | |
bandit -l -i -r ./plugins/ |