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

Примечание

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

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `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 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_merge_request_module.html