Модуль community.general.gitlab_label — создание, обновление и удаление меток GitLab, принадлежащих проекту или группе

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля также требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.gitlab_label.

Добавлено в community.general 8.3.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Если метки не существует, она создаётся.
Если метка существует, её значение обновляется, когда оно отличается от указанного.
Метки можно удалять.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

модуль Python python-gitlab
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Параметр	Комментарии
api_job_token string добавлено в community.general 4.2.0	Токен задания GitLab CI для входа в систему.
api_oauth_token string добавлено в community.general 4.2.0	Токен OAuth GitLab для входа в систему.
api_password string	Пароль для аутентификации при обращении к API.
api_token string	Токен доступа GitLab с разрешениями для API.
api_url string	Разрешаемая конечная точка API.
api_username string	Имя пользователя для аутентификации при обращении к API.
ca_path string добавлено в community.general 8.1.0	Пакет сертификатов CA для проверки сертификата сервера GitLab.
group string	Путь к группе. Необходимо указать это значение или `project`.
labels list / элементы=dictionary	Список словарей, представляющих метки проекта или группы GitLab. По умолчанию: `[]`
color string	Цвет метки. Обязателен, если `state=present`.
description string	Описание метки.
name string / обязательный	Имя метки.
new_name string	Необязательное поле для изменения имени метки.
priority integer	Целочисленное значение, задающее приоритет метки.
project string	Путь и имя проекта. Необходимо указать это значение или `group`.
purge boolean	Если задано значение `true`, удаляются все метки, не указанные в задаче. Варианты: `false` ← (по умолчанию) `true`
state string	Создать или удалить метку проекта или группы. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять ли сертификаты SSL при указании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: full	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: none	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, нужно изменить в `check_mode`).

Примеры

# same project's task can be executed for group
- name: Create one Label
  community.general.gitlab_label:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    labels:
      - name: label_one
        color: "#123456"
    state: present

- name: Create many group labels
  community.general.gitlab_label:
    api_url: https://gitlab.com
    api_token: secret_access_token
    group: "group1"
    labels:
      - name: label_one
        color: "#123456"
        description: this is a label
        priority: 20
      - name: label_two
        color: "#554422"
    state: present

- name: Create many project labels
  community.general.gitlab_label:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    labels:
      - name: label_one
        color: "#123456"
        description: this is a label
        priority: 20
      - name: label_two
        color: "#554422"
    state: present

- name: Set or update some labels
  community.general.gitlab_label:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    labels:
      - name: label_one
        color: "#224488"
    state: present

- name: Add label in check mode
  community.general.gitlab_label:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    labels:
      - name: label_one
        color: "#224488"
    check_mode: true

- name: Delete Label
  community.general.gitlab_label:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    labels:
      - name: label_one
    state: absent

- name: Change Label name
  community.general.gitlab_label:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    labels:
      - name: label_one
        new_name: label_two
    state: absent

- name: Purge all labels
  community.general.gitlab_label:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    purge: true

- name: Delete many labels
  community.general.gitlab_label:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    state: absent
    labels:
      - name: label-abc123
      - name: label-two

Возвращаемые значения

Общие возвращаемые значения описаны здесь; далее перечислены поля, уникальные для этого модуля:

Ключ	Описание
labels dictionary	Четыре списка меток: добавленные, обновлённые, удалённые и существующие. Возвращается: success
added list / элементы=string	Список созданных меток. Возвращается: всегда Пример: `["abcd", "label-one"]`
removed list / элементы=string	Список удалённых меток. Возвращается: всегда Пример: `["defg", "new-label"]`
untouched list / элементы=string	Список существующих меток. Возвращается: всегда Пример: `["defg", "new-label"]`
updated list / элементы=string	Список ранее существовавших меток, значения которых были изменены. Возвращается: всегда Пример: `["defg", "new-label"]`
labels_obj dictionary	Объект API. Возвращается: success

Авторы

Gabriele Pongelli (@gpongelli)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/gitlab_label_module.html