Skip to content

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

@joshuacwnewton

Description

@joshuacwnewton

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions