feat: add sync method to force remote mirror updates #3232
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add ProjectRemoteMirror.sync() method to trigger immediate push mirror updates. Closes: #3223
There was a problem hiding this comment.
Pull Request Overview
Adds a new sync method to ProjectRemoteMirror to force an immediate remote mirror update via HTTP POST, along with corresponding test coverage and documentation.
- Implements
ProjectRemoteMirror.sync()in the API client - Extends unit tests to verify the sync endpoint call
- Updates the Sphinx docs to show how to invoke
mirror.sync()
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/unit/objects/test_remote_mirrors.py | Added a responses.POST stub and test_sync_project_remote_mirror |
| gitlab/v4/objects/projects.py | Defined ProjectRemoteMirror.sync() with HTTP POST and decorators |
| docs/gl_objects/remote_mirrors.rst | Documented mirror.sync() usage |
Comments suppressed due to low confidence (2)
gitlab/v4/objects/projects.py:1238
- [nitpick] The return type annotation is a union of dict[str, Any] and requests.Response, but since http_post always returns a Response object, consider narrowing the annotation to requests.Response for clarity.
def sync(self, **kwargs: Any) -> dict[str, Any] | requests.Response:
docs/gl_objects/remote_mirrors.rst:40
- [nitpick] Expand this example to show the returned Response object (e.g., checking
response.status_code) and mention any accepted kwargs or possible exceptions so users know how to handle the result ofmirror.sync().
Force push mirror update::
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3232 +/- ##
=======================================
Coverage 97.32% 97.32%
=======================================
Files 98 98
Lines 6058 6062 +4
=======================================
+ Hits 5896 5900 +4
Misses 162 162
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add ProjectRemoteMirror.sync() method to trigger immediate push mirror updates.
Closes: #3223