dolphin-acoustics-vip / artwarp

MATLAB program for automated categorisation of tonal animal sounds
https://github.com/dolphin-acoustics-vip/artwarp/wiki
GNU Lesser General Public License v3.0
6 stars 9 forks source link

Setting up CI #11

Open olexandr-konovalov opened 2 years ago

olexandr-konovalov commented 2 years ago

It may be useful to explore:

olexandr-konovalov commented 1 year ago

I have started to experiment with the 1st option in my fork - see https://github.com/olexandr-konovalov/artwarp/tree/setup-ci branch. At the moment it has two tests, which "pass" :) see https://github.com/olexandr-konovalov/artwarp/actions

One of them is supposed to run unit tests and passes without errors, having not discovering any :) Next step would be to find out how unit tests look like in MATLAB and try to add some simplest one.

The other test runs ARTwarp_csv script. It does not complain. @michaelstanway does the output at https://github.com/olexandr-konovalov/artwarp/actions/runs/4128741797/jobs/7133560798 make sense to you? You mentioned running in batch mode today, perhaps you can suggest what to do to run it in the same way in GitHub actions?

P.S. Some documentation links:

olexandr-konovalov commented 1 year ago

Progress made in #43, #44, #45. Next step is to try to get code coverage to work. And of course, we can already make a PR from the rewrite branch to main and it will be "tested" - in quotes since there are no actual tests yet, but they should eventually appear (counting on @michaelstanway, @harvard-tham and @lixitrixi!)

olexandr-konovalov commented 8 months ago

Now #53 sets up codecov for unit tests, but still need to add for scripted tests.

olexandr-konovalov commented 8 months ago

See also #52 and #54 - now it seems to work properly! @tatedunbar where we can go from here - there are actually several possiblities:

  1. increase test coverage by the unit tests in the main branch
  2. add test coverage to scripted tests as well, if need be (IIRC, for now scripted tests is just the framework to show that this is technically possible, rather than actual testing
  3. add CI tests and coverage to the stable-1 branch (https://github.com/dolphin-acoustics-vip/artwarp/tree/stable-1) which keeps the stable version of ARTWarp
  4. In case of success with (3), add more tests to stable-1
  5. See if there may be any useful updates to ARTWarp 1.0, make them and release ARTWarp 1.1 from the stable-1 branch.