nwb-guide icon indicating copy to clipboard operation
nwb-guide copied to clipboard

Create workflow to alert on new NeuroConv releases

Open rly opened this issue 11 months ago • 0 comments

Describe the issue

Currently, NWB GUIDE pins NeuroConv to a commit from August: https://github.com/catalystneuro/neuroconv/tree/fa636458aa5c321f1c2c08f6e682b4a52d5a83f3

This was done in order to handle breaking changes in spikeinterface and major refactoring in neuroconv.

NWB GUIDE is tightly coupled to the Neuroconv interface - pretty much every change to Neuroconv, down to modifying the docstring of SpikeGLXRecordingInterface.__init__ impacts NWB GUIDE (the docstring of each argument is extracted and displayed in the NWB GUIDE source data entry page)

As a result, we need to monitor all changes in NeuroConv and evaluate their impact on NWB GUIDE function and UI.

For example, this change: https://github.com/catalystneuro/neuroconv/pull/1155 results in the SpikeGLX Recording source data input to show both a File Path and a Folder Path input, when previously it showed a single required File Path input:

Before: Image

After: Image

It would be helpful to update NWB GUIDE regularly to handle changes in NeuroConv. Otherwise, it could be an overwhelming migration every 6-12 months.

Proposal: Create a workflow that checks to see if neuroconv has released a new version compared to the one pinned in the environment files, and if so, creates an issue ticket about it.

Steps to Reproduce

Remove NeuroConv pin from environment file, create clean environment, and run NWB GUIDE from source

Operating System

Mac

GUIDE Version

main

Code of Conduct

Yes

Did you confirm this issue was not already reported?

Yes

rly avatar Feb 01 '25 19:02 rly