Модуль community.general.gitlab_protected_branch — управление защитой существующих веток

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.gitlab_protected_branch.

Добавлено в community.general 3.4.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры

Краткое описание

Пометка существующих веток как защищённых или снятие такой пометки.

Требования

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

python-gitlab >= 2.3.0
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Параметр	Комментарии
allow_force_push boolean добавлено в community.general 11.3.0	Разрешить ли принудительную отправку изменений в защищённую ветку. Варианты: `false` `true`
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.
ca_path string добавлено в community.general 8.1.0	Пакет сертификатов CA для проверки сертификата сервера GitLab.
code_owner_approval_required boolean добавлено в community.general 11.3.0	Требовать ли одобрения владельца кода для отправки изменений. Варианты: `false` `true`
merge_access_levels string	Уровни доступа, которым разрешено слияние. Варианты: `"maintainer"` ← (по умолчанию) `"developer"` `"nobody"`
name string / обязательный	Имя ветки, которую необходимо защитить. Можно использовать подстановочный символ, например `production/*`, или указать в качестве значения только `main` либо `develop`.
project string / обязательный	Путь и имя проекта.
push_access_level string	Уровни доступа, которым разрешена отправка изменений. Варианты: `"maintainer"` ← (по умолчанию) `"developer"` `"nobody"`
state string	Создать или удалить защищённую ветку. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять ли сертификаты SSL при использовании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Create protected branch on main
  community.general.gitlab_protected_branch:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "dj-wasabi/collection.general"
    name: main
    merge_access_levels: maintainer
    push_access_level: nobody

Авторы

Werner Dijkerman (@dj-wasabi)

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

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