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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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/)

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз изменений состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме сравнения `check_mode` будут возвращены подробности о внесенных изменениях (или, возможно, изменениях, которые требуют внесения в `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/gitlab_protected_branch_module.html