MetabolicAtlas / standard-GEM

The standard for open-source GEMs on GitHub
https://www.biorxiv.org/content/10.1101/2023.03.21.512712
Creative Commons Attribution 4.0 International
18 stars 5 forks source link

Automated tests via github actions for repositories generated from this template #36

Open famosab opened 1 year ago

famosab commented 1 year ago

Description of the issue:

Github actions allows running various jobs in the background when working with a repository. So far this template only offers structure but no automated testing.

Expected feature/value/output:

The idea would be to make use of github actions with a small actions script that f. ex. runs memote every time a changed model file is pushed to the repository and then adds the memote report to the repository so that the user can pull the updated report and learn something new about their model.

Current feature/value/output:

Not available.

Proposed code:

Basically something along the lines of

    - name: Install dependencies MEMOTE
      run: python -m pip install memote

    - name: Create memote report 
      run: |
        memote report --filename "GEM_status.html" model/<model_name>.xml 

I hereby confirm that I have:

mihai-sysbio commented 1 year ago

Thanks for opening this issue @famosab, it would a useful addition.

Practically speaking, I guess this could take the shape of one or several workflows in the .github folder that already exists.

Some concerns that can be raised are:

famosab commented 1 year ago

I have some ideas concerning your points:

JonathanRob commented 1 year ago

Just a recommendation regarding the issue with large HTML report sizes - one option is to use the JSON output, and specify a subset of tests to run, rather than running everything by default.