gitlab_hooks – Управление хуками проекта GitLab.
Новое в версии 2.6.
Обзор
- Добавляет, обновляет и удаляет хуки проекта.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| access_token - | Ключ OAuth, предоставленный GitLab. Требуется либо access_token, либо private_token. См. https://docs.gitlab.com/ee/api/oauth2.html | |
| api_url - / обязательно | URL API GitLab, например, https://gitlab.example.com/api | |
| enable_ssl_verification boolean |
| Включить проверку SSL GitLab при срабатывании хука. |
| hook_url - / обязательно | URL, который GitLab должен отправлять. Используется в качестве первичного ключа для обновлений и удалений. | |
| issues_events boolean |
| Срабатывать ли хук при событиях с задачами? |
| job_events boolean |
| Срабатывать ли хук при событиях с заданиями? |
| merge_requests_events boolean |
| Срабатывать ли хук при событиях с запросами на слияние? |
| note_events boolean |
| Срабатывать ли хук при событиях с заметками? |
| pipeline_events boolean |
| Срабатывать ли хук при событиях с конвейерами? |
| private_token - | Персональный токен доступа. Требуется либо private_token, либо access_token. См. https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html | |
| project - / обязательно | Числовой идентификатор проекта или имя проекта в формате группа/имя | |
| push_events boolean |
| Срабатывать ли хук при событиях push? |
| state - / обязательно |
| При значении present хук будет обновлен в соответствии с вводом или создан, если он не существует. При значении absent хук будет удален, если он существует. |
| tag_push_events boolean |
| Срабатывать ли хук при событиях push тега? |
| token - | Секретный токен для проверки сообщений хука на стороне получателя. Если присутствует, всегда приведет к изменению, так как его нельзя получить из GitLab. Будет отображаться в заголовке HTTP-запроса X-Gitlab-Token | |
| wiki_page_events boolean |
| Срабатывать ли хук при событиях с вики-страницами? |
Примеры
# Example creating a new project hook
- gitlab_hooks:
api_url: https://gitlab.example.com/api
access_token: "{{ access_token }}"
project: "my_group/my_project"
hook_url: "https://my-ci-server.example.com/gitlab-hook"
state: present
push_events: yes
enable_ssl_verification: no
token: "my-super-secret-token-that-my-ci-server-will-check"
# Update the above hook to add tag pushes
- gitlab_hooks:
api_url: https://gitlab.example.com/api
access_token: "{{ access_token }}"
project: "my_group/my_project"
hook_url: "https://my-ci-server.example.com/gitlab-hook"
state: present
push_events: yes
tag_push_events: yes
enable_ssl_verification: no
token: "my-super-secret-token-that-my-ci-server-will-check"
# Delete the previous hook
- gitlab_hooks:
api_url: https://gitlab.example.com/api
access_token: "{{ access_token }}"
project: "my_group/my_project"
hook_url: "https://my-ci-server.example.com/gitlab-hook"
state: absent
# Delete a hook by numeric project id
- gitlab_hooks:
api_url: https://gitlab.example.com/api
access_token: "{{ access_token }}"
project: 10
hook_url: "https://my-ci-server.example.com/gitlab-hook"
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| error строка | ошибка | Сообщение об ошибке, возвращенное API Gitlab Пример: 400: ключ уже используется |
| msg строка | всегда | Сообщение об успехе или об ошибке Пример: Успех |
| previous_version словарь | изменено | Объект, описывающий состояние до выполнения задачи |
| result словарь | всегда | Обработанный JSON-ответ от сервера |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- Marcus Watkins (@marwatk)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать её, чтобы улучшить её.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/gitlab_hooks_module.html
