Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup GitHub Actions #6

Open
6 tasks
trevorb1 opened this issue Dec 19, 2022 · 0 comments
Open
6 tasks

Setup GitHub Actions #6

trevorb1 opened this issue Dec 19, 2022 · 0 comments

Comments

@trevorb1
Copy link
Member

trevorb1 commented Dec 19, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant