Skip to content

Setup GitHub Actions  #6

@trevorb1

Description

@trevorb1

Implementing CI through GitHub actions is a simple way to to test our utility functions. Implementing GitHub's Python starter workflow should be fine for now I think.

A successful PR will include:

  • A workflow that:
    • Lints with Black
    • Check typing with mypy
    • Runs tests with PyTest
    • Build package with Python 3.8-3.11 across Windows, Mac, Linux.
  • Bonus: Auto update a code coverage badge on the readme

Depending on how this goes, dropping the Windows requirement might be needed, since most (if not all) of us run Linux/UNIX. But lets discuss if that becomes an issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions