feat: add sync method to force remote mirror updates

JohnVillalovos · JohnVillalovos · commit 07a4167e41f7 · 2025-07-24T06:13:30.000-07:00
Add ProjectRemoteMirror.sync() method to trigger immediate push mirror updates. Closes: #3223
diff --git a/docs/gl_objects/remote_mirrors.rst b/docs/gl_objects/remote_mirrors.rst
@@ -36,3 +36,7 @@ Update an existing remote mirror's attributes::
 Delete an existing remote mirror::
 
   mirror.delete()
+
+Force push mirror update::
+
+  mirror.sync()
diff --git a/gitlab/v4/objects/projects.py b/gitlab/v4/objects/projects.py
@@ -1233,7 +1233,20 @@ def create(self, data: dict[str, Any] | None = None, **kwargs: Any) -> ProjectFo
 
 
 class ProjectRemoteMirror(ObjectDeleteMixin, SaveMixin, RESTObject):
-    pass
+    @cli.register_custom_action(cls_names="ProjectRemoteMirror")
+    @exc.on_http_error(exc.GitlabCreateError)
+    def sync(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
+        """Force push mirror update.
+
+        Args:
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabCreateError: If the server cannot perform the request
+        """
+        path = f"{self.manager.path}/{self.encoded_id}/sync"
+        return self.manager.gitlab.http_post(path, **kwargs)
 
 
 class ProjectRemoteMirrorManager(
diff --git a/tests/unit/objects/test_remote_mirrors.py b/tests/unit/objects/test_remote_mirrors.py
@@ -54,6 +54,12 @@ def resp_remote_mirrors():
             url="http://localhost/api/v4/projects/1/remote_mirrors/1",
             status=204,
         )
+
+        rsps.add(
+            method=responses.POST,
+            url="http://localhost/api/v4/projects/1/remote_mirrors/1/sync",
+            status=204,
+        )
         yield rsps
 
 
@@ -81,3 +87,9 @@ def test_update_project_remote_mirror(project, resp_remote_mirrors):
 def test_delete_project_remote_mirror(project, resp_remote_mirrors):
     mirror = project.remote_mirrors.create({"url": "https://example.com"})
     mirror.delete()
+
+
+def test_sync_project_remote_mirror(project, resp_remote_mirrors):
+    mirror = project.remote_mirrors.create({"url": "https://example.com"})
+    response = mirror.sync()
+    assert response.status_code == 204
