Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/descriptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,20 @@ v2017 of a DCC, the plugin can be set up to track against the latest released ve
``sgtk:descriptor:app_store?name=tk-config-dcc&label=v2017``. In this case, when the descriptor is checking
for the latest available version in the app store, only versions labelled with v2017 will be taken into account.

.. note:: **Python Version Compatibility**

Toolkit's auto-update system respects Python version requirements. If a bundle (app, engine,
framework, or config) specifies a ``minimum_python_version`` in its ``info.yml`` manifest,
Toolkit will automatically prevent users running older Python versions from updating to
incompatible versions.

For example, if the latest version of a config requires Python 3.8 or higher, users running
Python 3.7 will continue to use the most recent version compatible with Python 3.7 instead
of automatically updating to the incompatible version.

See :ref:`python_version_requirements` for more details on specifying Python requirements
in your bundles.

.. _git_descriptors:

Tracking against tags in git
Expand Down
27 changes: 27 additions & 0 deletions docs/platform.rst
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,33 @@ and (for apps only) ``requires_engine_version``::
requires_core_version: "v0.14.37"
requires_engine_version: "v0.2.3"

.. _python_version_requirements:

Python Version Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If your app, engine, framework, or configuration requires a minimum version of Python,
you can specify this using the ``minimum_python_version`` parameter. This field accepts
a version string in the format ``major.minor`` (e.g. ``"3.8"``) or ``major.minor.patch``
(e.g. ``"3.8.0"``)::

# Minimum Python version required for this item to run
minimum_python_version: "3.8"

When this field is set, Toolkit's auto-update system will prevent users running older
Python versions from automatically updating to versions that are incompatible with their
Python environment. This ensures backward compatibility and prevents breaking changes
for users who haven't yet upgraded their Python version.

.. note::
The ``minimum_python_version`` field is compared using only the major and minor
version numbers (e.g., 3.8). The patch version (if provided) is ignored during
compatibility checks.

.. note::
This field is optional. If omitted, the bundle is assumed to be compatible with
all Python versions currently supported by Toolkit.

Supported Engines and operating systems
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading