Модуль community.general.gitlab_branch — создание или удаление ветки
Примечание
Этот модуль входит в коллекцию community.general (версия 12.6.1).
Возможно, эта коллекция уже установлена, если вы используете пакет 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 | Токен OAuth GitLab для входа. |
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 | Поддержка: отсутствует | В режиме diff возвращает сведения об изменениях (или возможных необходимых изменениях в |
Примеры
- 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/gitlab_branch_module.html
