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

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.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
requests (библиотека Python https://pypi.org/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 строка	Токен доступа GitLab с правами API.
api_url строка	Доступный адрес API.
api_username строка	Имя пользователя для аутентификации по API.
ca_path строка добавлено в community.general 8.1.0	Файл сертификатов CA для проверки сертификата сервера GitLab.
group строка	Путь к группе. Требуется либо это, либо `project`.
milestones список / элементы=словарь	Список словарей, представляющих задачи проекта или группы Gitlab. По умолчанию: `[]`
описание строка	Описание задачи.
срок_сдачи строка	Срок выполнения задачи в формате ГГГГ-ММ-ДД.
дата_начала строка	Дата начала задачи в формате ГГГГ-ММ-ДД.
заголовок строка / обязательный	Название задачи.
project строка	Путь и имя проекта. Требуется либо это, либо `group`.
удалить логический	При установке в `true`, удаляет все задачи, которые не указаны в задании. Варианты: `false` ← (по умолчанию) `true`
состояние строка	Создать или удалить задачу. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логический	Подтверждать ли сертификаты SSL при указании конечной точки HTTPS. Варианты: `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 словарь	Четыре списка задач, которые были добавлены, обновлены, удалены или существуют. Возвращаемое значение: успех
added список / элементы=строка	Список задач, которые были созданы. Возвращаемое значение: всегда Пример: `["abcd", "milestone-one"]`
removed список / элементы=строка	Список задач, которые были удалены. Возвращаемое значение: всегда Пример: `["defg", "new-milestone"]`
untouched список / элементы=строка	Список задач, которые существуют. Возвращаемое значение: всегда Пример: `["defg", "new-milestone"]`
updated список / элементы=строка	Список существующих задач, значения которых были изменены. Возвращаемое значение: всегда Пример: `["defg", "new-milestone"]`
milestones_obj словарь	Объект API. Возвращаемое значение: успех

Авторы

Gabriele Pongelli (@gpongelli)

Ссылки на сборку

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