Модуль community.general.gitlab_branch – Создание или удаление ветки
Примечание
Этот модуль является частью коллекции community.general (версия 9.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Для использования в книге задач укажите: community.general.gitlab_branch.
Новое в community.general 4.2.0
Описание
- Этот модуль позволяет создавать или удалять ветки.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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. |
branch строка / обязательно | Имя ветки, которую нужно создать. |
ca_path строка добавлен в community.general 8.1.0 | Файл с сертификатами CA для проверки сертификата сервера GitLab. |
project строка / обязательно | Путь или имя проекта. |
ref_branch строка | Ветка-источник для создания. Обязательно указать, если |
state строка | Создать или удалить ветку. Варианты:
|
validate_certs логическое | Проверять сертификаты SSL при использовании HTTPS. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: нет | Может работать в режиме |
diff_mode | Поддержка: нет | Возвратит подробности о внесённых изменениях (или, возможно, изменениях, которые |
Примеры
- name: Create branch branch2 from main
community.general.gitlab_branch:
api_url: https://gitlab.com
api_token: secret_access_token
project: "group1/project1"
branch: branch2
ref_branch: main
state: present
- name: Delete branch branch2
community.general.gitlab_branch:
api_url: https://gitlab.com
api_token: secret_access_token
project: "group1/project1"
branch: branch2
state: absent
Ссылки на коллекцию
© 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_branch_module.html
