Merge branch 'master' into feature/multi-package-support

Author: nemesifier

CHANGES.rst

@@ -6,6 +6,19 @@ Version 1.3.0a [unreleased]
 
 Work in progress.
 
+Version 1.2.2 [2026-01-28]
+--------------------------
+
+Bugfixes
+~~~~~~~~
+
+- Temporarily pinned drf-yasg to 1.21.11 `#565
+  <https://github.com/openwisp/openwisp-utils/issues/565>`_
+- Fixed releaser to only commit tracked files `#552
+  <https://github.com/openwisp/openwisp-utils/issues/552>`_
+- Releaser: Fixed insertion of backported bugfix entries in ReST changelog
+  `#532 <https://github.com/openwisp/openwisp-utils/issues/532>`_
+
 Version 1.2.1 [2025-12-19]
 --------------------------
 

openwisp_utils/releaser/changelog.py

@@ -45,7 +45,17 @@ def run_git_cliff(version=None):
             file=sys.stderr,
         )
         sys.exit(1)
-
+    # Pull latest tags before calculating changelog
+    try:
+        subprocess.run(
+            ["git", "pull", "--tags"],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+    except subprocess.CalledProcessError as e:
+        print(f"Warning: Failed to pull tags: {e.stderr}", file=sys.stderr)
+    # Run git-cliff to calculate changelog
     try:
         cmd = ["git", "cliff", "--unreleased", "--config", config_path]
         if version:

openwisp_utils/releaser/release.py

@@ -358,8 +358,8 @@ def main():
         ["git", "checkout", "-b", release_branch], check=True, capture_output=True
     )
 
-    print("Adding all changed files to git...")
-    subprocess.run(["git", "add", "."], check=True, capture_output=True)
+    print("Adding tracked changes to git...")
+    subprocess.run(["git", "add", "-u"], check=True, capture_output=True)
 
     commit_message = f"{new_version} release"
     subprocess.run(

openwisp_utils/releaser/tests/conftest.py

@@ -1,3 +1,4 @@
+import os
 import subprocess
 from datetime import datetime
 from pathlib import Path
@@ -157,7 +158,6 @@ def mock_all(mocker):
             stdout="main", check_returncode=True
         ),
     }
-
     default_mock = MagicMock(stdout="", stderr="", check_returncode=True)
 
     def subprocess_side_effect(command, *args, **kwargs):
@@ -179,6 +179,15 @@ def subprocess_side_effect(command, *args, **kwargs):
         "openwisp_utils.releaser.version.questionary.select", new=mock_q_select
     )
 
