删除属于项目或组的 GitLab 里程碑

注意

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

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

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

要在剧本中使用它，请指定：community.general.gitlab_milestone。

community.general 8.3.0 中的新增功能

摘要 

如果里程碑不存在，它将被创建。
如果里程碑存在，当值不同时，它的值将被更新。
里程碑可以被清除。

需求 

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

python-gitlab Python 模块
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 进行身份验证的用户名。
ca_path 字符串 community.general 8.1.0 中添加	用于验证 GitLab 服务器证书的 CA 证书包。
group 字符串	组的路径。需要此参数或 `project` 参数。
milestones 列表 / 元素=字典	表示 GitLab 项目或组里程碑的字典列表。默认值： `[]`
description 字符串	里程碑的描述。
due_date 字符串	里程碑到期日期，格式为 YYYY-MM-DD。
start_date 字符串	里程碑开始日期，格式为 YYYY-MM-DD。
title 字符串 / 必填	里程碑的名称。
project 字符串	项目的路径和名称。需要此参数或 `group` 参数。
purge 布尔值	设置为 `true` 时，删除任务中未提及的所有里程碑。选项 `false` ← (默认) `true`
state 字符串	创建或删除里程碑。选项 `"present"` ← (默认) `"absent"`
validate_certs 布尔值	是否在提供 HTTPS 端点时验证 SSL 证书。选项 `false` `true` ← (默认)

属性 

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

示例 

# same project's task can be executed for group
- name: Create one milestone
  community.general.gitlab_milestone:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    milestones:
      - title: milestone_one
        start_date: "2024-01-04"
    state: present

- name: Create many group milestones
  community.general.gitlab_milestone:
    api_url: https://gitlab.com
    api_token: secret_access_token
    group: "group1"
    milestones:
      - title: milestone_one
        start_date: "2024-01-04"
        description: this is a milestone
        due_date: "2024-02-04"
      - title: milestone_two
    state: present

- name: Create many project milestones
  community.general.gitlab_milestone:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    milestones:
      - title: milestone_one
        start_date: "2024-01-04"
        description: this is a milestone
        due_date: "2024-02-04"
      - title: milestone_two
    state: present

- name: Set or update some milestones
  community.general.gitlab_milestone:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    milestones:
      - title: milestone_one
        start_date: "2024-05-04"
    state: present

- name: Add milestone in check mode
  community.general.gitlab_milestone:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    milestones:
      - title: milestone_one
        start_date: "2024-05-04"
    check_mode: true

- name: Delete milestone
  community.general.gitlab_milestone:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    milestones:
      - title: milestone_one
    state: absent

- name: Purge all milestones
  community.general.gitlab_milestone:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    purge: true

- name: Delete many milestones
  community.general.gitlab_milestone:
    api_url: https://gitlab.com
    api_token: secret_access_token
    project: "group1/project1"
    state: absent
    milestones:
      - title: milestone-abc123
      - title: milestone-two

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段：

键	描述
milestones 字典	四个列表，分别列出了已添加、已更新、已删除或存在的里程碑。返回：成功
已添加列表 / 元素=字符串	已创建的里程碑列表。返回：始终示例： `["abcd", "milestone-one"]`
已删除列表 / 元素=字符串	已删除的里程碑列表。返回：始终示例： `["defg", "new-milestone"]`
未修改列表 / 元素=字符串	存在的里程碑列表。返回：始终示例： `["defg", "new-milestone"]`
已更新列表 / 元素=字符串	其值已被设置的预先存在的里程碑列表。返回：始终示例： `["defg", "new-milestone"]`
milestones_obj 字典	API 对象。返回：成功

作者

Gabriele Pongelli (@gpongelli)