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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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/)

Параметры

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

Атрибуты

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

Примеры

- 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 dictionary	Объект API. Возвращается: при успешном выполнении
msg string	Сообщение об успешном выполнении или ошибке. Возвращается: всегда Пример: `"Success"`

Авторы

zvaraondrej (@zvaraondrej)

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

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