Versioning

Overview

A task script’s version ties to the IDS version it maps to, rather than being an independent judgment call each release. See the general major/minor/patch definitions on the IDS versioning page — they apply to task scripts and protocols too, not just IDSs.

Guidelines

  • Major: a change related to an IDS major version change, or any non-backwards-compatible change.

  • Minor: a change related to an IDS minor version change; a code logic improvement; adopting a new Context API version; upgrading to a new Python version.

  • Patch: a change related to an IDS patch version change; a bug fix; internal tech debt, a small code refactor, or a small feature improvement (e.g. parsing logic for one field).

  • No version update needed: improving test cases or adding sample files.

See protocol versioning for how a task-script version bump propagates to the protocol that wires it in.