Versioning and validation¶

BugSeq routinely releases new versions of the pipeline. Users on eligible plans can select whether to run with the latest features (the Latest version) or pin their lab to a specific version.

For a change log of each version, see the pipeline change log.

Versions will show up at the top of Summary and Per-Sample reports:

Latest¶

BugSeq generally recommends running the latest version of the pipeline. All changes undergo rigorous testing before being rolled out to users. Using Latest guarantees the latest features, bug fixes and performance improvements.

Tagged versions¶

Tagged versions are of the form v1.2.3. By pinning a Lab to a tagged version, you can be confident that the same analysis code will run on every submission, guaranteeing reproducibility.

Release cadence¶

BugSeq typically releases a new tagged version every quarter.

Support window¶

Tagged versions are supported for 1 year after their release date. For labs planning to pin to specific versions, please have a process in place to validate new versions at least every year to avoid being force-upgraded. You will be notified at least 3 months before a version is approaching the end of its support window.

Upgrade tooling¶

In order to ease the transition of upgrading versions, BugSeq provides tooling to re-run historical data submitted to a lab on a different version.

In the sidebar, select the Validations tab:

From there, you will be able to select a version and add any prior analysis:

Clicking “Start Validation” will re-run those analyses on the validation version. Note that validations may take longer as inputs will need to be retrieved.

Once complete, you will be able to find a side-by-side comparison of the analyses and compare the results.