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

Note

This plugin is part of the community.general collection (version 4.2.0).

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.

Parameters

Parameter Choices/Defaults 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
    Choices:
  • maintainer ←
  • developer
  • nobody
Access levels allowed to merge.
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
    Choices:
  • maintainer ←
  • developer
  • nobody
Access levels allowed to push.
state
string
    Choices:
  • present ←
  • absent
Create or delete proteced branch.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Whether or not to validate SSL certs when supplying a https endpoint.

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)