Update to make pydocstyle --numpy compliant. #3
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: lint | |
on: | |
# run on every push to main | |
push: | |
branches: | |
- main | |
- qc-workflow | |
# run on every push (not commit) to a PR, plus open/reopen | |
pull_request: | |
types: | |
- synchronize | |
- opened | |
- reopened | |
jobs: | |
various: | |
name: various (Black, pylint, pydocstyle, mypy) | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
- run: pip install black pylint pydocstyle mypy | |
# annotate each step with `if: always` to run all regardless | |
- name: Assert that code matches Black code style | |
if: always() | |
uses: psf/black@stable | |
- name: Lint with pylint | |
if: always() | |
run: pylint ./ | |
- name: Lint with pydocstyle | |
if: always() | |
run: pydocstyle --convention=numpy ./ | |
- name: Lint with mypy | |
if: always() | |
run: mypy ./ |