Module versioning

Module versioning is an important aspect of image development process. Proper handling of versions makes it easy to control what exactly content should be part of the image.

This section describes how module versions are handled in CEKit.

See also

If you want to learn best practices around module versioning, take a look at module guidelines.


Every module must have a version defined. Version of the module is an important piece of information because based on the version we control what content goes into image.

You can look at module versioning similar to any library version. There are no libraries without version and there must not be modules without versions.

In module descriptor the version could be defined as string, float or integer. CEKit is converting this value internally to string which is parsed later to become a version object finally.


Although CEKit does not enforce any versioning scheme, se suggest to use Python versioning scheme. Read more about suggested approach.

If your module version does not follow this scheme, CEKit will log a warning. In case you use your own versioning scheme you can ignore this warning.


Every version of module is parsed internally. Before we can do this any version is converted to string. This means that

version: 1.0


version: "1.0"

are exactly the same versions for CEKit.

Handling modules with multiple versions

See also

See module descriptor documentation and image descriptor modules section documentation for more information how to reference modules.

In case you do not specify version requirement in the module installation list in the image descriptor, CEKit will use newest version to install.

Internally we use the packaging module to convert the module version string into a Version object. If you use a custom versioning scheme your version may be represented by a LegacyVersion object.

Parsed versions are compared according to PEP 440 versioning scheme.

Custom versioning scheme in comparison with a PEP 440 version will be always older.