search

stfc / aiida-mlip

machine learning interatomic potentials aiida plugin
https://stfc.github.io/aiida-mlip/
BSD 3-Clause "New" or "Revised" License
4 stars 5 forks source link

Publish code coverage #60

Closed ElliottKasoar closed 9 months ago

ElliottKasoar commented 9 months ago

We currently generate code coverage during the CI workflow, but do not publish/report it clearly.

Based on the aiida-gromacs workflow, it looks relatively straightforward to modify the workflow to report our results to coveralls, if we're happy to stick with this.

I believe we also need to register this repository on coveralls, and probably generate/add a token.

This should hopefully also fix the badge in the README, which is already set up to link to coveralls.

alinelena commented 9 months ago

we may want to consider this also https://hackernoon.com/adding-test-coverage-badge-on-github-without-using-third-party-services always is nice to reduce the number of services one depends on

ElliottKasoar commented 9 months ago

If it were something where we were setting up from scratch like new CI for travis I'd definitely avoid a new service, but with where we are already, my inclination is to get it published on coveralls first, since I think we're basically ready with minimal work.

Arguably there's a positive effect on perception with "external" validation too.

Either way, it's definitely useful to be aware of alternatives and potentially consider moving longer term.

alinelena commented 9 months ago

i need to check how is in github but in gitlab is really 2 lines to set it up. https://gitlab.com/ccp5/dlpoly-py/-/blob/devel/.gitlab-ci.yml?ref_type=heads