Skip to content

Commit

Permalink
Add actions to lint and test.
Browse files Browse the repository at this point in the history
  • Loading branch information
vengroff committed Feb 14, 2024
1 parent d93880a commit 793ef0a
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Run various link checks, like flake8 and black, to make sure
# our code remains in good shape, avoids common bugs, and follows
# common coding conventions.
name: lint

on:
push:
branches-ignore:
- main

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
linting:
runs-on: ubuntu-latest
steps:
#----------------------------------------------
# check-out repo and set-up python
#----------------------------------------------
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.11
#----------------------------------------------
# load pip cache if cache exists
#----------------------------------------------
- uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip
restore-keys: ${{ runner.os }}-pip
#----------------------------------------------
# run linters
#----------------------------------------------
- run: python -m pip install black[jupyter] flake8 isort pylint
- run: |
flake8 --show-source .
black . --check
isort --profile black .
82 changes: 82 additions & 0 deletions .github/workflows/unit-test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Run unit tests every time a branch is pushed. This is the simplest
# version of unit testing, just on a single platform.
#
# See also:
# test-matrix.yml: run on all platforms for each pull request
# coverage-report.yml: runs on merge to main to generate coverage reports

name: unit-test

on:
push:
branches-ignore:
- main

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
unit-test:
runs-on: ubuntu-latest
steps:
#----------------------------------------------
# check out repo
#----------------------------------------------
- name: Check out repository
uses: actions/checkout@v4
#----------------------------------------------
# set up python
#----------------------------------------------
- name: Set up python
id: setup-python
uses: actions/setup-python@v5
with:
python-version: 3.11
#----------------------------------------------
# ----- install & configure poetry -----
#----------------------------------------------
- name: Install Poetry
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true
installer-parallel: true

#----------------------------------------------
# load cached venv if cache exists
#----------------------------------------------
- name: Load cached venv
id: cached-poetry-dependencies
uses: actions/cache@v4
with:
path: .venv
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
#----------------------------------------------
# install dependencies if cache does not exist
#----------------------------------------------
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-root
#----------------------------------------------
# install your root project, if required
#----------------------------------------------
- name: Install library
run: poetry install --no-interaction
#----------------------------------------------
# run test suite
#----------------------------------------------
- name: Run tests
id: runTests
run: |
source .venv/bin/activate
python -m pytest
#----------------------------------------------
# archive test artifacts
#----------------------------------------------
- name: Archive test artifacts
if: always()
uses: actions/upload-artifact@v4
with:
name: test_artifacts
path: tests/_test_artifacts
retention-days: 7
9 changes: 9 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ readme = "README.md"
python = "^3.11"
toml = "^0.10.2"

[tool.poetry.group.test.dependencies]
pytest = "^7.1.3"
coverage = {extras = ["toml"], version = "^6.5.0"}
pytest-cov = "^3.0.0"

[tool.poetry.group.lint.dependencies]
black = "^24.2.0"
flake8 = "^7.0.0"
isort = "^5.13.2"

[build-system]
requires = ["poetry-core"]
Expand Down

0 comments on commit 793ef0a

Please sign in to comment.