You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.gitlab_protected_branch module – (un)Marking existing branches for protection

Note

This module is part of the community.general collection (version 4.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.gitlab_protected_branch.

New in version 3.4.0: of community.general

Synopsis

• (un)Marking existing branches for protection.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7

• python-gitlab >= 2.3.0

• requests (Python library https://pypi.org/project/requests/)

Parameters

Parameter	Comments
api_job_token string added in 4.2.0 of community.general	GitLab CI job token for logging in.
api_oauth_token string added in 4.2.0 of community.general	GitLab OAuth token for logging in.
api_password string	The password to use for authentication against the API
api_token string	GitLab access token with API permissions.
api_url string	The resolvable endpoint for the API
api_username string	The username to use for authentication against the API
merge_access_levels string	Access levels allowed to merge. Choices: maintainer ← (default) developer nobody
name string / required	The name of the branch that needs to be protected. Can make use a wildcard charachter for like production/* or just have main or develop as value.
project string / required	The path and name of the project.
push_access_level string	Access levels allowed to push. Choices: maintainer ← (default) developer nobody
state string	Create or delete proteced branch. Choices: present ← (default) absent
validate_certs boolean	Whether or not to validate SSL certs when supplying a https endpoint. Choices: no yes ← (default)

Examples

- 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

Authors

• Werner Dijkerman (@dj-wasabi)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication