community.general.gitlab_issue модуль — Создание, обновление или удаление задач GitLab

Примечание

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

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

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

Для использования в книге задач укажите: community.general.gitlab_issue.

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

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

Описание

Создаёт задачу, если она не существует.
Если задача существует, она будет обновлена, если предоставленные параметры отличаются.
Если задача существует и state=absent, задача будет удалена.
Если обнаружено несколько задач, задача завершается с ошибкой.
Существующие задачи сопоставляются на основе фильтров title и state_filter.

Требования

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

python-gitlab >= 2.3.0
requests (библиотека Python https://pypi.org/project/requests/)

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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.
assignee_ids список / элементы=строка	Список имён пользователей-исполнителей, исключая символ `@`. Установите пустой массив, чтобы снять назначение всех исполнителей.
ca_path строка добавлен в community.general 8.1.0	Файл с сертификатами CA для проверки сертификата сервера GitLab.
description строка	Описание проблемы. Перезаписывается содержимым файла, указанного в `description_path`, если он найден.
description_path путь	Путь к файлу с описанием проблемы. Поддерживаются файлы в формате MarkDown.
issue_type строка	Тип проблемы. Варианты: `"issue"` ← (по умолчанию) `"incident"` `"test_case"`
labels список / элементы=строка	Список названий меток. Установите пустой массив, чтобы удалить все метки.
milestone_group_id строка	Путь или числовой ID группы, содержащей необходимую веху.
milestone_search строка	Название вехи. Установите пустую строку, чтобы снять назначение вехи.
project строка / обязательно	Путь или имя проекта.
state строка	Создать или удалить проблему. Варианты: `"present"` ← (по умолчанию) `"absent"`
state_filter строка	Фильтр, определяющий состояние проблем при поиске. Варианты: `"opened"` ← (по умолчанию) `"closed"`
title строка / обязательно	Заголовок проблемы. Используется в качестве уникального идентификатора для обеспечения идемпотентности.
validate_certs логическое	Подтверждать ли SSL сертификаты при использовании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Create Issue
  community.general.gitlab_issue:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    title: "Ansible demo Issue"
    description: "Demo Issue description"
    labels:
        - Ansible
        - Demo
    assignee_ids:
        - testassignee
    state_filter: "opened"
    state: present

- name: Delete Issue
  community.general.gitlab_issue:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    title: "Ansible demo Issue"
    state_filter: "opened"
    state: absent

Значения возврата

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

Ключ	Описание
issue словарь	Объект API. Возвращается: успех
msg строка	Сообщение об успехе или ошибке. Возвращается: всегда Пример: `"Success"`

Авторы

zvaraondrej (@zvaraondrej)

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

© 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_issue_module.html