From a1c9bf5c535cd2dc7d8b842fe4aec9d06b40ef41 Mon Sep 17 00:00:00 2001 From: Jacob Bieker Date: Thu, 16 Sep 2021 16:01:25 +0100 Subject: [PATCH 1/3] Add docstring linter --- .github/workflows/linters.yaml | 24 ++++++++++++++++++++++++ .github/workflows/workflows.yaml | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/linters.yaml diff --git a/.github/workflows/linters.yaml b/.github/workflows/linters.yaml new file mode 100644 index 00000000..d19fc7b8 --- /dev/null +++ b/.github/workflows/linters.yaml @@ -0,0 +1,24 @@ +name: Lint Python + +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.8, 3.9] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pydocstyle + - name: Docstyle linting + run: | + pydocstyle --convention=google diff --git a/.github/workflows/workflows.yaml b/.github/workflows/workflows.yaml index cec24314..4ac3f563 100644 --- a/.github/workflows/workflows.yaml +++ b/.github/workflows/workflows.yaml @@ -1,4 +1,4 @@ -name: Python package +name: Tests on: push: From 7a7aeee540269fa5c9785720f370fa6102f05894 Mon Sep 17 00:00:00 2001 From: Jacob Bieker Date: Thu, 16 Sep 2021 17:20:30 +0100 Subject: [PATCH 2/3] Ignore certain errors --- .github/workflows/linters.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/linters.yaml b/.github/workflows/linters.yaml index d19fc7b8..62df979c 100644 --- a/.github/workflows/linters.yaml +++ b/.github/workflows/linters.yaml @@ -1,6 +1,6 @@ name: Lint Python -on: [push, pull_request] +on: [push] jobs: build: @@ -21,4 +21,4 @@ jobs: pip install pydocstyle - name: Docstyle linting run: | - pydocstyle --convention=google + pydocstyle --convention=google --add-ignore=D200,D210,D212,D415 From a6d5b10896ba11317482714ec737a377b77e8ab8 Mon Sep 17 00:00:00 2001 From: Jacob Bieker Date: Thu, 16 Sep 2021 17:21:04 +0100 Subject: [PATCH 3/3] Only run linting once --- .github/workflows/linters.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/linters.yaml b/.github/workflows/linters.yaml index 62df979c..d966d27a 100644 --- a/.github/workflows/linters.yaml +++ b/.github/workflows/linters.yaml @@ -7,7 +7,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: [3.8, 3.9] + python-version: [3.9] steps: - uses: actions/checkout@v2