Модуль community.general.gitlab_milestone — создание, обновление и удаление контрольных точек GitLab, принадлежащих проекту или группе

Примечание

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

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

Параметры

Параметр	Описание
api_job_token string добавлено в community.general 4.2.0	Токен задания GitLab CI для входа.
api_oauth_token string добавлено в community.general 4.2.0	Токен OAuth GitLab для входа.
api_password string	Пароль для аутентификации в API.
api_token string	Токен доступа GitLab с разрешениями для API.
api_url string	Доступная конечная точка API.
api_username string	Имя пользователя для аутентификации в API.
ca_path string добавлено в community.general 8.1.0	Пакет сертификатов CA для проверки сертификата сервера GitLab.
group string	Путь к группе. Необходимо указать либо этот параметр, либо `project`.
milestones list / elements=dictionary	Список словарей, описывающих контрольные точки проекта или группы GitLab. По умолчанию: `[]`
description string	Описание контрольной точки.
due_date string	Срок завершения контрольной точки в формате YYYY-MM-DD.
start_date string	Дата начала контрольной точки в формате YYYY-MM-DD.
title string / обязательный	Название контрольной точки.
project string	Путь и название проекта. Необходимо указать либо этот параметр, либо `group`.
purge boolean	Если задано значение `true`, удаляются все контрольные точки, не указанные в задаче. Варианты: `false` ← (по умолчанию) `true`
state string	Создать или удалить контрольную точку. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять ли SSL-сертификаты при указании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменений без изменения целевого объекта.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о том, что может потребоваться изменить в `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 dictionary	Четыре списка контрольных точек: добавленные, обновлённые, удалённые и существующие. Возвращается: success
added list / elements=string	Список созданных контрольных точек. Возвращается: всегда Пример: `["abcd", "milestone-one"]`
removed list / elements=string	Список удалённых контрольных точек. Возвращается: всегда Пример: `["defg", "new-milestone"]`
untouched list / elements=string	Список существующих контрольных точек. Возвращается: всегда Пример: `["defg", "new-milestone"]`
updated list / elements=string	Список ранее существовавших контрольных точек, значения которых были изменены. Возвращается: всегда Пример: `["defg", "new-milestone"]`
milestones_obj dictionary	Объект API. Возвращается: success

Авторы

Gabriele Pongelli (@gpongelli)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/gitlab_milestone_module.html