Gitlab Hook
Resumo
- Adiciona, atualiza e remove hooks de um projeto.
Parâmetros
Parâmetro | TIpo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
api_token | string | | Token GitLab para login. |
api_url | string | | O caminho da API em formato URL. |
hook_url - required | string | | O url que você deseja que o GitLab poste, é usado como a chave primária para atualizações e exclusões. |
hook_validate_certs aliases: enable_ssl_verification | boolean | Escolhas: - false (default) - true | Se o GitLab fará a verificação SSL ao acionar o hook. |
issues_events | boolean | Escolhas: - false (default) - true | Hook de ativação em eventos de problemas. |
job_events | boolean | Escolhas: - false (default) - true | Hook de ativação em eventos de trabalho. |
merge_requests_events | boolean | Escolhas: - false (default) - true | Hook de ativação em eventos de pedidos de fusão. |
note_events | boolean | Escolhas: - false (default) - true | Hook de ativação em eventos de notas ou quando alguém adiciona um comentário. |
pipeline_events | boolean | Escolhas: - false (default) - true | Hook de ativação em eventos de conduta. |
project - required | string | | Id ou caminho completo do projeto na forma de grupo/nome. |
push_events | boolean | Escolhas: - false - true (default) | Hook de ativação em eventos de push. |
push_events_branch_filter | string | | Nome do ramo coringa para acionar o hook em eventos de empurrar. |
state | string | Escolhas: - present (default) - absent | Quando presente, o hook será atualizado para corresponder à entrada ou criado se não existir. Quando ausente, o hook será apagado se existir. |
tag_push_events | boolean | Escolhas: - false (default) - true | Hook de ativação em eventos de tag push. |
token | string | | Token secreto para validar mensagens de hook no receptor. Se este estiver presente, resultará sempre numa mudança, pois não pode ser recuperado do GitLab. Aparecerá no cabeçalho de pedido HTTP do X-GitLab-Token. |
validate_certs | boolean | Escolhas: - false - true (default) | Validar ou não os certificados SSL ao fornecer uma url https. |
wiki_page_events | boolean | Escolhas: - false (default) - true | Hook de ativação em eventos wiki. |
Exemplos
# Exemplo: Acrescentar hook em um projeto.
- gitlab_hook:
api_url: https://gitlab.example.com/
api_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
hook_validate_certs: no
token: "my-super-secret-token-that-my-ci-server-will-check"
# Exemplo: Apagar o hook anterior
- gitlab_hook:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: "my_group/my_project"
hook_url: "https://my-ci-server.example.com/gitlab-hook"
state: absent
# Exemplo:Apagar um hook por id numérico do projeto
- gitlab_hook:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
project: 10
hook_url: "https://my-ci-server.example.com/gitlab-hook"
state: absent
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
error | string | Falha | A mensagem de erro devolvida pelo GitLab API. |
.hook | dictionary | Sempre | Objeto API. |
msg | string | Sempre | Mensagem de sucesso ou falha. |
result | | Sempre | Resposta json do servidor. |