Модуль community.general.gitlab_label – Создаёт/обновляет/удаляет метки GitLab, относящиеся к проекту или группе.

Примечание

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

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

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

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

Новая функция в community.general 8.3.0

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

Описание

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

Требования

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

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

Параметры

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

Атрибуты

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

Примеры

# 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 словарь	Четыре списка метки, которые были добавлены, обновлены, удалены или существуют. Возвращается: успешно
added список / элементы=строка	Список меток, которые были созданы. Возвращается: всегда Пример: `["abcd", "label-one"]`
removed список / элементы=строка	Список меток, которые были удалены. Возвращается: всегда Пример: `["defg", "new-label"]`
untouched список / элементы=строка	Список меток, которые существуют. Возвращается: всегда Пример: `["defg", "new-label"]`
updated список / элементы=строка	Список существующих меток, значения которых были установлены. Возвращается: всегда Пример: `["defg", "new-label"]`
labels_obj словарь	Объект API. Возвращается: успешно

Авторы

Gabriele Pongelli (@gpongelli)

Ссылки на сборку

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