update changelog

Author: mathiasertl

docs/changelog.rst

@@ -2,6 +2,19 @@
 ChangeLog
 #########
 
+******************
+0.3.0 (2025-12-26)
+******************
+
+* Tutorials can now be configured to pass a clear environment to all processes.
+* Tutorials can now configure additional environment variables passed to all processes.
+* Single commands can now update the environment for all subsequent commands. Values are rendered as
+  templates, so you can add (parts of) the output of a command to the environment by combining a test for
+  the command output that uses a named pattern in a regular expression for the output.
+* ``parts.{commands}.{command}.run.{chdir}`` is now a template. This allows you to change the directory based
+  on the output of a previous command.
+* Bugfix: Individual commands marked as skipped for documentation, are now actually skipped.
+
 ******************
 0.2.0 (2025-12-23)
 ******************

docs/spelling_wordlist.txt

@@ -7,3 +7,4 @@ hostname
 cwd
 backend
 reStructuredText
+bugfix

structured_tutorials/runners/base.py

@@ -53,7 +53,7 @@ def __init__(
             self.environment = {}
         else:
             self.environment = os.environ.copy()
-        self.environment.update(tutorial.configuration.run.environment)
+        self.environment.update(tutorial.configuration.run.environment)  # type: ignore[arg-type]  # temporary
         self.environment = {k: self.render(v) for k, v in self.environment.items() if v is not None}
 
         self.cleanup: list[CleanupCommandModel] = []

tests/data/tutorials/command-with-chdir-template.yaml

@@ -0,0 +1,9 @@
+configuration:
+  run:
+    context:
+      VALUE: /does/not/exist
+parts:
+  - commands:
+      - command: ls
+        run:
+          chdir: "{{ VALUE }}"

tests/runners/local/commands/test_environment.py

@@ -36,7 +36,9 @@ def test_simple_environment(fp: FakeProcess, runner: LocalTutorialRunner) -> Non
     recorder = fp.register("ls")
     assert runner.environment == ENV
     runner.run()
-    assert recorder.calls[0].kwargs["env"] == ENV
+    actual_kwargs = recorder.calls[0].kwargs
+    assert actual_kwargs is not None
+    assert actual_kwargs["env"] == ENV
 
 
 @pytest.mark.tutorial("command-clear-single-environment-variable")
@@ -46,7 +48,9 @@ def test_clear_single_environment_variable(fp: FakeProcess, runner: LocalTutoria
     recorder = fp.register("ls")
     assert runner.environment == {"ENV_2": "VALUE_2"}
     runner.run()
-    assert recorder.calls[0].kwargs["env"] == {"ENV_2": "VALUE_2"}
+    actual_kwargs = recorder.calls[0].kwargs
+    assert actual_kwargs is not None
+    assert actual_kwargs["env"] == {"ENV_2": "VALUE_2"}
 
 
 @pytest.mark.tutorial("command-clear-environment-globally")
@@ -58,10 +62,10 @@ def test_global_environment(fp: FakeProcess, runner: LocalTutorialRunner) -> Non
     recorder3 = fp.register('echo "3: $KEY"')
     recorder4 = fp.register('echo "4: $KEY"')
     runner.run()
-    assert recorder1.calls[0].kwargs["env"] == {}
-    assert recorder2.calls[0].kwargs["env"] == {"KEY": "OTHER VALUE", "KEY2": "VALUE2"}
-    assert recorder3.calls[0].kwargs["env"] == {"KEY": "1: VALUE"}
-    assert recorder4.calls[0].kwargs["env"] == {}
+    assert recorder1.calls[0].kwargs["env"] == {}  # type: ignore[index]
+    assert recorder2.calls[0].kwargs["env"] == {"KEY": "OTHER VALUE", "KEY2": "VALUE2"}  # type: ignore[index]
+    assert recorder3.calls[0].kwargs["env"] == {"KEY": "1: VALUE"}  # type: ignore[index]
+    assert recorder4.calls[0].kwargs["env"] == {}  # type: ignore[index]
 
 
 @pytest.mark.tutorial("command-env-variable-for-single-command")

tests/runners/local/test_command.py

@@ -6,7 +6,7 @@
 import io
 import os
 import subprocess
-from pathlib import Path
+from typing import Any
 from unittest import mock
 
 import pytest
@@ -64,7 +64,7 @@ def test_command_as_list(fp: FakeProcess, runner: LocalTutorialRunner) -> None:
     recorder_test = fp.register(["ls", "test with spaces"])
     recorder_cleanup = fp.register(["ls", "cleanup with spaces"])
     runner.run()
-    expected = {"shell": False, "stdin": None, "stderr": None, "stdout": None, "env": {}}
+    expected: dict[str, Any] = {"shell": False, "stdin": None, "stderr": None, "stdout": None, "env": {}}
     assert recorder_main.calls[0].kwargs == expected
     assert recorder_test.calls[0].kwargs == expected
     assert recorder_cleanup.calls[0].kwargs == expected
@@ -85,7 +85,16 @@ def test_command_with_chdir(fp: FakeProcess, runner: LocalTutorialRunner) -> Non
     fp.register("ls")
     with mock.patch("os.chdir", autospec=True) as mock_chdir:
         runner.run()
-    mock_chdir.assert_called_once_with(Path("/does/not/exist"))
+    mock_chdir.assert_called_once_with("/does/not/exist")
+
+
+@pytest.mark.tutorial("command-with-chdir-template")
+def test_command_with_chdir_with_template(fp: FakeProcess, runner: LocalTutorialRunner) -> None:
+    """Test changing the working directory after a command."""
+    fp.register("ls")
+    with mock.patch("os.chdir", autospec=True) as mock_chdir:
+        runner.run()
+    mock_chdir.assert_called_once_with("/does/not/exist")
 
 
 @pytest.mark.tutorial("command-stdin")
@@ -112,7 +121,7 @@ def test_command_hide_output(fp: FakeProcess, runner: LocalTutorialRunner) -> No
     recorder_test = fp.register("ls test")
     recorder_cleanup = fp.register("ls cleanup")
     runner.run()
-    expected = {
+    expected: dict[str, Any] = {
         "shell": True,
         "stdin": None,
         "stderr": subprocess.DEVNULL,
@@ -131,7 +140,7 @@ def test_command_capture_output(
     """Test running a commands with capturing the output."""
     recorder = fp.register("echo foo bar bla", stdout="foo bar bla", stderr="foo bla bla")
     runner.run()
-    expected = {
+    expected: dict[str, Any] = {
         "shell": True,
         "stdin": None,
         "stderr": subprocess.PIPE,