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

Create workflow to alert on new NeuroConv releases #955

Open
rly opened this issue Feb 1, 2025 · 0 comments
Open

Create workflow to alert on new NeuroConv releases #955

rly opened this issue Feb 1, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@rly
Copy link
Collaborator

rly commented Feb 1, 2025

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: catalystneuro/neuroconv#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 rly added the enhancement New feature or request label Feb 1, 2025
@rly rly changed the title Support latest NeuroConv Create workflow to alert on new NeuroConv releases Feb 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant