iblrig.version_management.get_detailed_version_string

iblrig.version_management.get_detailed_version_string(v_basic)

Generate a detailed version string based on a basic version string.

This function takes a basic version string (major.minor.patch) and generates a detailed version string by querying Git for additional version information. The detailed version includes commit number of commits since the last tag, and Git status (dirty or broken). It is designed to fail safely.

Parameters:

v_basic (str) – A basic version string in the format ‘major.minor.patch’.

Returns:

A detailed version string containing version information retrieved from Git, or the original basic version string if Git information cannot be obtained.

Return type:

str

Parameters:

v_basic (str)

Notes

This method will only work with installations managed through Git.