community.general.gitlab_branch 模块 – 创建或删除分支

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：community.general.gitlab_branch。

community.general 4.2.0 中的新增功能

概要 

此模块允许创建或删除分支。

要求 

执行此模块的主机需要以下要求。

python-gitlab >= 2.3.0
requests (Python 库 https://pypi.ac.cn/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 字符串	具有 API 权限的 GitLab 访问令牌。
api_url 字符串	API 的可解析端点。
api_username 字符串	用于对 API 进行身份验证的用户名。
branch 字符串 / 必需	需要创建的分支名称。
ca_path 字符串 community.general 8.1.0 中添加	用于验证 GitLab 服务器证书的 CA 证书捆绑包。
project 字符串 / 必需	项目的路径或名称。
ref_branch 字符串	从中创建的参考分支。如果 `state=present`，则必须指定此参数。
state 字符串	创建或删除分支。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	是否在提供 HTTPS 端点时验证 SSL 证书。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：不支持	可以在 `check_mode` 中运行并返回更改状态预测，而无需修改目标。
diff_mode	支持：不支持	处于 diff 模式时，将返回有关已更改内容（或可能需要在 `check_mode` 中更改）的详细信息。

示例 

- 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

作者

paytroff (@paytroff)