search

ANP-Granular / ParticleTracking

Library and GUI for tracking (rod-like) particles on camera images in 2D and 3D
https://particletracking.readthedocs.io/en/latest/
GNU General Public License v3.0
2 stars 2 forks source link

[JOSS Review] Run tests / publish docs / scheduled run in workflow #84

Closed mhubii closed 3 months ago

mhubii commented 7 months ago

Again, please advise if wrong, are the tests run in the workflow https://github.com/ANP-Granular/ParticleTracking/blob/master/.github/workflows/ci.yml ? I can only find linting https://github.com/ANP-Granular/ParticleTracking/actions/runs/7207660157

Also, are the docs published on PR?

Please further consider a scheduled run, say weekly or similar, refer https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule

a-niem commented 7 months ago

Tests

Again, please advise if wrong, are the tests run in the workflow https://github.com/ANP-Granular/ParticleTracking/blob/master/.github/workflows/ci.yml ? I can only find linting https://github.com/ANP-Granular/ParticleTracking/actions/runs/7207660157 [...] Please further consider a scheduled run, say weekly or similar, refer https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule

Currently, it is intended to only run linting in the mentioned workflow. This was decided because the tests take relatively long and on machines without a display require a proper setup of xvfb which has not been done yet. We can add the running of tests to the workflow, as well as a time trigger.

Docs

Also, are the docs published on PR?

The respective versions of docs are automatically updated upon commits to the master and develop and when a new version tag is added.

mhubii commented 7 months ago

hm okay I see that this might be complicated, but I think running the tests via workflows would be necessary to simplify quality assurance

mhubii commented 7 months ago

https://github.com/openjournals/joss-reviews/issues/5986