diff options
| author | Nejc Habjan <nejc.habjan@siemens.com> | 2022-07-23 02:21:48 +0200 |
|---|---|---|
| committer | John Villalovos <john@sodarock.com> | 2022-07-23 07:50:52 -0700 |
| commit | c6dd57c56e92abb6184badf4708f5f5e65c6d582 (patch) | |
| tree | ba4961acf5d1af0e1017d5fc5285eebaa18c603e /docs | |
| parent | 9c5b8d54745a58b9fe72ba535b7868d1510379c0 (diff) | |
| download | gitlab-c6dd57c56e92abb6184badf4708f5f5e65c6d582.tar.gz | |
fix(runners): fix listing for /runners/all
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli-examples.rst | 27 | ||||
| -rw-r--r-- | docs/gl_objects/runners.rst | 15 |
2 files changed, 39 insertions, 3 deletions
diff --git a/docs/cli-examples.rst b/docs/cli-examples.rst index 1bca166..49956a6 100644 --- a/docs/cli-examples.rst +++ b/docs/cli-examples.rst @@ -236,6 +236,33 @@ Download the artifacts zip archive of a job: $ gitlab project-job artifacts --id 10 --project-id 1 > artifacts.zip +Runners +------- + +List owned runners: + +.. code-block:: console + + $ gitlab runner list + +List owned runners with a filter: + +.. code-block:: console + + $ gitlab runner list --scope active + +List all runners in the GitLab instance (specific and shared): + +.. code-block:: console + + $ gitlab runner-all list + +Get a runner's details: + +.. code-block:: console + + $ gitlab -v runner get --id 123 + Other ----- diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst index 1a64c01..7e90e94 100644 --- a/docs/gl_objects/runners.rst +++ b/docs/gl_objects/runners.rst @@ -19,6 +19,9 @@ Reference + :class:`gitlab.v4.objects.Runner` + :class:`gitlab.v4.objects.RunnerManager` + :attr:`gitlab.Gitlab.runners` + + :class:`gitlab.v4.objects.RunnerAll` + + :class:`gitlab.v4.objects.RunnerAllManager` + + :attr:`gitlab.Gitlab.runners_all` * GitLab API: https://docs.gitlab.com/ce/api/runners.html @@ -41,14 +44,20 @@ for this parameter are: The returned objects hold minimal information about the runners. Use the ``get()`` method to retrieve detail about a runner. + Runners returned via ``runners_all.list()`` also cannot be manipulated + directly. You will need to use the ``get()`` method to create an editable + object. + :: # List owned runners runners = gl.runners.list() - # With a filter + + # List owned runners with a filter runners = gl.runners.list(scope='active') - # List all runners, using a filter - runners = gl.runners.all(scope='paused') + + # List all runners in the GitLab instance (specific and shared), using a filter + runners = gl.runners_all.list(scope='paused') Get a runner's detail:: |