diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2017-08-11 16:07:04 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2017-08-11 16:07:04 +0200 |
| commit | 4057644f03829e4439ec8ab1feacf90c65d976eb (patch) | |
| tree | 977658ba5109c8a3b512a882bf0a037daad754cb /docs/gl_objects/runners.rst | |
| parent | 80eab7b0c0682c5df99495acc4d6f71f36603cfc (diff) | |
| download | gitlab-4057644f03829e4439ec8ab1feacf90c65d976eb.tar.gz | |
Update the objects doc/examples for v4
Diffstat (limited to 'docs/gl_objects/runners.rst')
| -rw-r--r-- | docs/gl_objects/runners.rst | 40 |
1 files changed, 34 insertions, 6 deletions
diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst index 02db9be..e26c8af 100644 --- a/docs/gl_objects/runners.rst +++ b/docs/gl_objects/runners.rst @@ -2,7 +2,7 @@ Runners ####### -Runners are external process used to run CI jobs. They are deployed by the +Runners are external processes used to run CI jobs. They are deployed by the administrator and registered to the GitLab instance. Shared runners are available for all projects. Specific runners are enabled for @@ -11,8 +11,22 @@ a list of projects. Global runners (admin) ====================== -* Object class: :class:`~gitlab.objects.Runner` -* Manager objects: :attr:`gitlab.Gitlab.runners` +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.Runner` + + :class:`gitlab.v4.objects.RunnerManager` + + :attr:`gitlab.Gitlab.runners` + +* v3 API: + + + :class:`gitlab.v3.objects.Runner` + + :class:`gitlab.v3.objects.RunnerManager` + + :attr:`gitlab.Gitlab.runners` + +* GitLab API: https://docs.gitlab.com/ce/api/runners.html Examples -------- @@ -58,9 +72,23 @@ Remove a runner: Project runners =============== -* Object class: :class:`~gitlab.objects.ProjectRunner` -* Manager objects: :attr:`gitlab.Gitlab.runners`, - :attr:`gitlab.Gitlab.Project.runners` +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectRunner` + + :class:`gitlab.v4.objects.ProjectRunnerManager` + + :attr:`gitlab.v4.objects.Project.runners` + +* v3 API: + + + :class:`gitlab.v3.objects.ProjectRunner` + + :class:`gitlab.v3.objects.ProjectRunnerManager` + + :attr:`gitlab.v3.objects.Project.runners` + + :attr:`gitlab.Gitlab.project_runners` + +* GitLab API: https://docs.gitlab.com/ce/api/runners.html Examples -------- |