feat: expose integer Tutor version parts to templates (#1060)

We expose the TUTOR_MAJOR_VERSION and TUTOR_MINOR_VERSION template
variables, parsed from TUTOR_VERSION. This is convenient for maintainers
of plugins which target multiple Tutor/Open edX versions.

We do not expose TUTOR_VERSION_PATCH because (1) plugins shouldn't
really need to look at the PATCH version and (2) we don't want to
prevent Tutor from ever using non-integer patch suffixes (like alpha,
beta, rc, etc.) if there were ever a need for that.

changelog.d/20241107_164816_kyle_tutor_version_parts.md

@@ -0,0 +1 @@
+- [Feature] Add integer variables `TUTOR_VERSION_MAJOR` and `TUTOR_VERSION_MINOR` to the template context. These are parsed from the existing `TUTOR_VERSION` string variable, which takes the format `"MAJOR.MINOR.PATCH"`. We add them as a convenience to developers who need to maintain version-agnostic Tutor plugins (by @michaelwheeler and @kdmccormick).

tutor/env.py

@@ -64,6 +64,11 @@ def _prepare_environment() -> None:
             ("HOST_USER_ID", utils.get_user_id()),
             ("TUTOR_APP", __app__.replace("-", "_")),
             ("TUTOR_VERSION", __version__),
+            # We assume that TUTOR_VERSION is always MAJOR.MINOR.PATCH.
+            # We assume that MAJOR and MINOR are both integers.
+            # We make no assumptions about PATCH, and thus do not parse it for plugins to use.
+            ("TUTOR_VERSION_MAJOR", int(__version__.split(".")[0])),
+            ("TUTOR_VERSION_MINOR", int(__version__.split(".")[1])),
             ("TUTOR_BRANCH_IS_MAIN", __version_suffix__ == "main"),
             ("is_docker_rootless", utils.is_docker_rootless),
         ],

tutor/hooks/catalog.py

@@ -351,7 +351,9 @@ def your_filter_callback(some_data):
     #:
     #: - ``HOST_USER_ID``: the numerical ID of the user on the host.
     #: - ``TUTOR_APP``: the app name ("tutor" by default), used to determine the dev/local project names.
-    #: - ``TUTOR_VERSION``: the current version of Tutor.
+    #: - ``TUTOR_VERSION``: the current version of Tutor, as a string in the form MAJOR.MINOR.PATCH.
+    #: - ``TUTOR_VERSION_MAJOR``: the MAJOR part of TUTOR_VESRION, as an integer.
+    #: - ``TUTOR_VERSION_MINOR``: the MINOR part of TUTOR_VERSION, as an integer.
     #: - ``iter_values_named``: a function to iterate on variables that start or end with a given string.
     #: - ``iter_mounts``: a function that yields compose-compatible bind-mounts for any given service.
     #: - ``iter_mounted_directories``: iterate on bind-mounted directory names.