search

calebweinreb / SNUB

MIT License
24 stars 4 forks source link

[JOSS] Implement automated testing via CI #30

Closed lucasmiranda42 closed 7 months ago

lucasmiranda42 commented 8 months ago

I think SNUB is a great tool, and has the potential to be used by quite some people!

That said, and especially given this is the case, I would strongly recommend implementing automated testing via CI (using something like travis-ci, for example). I think this will make keeping track of potential issues much easier as the package grows.

This issue is part of a paper review for JOSS.

calebweinreb commented 8 months ago

Thanks for the suggestion! I created a github action that runs pytest and checks black formatting on pushes/PRs to main. I also created protections for main so that all merges require a PR.

Here's the github action config: https://github.com/calebweinreb/SNUB/blob/main/.github/workflows/ci.yml Here's a log of the last completed action: https://github.com/calebweinreb/SNUB/actions/runs/8125132061/job/22207389372