+    # Mock OPENAI_CHATGPT_TOKEN to None to skip AI summary by default
+    original_environ_get = os.environ.get
+
+    def mock_environ_get(key, default=None):
+        if key == "OPENAI_CHATGPT_TOKEN":
+            return None
+        return original_environ_get(key, default)
+
+    mocker.patch("os.environ.get", side_effect=mock_environ_get)
     mocks = {
         "subprocess": mocker.patch(
             "openwisp_utils.releaser.release.subprocess.run",
@@ -236,5 +245,4 @@ def subprocess_side_effect(command, *args, **kwargs):
     }
     mocks["check_prerequisites"].return_value = (mock_config, mock_gh_instance)
     mocks["load_config"].return_value = mock_config
-
     return mocks

openwisp_utils/releaser/tests/test_changelog.py

@@ -136,8 +136,13 @@ def test_run_git_cliff_no_config(mock_find_config):
 
 
 @patch("openwisp_utils.releaser.changelog.find_cliff_config", return_value="path")
-@patch("subprocess.run", side_effect=FileNotFoundError)
+@patch("subprocess.run")
 def test_run_git_cliff_file_not_found(mock_run, mock_find_config):
+    # First call (git pull --tags) succeeds, second call (git cliff) raises FileNotFoundError
+    mock_run.side_effect = [
+        subprocess.CompletedProcess(args=[], returncode=0, stdout="", stderr=""),
+        FileNotFoundError,
+    ]
     with pytest.raises(SystemExit):
         run_git_cliff()
 
@@ -322,6 +327,59 @@ def test_run_git_cliff_with_version_tag(mock_subprocess_run, mock_find_config):
     assert "--tag" in executed_cmd and "1.0.0" in executed_cmd
 
 
+@patch(
+    "openwisp_utils.releaser.changelog.find_cliff_config",
+    return_value="path/to/cliff.toml",
+)
+@patch("openwisp_utils.releaser.changelog.subprocess.run")
+def test_run_git_cliff_calls_git_pull_tags(mock_subprocess_run, mock_find_config):
+    """Tests that `git pull --tags` is executed before running git-cliff."""
+    # Mock the subprocess.run to return different results for different calls
+    mock_subprocess_run.return_value = subprocess.CompletedProcess(
+        args=[], returncode=0, stdout="Changelog content", stderr=""
+    )
+    run_git_cliff()
+    # Verify that subprocess.run was called twice: once for git pull --tags, once for git-cliff
+    assert mock_subprocess_run.call_count == 2
+    # Check the first call is for git pull --tags
+    first_call_args = mock_subprocess_run.call_args_list[0][0][0]
+    assert first_call_args == ["git", "pull", "--tags"]
+    # Check the second call is for git cliff
+    second_call_args = mock_subprocess_run.call_args_list[1][0][0]
+    assert (
+        "git" in second_call_args
+        and "cliff" in second_call_args
+        and "--unreleased" in second_call_args
+    )
+
+
+@patch(
+    "openwisp_utils.releaser.changelog.find_cliff_config",
+    return_value="path/to/cliff.toml",
+)
+@patch("openwisp_utils.releaser.changelog.subprocess.run")
+@patch("builtins.print")
+def test_run_git_cliff_git_pull_tags_fails(
+    mock_print, mock_subprocess_run, mock_find_config
+):
+    """Tests that `git pull --tags` failure is handled gracefully and git-cliff still runs."""
+    # First call (git pull --tags) fails, second call (git cliff) succeeds
+    mock_subprocess_run.side_effect = [
+        subprocess.CalledProcessError(1, "git pull --tags", stderr="Network error"),
+        subprocess.CompletedProcess(
+            args=[], returncode=0, stdout="Changelog content", stderr=""
+        ),
+    ]
+    run_git_cliff()
+    # Verify that subprocess.run was called twice despite the first failure
+    assert mock_subprocess_run.call_count == 2
+    # Verify warning message was printed
+    mock_print.assert_called_once()
+    call_args = mock_print.call_args[0][0]
+    assert "Warning: Failed to pull tags:" in call_args
+    assert "Network error" in call_args
+
+
 def test_process_changelog_dependencies_as_last_section():
     """Tests where 'Dependencies' is the last section."""
     changelog_text = (

openwisp_utils/tests/selenium.py

@@ -53,6 +53,13 @@ def _setup_and_call(self, result, debug=False):
                 stream=None, descriptions=None, verbosity=0
             )
             super()._setup_and_call(result, debug)
+            # IMPORTANT: a skip is not a success; propagate it as a skip and stop.
+            if getattr(result, "skipped", None):
+                for _, reason in result.skipped:
+                    original_result.addSkip(self, reason)
+                if hasattr(original_result, "events") and hasattr(result, "events"):
+                    original_result.events = result.events
+                return
             if result.wasSuccessful():
                 if attempt == 0:
                     original_result.addSuccess(self)

setup.py

@@ -45,7 +45,7 @@
         "rest": [
             "djangorestframework~=3.16.0",
             "django-filter>=25.1,<26.0",  # django-filter uses CalVer
-            "drf-yasg~=1.21.7",
+            "drf-yasg==1.21.11",  # pinning due to https://github.com/openwisp/openwisp-utils/issues/565
         ],
         "channels": [
             "channels[daphne]~=4.3.0",