Модуль community.general.gitlab_merge_request – Создание, обновление или удаление запросов на слияние GitLab

Примечание

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

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

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

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

Новое в community.general 7.1.0

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

Описание

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

Требования

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

python-gitlab >= 2.3.0
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.
assignee_ids строка	Список имен пользователей-исполнителей, разделенных запятыми, без символа `@`. Установить пустую строку для снятия назначения всех исполнителей.
ca_path строка добавлено в community.general 8.1.0	Набор сертификатов CA для проверки сертификата сервера GitLab.
description строка	Описание запроса на слияние. Перезаписывается содержимым файла, указанного в `description_path`, если найден.
description_path путь	Путь к файлу, содержащему описание запроса на слияние. Поддерживаются файлы в формате MarkDown.
labels строка	Список имен меток, разделенных запятыми. Значение по умолчанию: `""`
project строка / обязательно	Путь или имя проекта.
remove_source_branch логическое значение	Флаг, указывающий, следует ли удалять исходную ветвь при слиянии. Варианты: `false` ← (значение по умолчанию) `true`
reviewer_ids строка	Список имен рецензентов, разделенных запятыми, без символа `@`. Установить пустую строку для снятия назначения всех рецензентов.
source_branch строка / обязательно	Исходная ветвь запроса на слияние. Игнорируется при обновлении существующего запроса на слияние.
state строка	Создать или удалить запрос на слияние. Варианты: `"present"` ← (значение по умолчанию) `"absent"`
state_filter строка	Фильтр, определяющий состояние запросов на слияние при поиске. Варианты: `"opened"` ← (значение по умолчанию) `"closed"` `"locked"` `"merged"`
target_branch строка / обязательно	Целевая ветвь запроса на слияние.
title строка / обязательно	Заголовок запроса на слияние.
validate_certs логическое значение	Подтверждать ли сертификаты SSL при использовании HTTPS конечной точки. Варианты: `false` `true` ← (значение по умолчанию)

Атрибуты

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

Примеры

- name: Create Merge Request from branch1 to branch2
  community.general.gitlab_merge_request:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    source_branch: branch1
    target_branch: branch2
    title: "Ansible demo MR"
    description: "Demo MR description"
    labels: "Ansible,Demo"
    state_filter: "opened"
    remove_source_branch: True
    state: present

- name: Delete Merge Request from branch1 to branch2
  community.general.gitlab_merge_request:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    source_branch: branch1
    target_branch: branch2
    title: "Ansible demo MR"
    state_filter: "opened"
    state: absent

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

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

Ключ	Описание
mr словарь	Объект 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_merge_request_module.html