Merge remote-tracking branch 'origin/release'

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).

changelog.d/20241205_211837_danyal.faheem_add_dev_attach_command.md

@@ -0,0 +1 @@
+- [Bugfix] Fix breakpoint debugging by attaching container stdin when running tutor dev start <service> for a single service. (by @Danyal-Faheem)

docs/tutorials/edx-platform.rst

@@ -139,6 +139,8 @@ To debug a local edx-platform repository, first, start development in detached m
   # Or, debugging CMS:
   tutor dev start cms
 
+To detach from the service without shutting it down, use ``Ctrl+p`` followed with ``Ctrl+q``.
+
 Running edx-platform unit tests
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

tutor/commands/compose.py

@@ -245,15 +245,26 @@ def start(
     services: list[str],
 ) -> None:
     command = ["up", "--remove-orphans"]
+    attach = len(services) == 1 and not detach
     if build:
         command.append("--build")
-    if detach:
+    # We have to run the container in detached mode first to attach to it
+    if detach or attach:
         command.append("-d")
+    else:
+        fmt.echo_info("ℹ️  To exit logs without stopping the containers, use ctrl+z")
 
     # Start services
     config = tutor_config.load(context.root)
     context.job_runner(config).docker_compose(*command, *services)
 
+    if attach:
+        fmt.echo_info(
+            f"""Attaching to service {services[0]}
+ℹ️  To detach without stopping the service, use ctrl+p followed by ctrl+q"""
+        )
+        context.job_runner(config).docker_compose("attach", *services)
+
 
 @click.command(help="Stop a running platform")
 @click.argument("services", metavar="service", nargs=-1)

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.