Make better use of github actions

IPASC / standardised-image-reconstruction

The IPASC standardised image reconstruction project.

MIT License

23 stars 13 forks source link

Make better use of github actions #25

Open alexpattyn opened 2 years ago

alexpattyn commented 2 years ago

As we discussed during the last meeting (2022.06.01), we could make better use of github actions to:

[ ] Automatically format python code in PRs
[ ] Test that each implemented algorithm is running through without crashing
[ ] Test that the passed arguments are considered in the algorithm and/or pre- and postprocessing
[ ] Test that any change to the code base does not change the last accepted output of the algorithm

alexpattyn commented 2 years ago

A basic test we could do for now is run run_all.py on various platforms, e.g. RHEL, Windows, and MacOS. I'll have to see how other projects do that though.

Ideally, we would test each algorithm against a known output. E.g. if the fft-based hauptmann is known to be in a good state currently, we can save the recon and make sure future changes don't modify that.

If other members have ideas that they want to code up we could include those as well.

jgroehl commented 2 years ago

Yes, good idea. We can definitely also run a couple of sanity-checking tests that test that there is any output and the algorithms do not crash. We could further test that the passed arguments are considered correctly.

alexpattyn commented 2 years ago

@jgroehl I can't really play around with github actions in the official repo. Therefore, I'll check them out in my fork. I'll just need someone with commit access to implement them once I figure out what actions to use to satisfy the task above.

alexpattyn commented 2 years ago

Update: I have a build matrix working, but I always have issues getting the mac and win task to finish. They always time out after 6hrs. Not sure if this is a limit of github actions and how much data we can download into the container to test (since we are verifying run_all.py).