Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a process to automate creating results.zip and attaching it as a release asset #149

Open
joshuacwnewton opened this issue Sep 8, 2023 · 0 comments

Comments

@joshuacwnewton
Copy link
Member

The documentation for the sister repo spine-generic currently relies on an archive called results.zip attached to data-multi-subject releases. However, recent releases do not have a results.zip file, which has caused spine-generic documentation failures for 2+ years (see spine-generic/spine-generic#268).

Given the contents of results.zip, it seems like the archive was created manually by bundling up files produced by Spine Generic's Analysis Pipeline run on data-multi-subject. So, if we want to keep this process up-to-date, I think the most useful way to eliminate this manual effort would be to write down the steps required to generate results.zip, then automate them by putting them in a GitHub Actions workflow.

Some notes:

  • data-multi-subject has changed quite a bit since the last time results.zip was generated (renamed file suffixes, etc.). So, the old way of generating results.zip may not work right away, and could require some changes to the spine-generic repo.
  • Running a processing script, selecting output files, adding them to a zip, and uploading them as a release asset are all things we've done before (see: sct_tutorial_data/run_script_and_create_release.yml). So, it shouldn't be too difficult to re-use some of the logic from that workflow here.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant