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

feat: Versioning and potentially version control for Python API protocols #17029

Open
eric-hunt opened this issue Dec 4, 2024 · 0 comments
Open
Labels
feature-request A request for a new feature or a change that isn't a bug. May require further triage or scoping.

Comments

@eric-hunt
Copy link

Overview

It might be useful to have a recognized element of the protocol metadata dict for versioning of a protocol itself (not the version of the required API). This could be automatically appended to the title, or shown elsewhere in the protocol summary. In addition to this, it might enable a version control tab within the protocol summary, where a specific version of the protocol could be selected before starting the run setup.

For context, while designing protocols for SOPs/STMs using the Opentrons Python API (particularly for the Flex platform), there are iterations of the protocol that mimic iterations of the SOP/STM being designed. This could help keep the Flex screen less crowded with manually named versions of the same protocol (i.e. STM001_v1.1, STM001_v1.2, etc.) and more densely populated with different protocols for different STMs (i.e. STM001, STM002, etc.).

Implementation details

No response

Design

opentrons_protocol_versioning

Acceptance criteria

No response

@eric-hunt eric-hunt added the feature-request A request for a new feature or a change that isn't a bug. May require further triage or scoping. label Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A request for a new feature or a change that isn't a bug. May require further triage or scoping.
Projects
None yet
Development

No branches or pull requests

1 participant