Модуль community.general.gitlab_project_badge – Управление значками проекта на GitLab Server

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: community.general.gitlab_project_badge.

Новое в community.general 6.1.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет добавлять и удалять значки в/из проекта.

Требования

Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.

owner или maintainer права на проект на сервере GitLab
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.
image_url string / обязательно	URL изображения значка. Значок идентифицируется по этому URL.
link_url string / обязательно	URL, связанный со значком.
project string / обязательно	Имя (или полный путь) проекта GitLab, к которому добавляется/из которого удаляется значок.
state string	Состояние значка в проекте. При `present`, он добавляет значок в проект GitLab. При `absent`, он удаляет значок из проекта GitLab. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять ли SSL-сертификаты при предоставлении конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния «изменено» без изменения цели.
diff_mode	Поддержка: отсутствует	Будет возвращать подробную информацию о том, что изменилось (или, возможно, что нужно изменить в режиме `check_mode`), когда находится в дифференциальном режиме.

Примеры

- name: Add a badge to a GitLab Project
  community.general.gitlab_project_badge:
    api_url: 'https://example.gitlab.com'
    api_token: 'Your-Private-Token'
    project: projectname
    state: present
    link_url: 'https://example.gitlab.com/%{project_path}'
    image_url: 'https://example.gitlab.com/%{project_path}/badges/%{default_branch}/pipeline.svg'

- name: Remove a badge from a GitLab Project
  community.general.gitlab_project_badge:
    api_url: 'https://example.gitlab.com'
    api_token: 'Your-Private-Token'
    project: projectname
    state: absent
    link_url: 'https://example.gitlab.com/%{project_path}'
    image_url: 'https://example.gitlab.com/%{project_path}/badges/%{default_branch}/pipeline.svg'

Значения возврата

Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:

Ключ	Описание
badge словарь	Информация о значке. Возвращается: когда `state=present` Пример: `{"id": 1, "image_url": "https://shields.io/my/badge", "kind": "project", "link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}", "rendered_image_url": "https://shields.io/my/badge", "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master"}`

Ключ

Описание

badge

словарь

Информация о значке.

Возвращается: когда state=present

Пример: {"id": 1, "image_url": "https://shields.io/my/badge", "kind": "project", "link_url": "http://example.com/ci_status.svg?project=%{project_path}&ref=%{default_branch}", "rendered_image_url": "https://shields.io/my/badge", "rendered_link_url": "http://example.com/ci_status.svg?project=example-org/example-project&ref=master"}

Авторы

Guillaume MARTINEZ (@Lunik)

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

© 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_project_badge_module.html