/
Release Checklist

Release Checklist

Owned by sgjym (Unlicensed)
Last updated: Oct 26, 2020 by Anjal Doshi
2 min read

Current version: 0.5.2

Pre-release:

Increment version numbers in CmakeLists.txt, and  Linux (control) & Windows (windows_installer_script.iss) Installer scripts
- Use Semantic versioning (MAJOR.MINOR.PATCH)
Tag the latest commit with testing version number (e.g. v0.5.2-rc.1)
Merge development branch into testing
- This will trigger automated builds, available here: https://dl.bintray.com/open-ephys-gui/Test/
Notify the Open Ephys Forum about the upcoming release, and to report any bugs as GitHub Issues

Testing phase:

General Signal Chain
Confirm splitter/merger functionality is working
Test acquisition for a range of buffer sizes (16 samples - 2016 samples)
Plugin Installer
Confirm that all available plugins download and install correctly on Windows, Linux, and Mac
RecordNode
Confirm that all settings save and load correctly
Confirm that multiple record nodes can successfully write to separate disks
Test synchronization across multiple sub-processors
Test continuous, spikes, and event writing across all available formats
Binary
Open Ephys
Kwik
NWB 1.0
Audio Monitor
Test audio monitor across all three platforms, with 1-16 channels active
Neuropixels
Test sync port in input/output mode
Test acquisition with 6 or more probes
Open Ephys Acquisition Board
Confirm that Opal Kelly driver is included in the Windows release
Channel Map
Test channel remapping
Test referencing
LFP Viewer
Confirm that event display is working 
Confirm that all settings save and load correctly
Spike Detection / Display
Confirm that both the Spike Sorter and Spike Detector can send spikes to the Spike Viewer

Release:

Update README with new download links
Tag the latest commit with release version number (e.g. v0.5.2)
If new commits (fixes/patches) were added after testing release, merge development into testing
Merge development into testing and master branches
- This will trigger automated builds, available here: https://dl.bintray.com/open-ephys-gui/Release/
Create a new release on GitHub using the latest tag and attach the installer/zip files with the release.
Notify the Open Ephys Forum, Neuropixels Slack Channel, and Twitter about the new release



Related content