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 bool |
| Включить проверку SSL GitLab при запуске хука |
| hook_url обязательно | URL, который GitLab должен отправлять сообщения, используется в качестве основного ключа для обновлений и удаления. | |
| issues_events bool |
| Запускать хук при событиях с вопросами |
| job_events bool |
| Запускать хук при событиях задач |
| merge_requests_events bool |
| Запускать хук при событиях запросов на слияние |
| note_events bool |
| Запускать хук при событиях заметок |
| pipeline_events bool |
| Запускать хук при событиях конвейера |
| private_token | Личный токен доступа. Требуется либо private_token, либо access_token. См. https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html | |
| project обязательно | Числовой ID проекта или имя проекта в формате группа/имя | |
| push_events bool |
| Запускать хук при событиях push |
| state обязательно |
| Когда present хук будет обновлён в соответствии со входящими данными или создан, если его не существует. Когда absent он будет удалён, если существует. |
| tag_push_events bool |
| Запускать хук при событиях push тегов |
| token | Секретный токен для проверки сообщений хука на стороне получателя. Если он присутствует, он всегда приведёт к изменению, так как его нельзя получить из GitLab. Будет отображаться в заголовке HTTP запроса X-Gitlab-Token | |
| wiki_page_events bool |
| Запускать хук при событиях на страницах вики |
Примеры
# 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. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/gitlab_hooks_module.html
