Autoformatting #413
Workflow file for this run
This file contains hidden or 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: Linting | |
| # Run linter (flake8) and custom linting script (tests/linting/python_linting.py) | |
| on: | |
| # pushes to main | |
| push: | |
| branches: | |
| - main | |
| # PRs | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review] | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 3.12 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.12 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install --upgrade setuptools build | |
| - name: Build and install cyten | |
| # needed to run custom linting script, which imports cyten | |
| run: | | |
| python -m build . | |
| python -m pip install ".[lint]" | |
| - name: Lint python code | |
| # uses options from pyproject.toml | |
| run: | | |
| ruff check | |
| - name: Lint docs | |
| # we run flake8 only for RST rules of docstrings in .py files | |
| # config in .flake8 | |
| run: | | |
| flake8 --select RST | |
| sphinx-lint -e all docs --max-line-length=1000 -d default-role | |
| - name: Run autoformatter | |
| # uses options from pyproject.toml | |
| run: | | |
| ruff format --diff | |
| - name: Run custom linting script | |
| run: | | |
| python ./tests/linting/python_linting.py |