File: pull_mirror.rst

package info (click to toggle)
python-gitlab 1%3A8.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,884 kB
  • sloc: python: 25,823; makefile: 171; ruby: 27; javascript: 3
file content (38 lines) | stat: -rw-r--r-- 891 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
######################
Project Pull Mirror
######################

Pull Mirror allow you to set up pull mirroring for a project.

References
==========

* v4 API:

  + :class:`gitlab.v4.objects.ProjectPullMirror`
  + :class:`gitlab.v4.objects.ProjectPullMirrorManager`
  + :attr:`gitlab.v4.objects.Project.pull_mirror`

* GitLab API: https://docs.gitlab.com/api/project_pull_mirroring/

Examples
--------

Get the current pull mirror of a project::

    mirrors = project.pull_mirror.get()

Create (and enable) a remote mirror for a project::

    mirror = project.pull_mirror.create({'url': 'https://gitlab.com/example.git',
                                            'enabled': True})

Update an existing remote mirror's attributes::

    mirror.enabled = False
    mirror.only_protected_branches = True
    mirror.save()

Start a sync of the pull mirror::

  project.pull_mirror.start()