Update a BIDS app gear

Introduction

BIDS Apps are updated frequently. There are simple steps that one can follow to update the gears that accompany the BIDS app, if the required version has not been made available to the exchange.

Instructions Steps

1. Locate the BIDS app gear repo.
2. Fork the repo.
3. Update the version where referenced. Here are the lines from the BIDS App Template to demonstrate.
   • Update the DockerHub image that the gear will use.
   • Update the gear-builder line in the manifest.
   • Update the version line in the manifest.
4. Run poetry update from the local commandline (where the current working directory is the top-level of the gear). This command will update any dependencies for the Flywheel portion of the gear (not the BIDS algorithm itself!).
5. Run fw-beta gear build to update anything in the manifest.
6. Ideally, run fw-beta gear upload and complete a test run on a Flywheel instance.
7. Run git checkout -b {my-update}, git commit -a -m "{My message about updating}" -n, and git push.
8. Submit a merge request (MR) to the original gear repo for Flywheel staff to review for official inclusion in the exchange.

Resources

FAQs