Com a integração com o GitLab vê merge requests, pipelines, ambientes e commits diretamente nas suas tarefas no FeatValue. Os seus clientes ficam a saber em palavras simples se a alteração está em andamento, em staging para testar ou já no ar.
Empresas de software e agências web ouvem sempre a mesma pergunta: «Isto já está online?» Com a integração, o FeatValue responde-lhe na tarefa:
- Branches, commits e merge requests com o ID da tarefa aparecem na tarefa certa.
- Pipelines e deployments mostram se a alteração foi testada e a que ambiente chegou.
- O FeatValue regista os passos importantes como comentários no histórico da tarefa.
- Em cada projeto decide o que os seus clientes veem disso.
- Inicia jobs manuais, como um deployment, diretamente a partir do FeatValue.
Para uma visão geral, veja a página sobre a integração com o GitLab.
Requisitos
- uma conta FeatValue da sua empresa com pelo menos um cliente e um projeto (ver Criar projetos)
- GitLab em gitlab.com ou como instância própria, acessível por https
- pelo menos a função Maintainer nos projetos do GitLab que pretende ligar. Assim o FeatValue pode criar o webhook.
Ligar o GitLab
-
Abrir a aplicação
Clique em
Aplicações na barra lateral esquerda, escolha
GitLab e clique em
Instalar (ver
Ligar Aplicações). Aparece a página
Ligar o GitLab com a pergunta
Onde está o seu GitLab?
-
gitlab.com
Escolha gitlab.com e clique em Continuar. Inicie sessão no GitLab e permita o acesso. Assim o FeatValue obtém acesso aos seus projetos.
-
Instância própria do GitLab
Escolha Instância própria do GitLab. Introduza o endereço https em Endereço da instância, por exemplo https://gitlab.example.com, e um token em Personal access token. Clique em Continuar.
De que token preciso para uma instância própria?
Crie o token no GitLab em Preferências › Access tokens:
- Âmbito:
api. Âmbitos só de leitura, como read_api, não chegam, porque o FeatValue cria webhooks e inicia jobs manuais.
- Função: O utilizador do token precisa pelo menos da função Maintainer nos projetos.
- Data de expiração: Quando o token expira, deixam de chegar dados novos. Crie então um novo token e ligue o GitLab outra vez.
Para a integração, use de preferência um utilizador próprio ou um token de grupo. Assim, ela não depende da conta de uma só pessoa.
Ligar um repositório a um projeto
Cada repositório pertence a exatamente um projeto do FeatValue. Só os repositórios ligados chegam ao FeatValue.
-
Abrir Ligar repositórios
Abra
Definições › Empresa › Integrações e apps e escolha
GitLab (ver
Apps ligadas). A página chama-se
Ligar repositórios.
-
Encontrar o repositório
Os seus repositórios estão listados em Repositórios no GitLab. Com Pesquisar repositório reduz a lista.
-
Escolher o projeto e ligar
Ao lado do repositório, escolha o Projeto FeatValue e clique em Ligar. O FeatValue cria um webhook no GitLab e recupera os últimos dias.
Todas as ligações aparecem em Repositórios ligados. A coluna Atualização mostra De imediato por webhook ou A cada 10 minutos. Com Alterar escolhe outro projeto e com Desligar remove a ligação; o FeatValue apaga então também o webhook.
Usar corretamente o ID da tarefa
Cada tarefa no FeatValue tem um ID, por exemplo abc123-4. Encontra-o na tarefa. Coloque este ID num destes sítios:
| Onde |
Exemplo |
| Nome do branch |
abc123-4-formulario-contacto |
| Mensagem de commit |
abc123-4 Tornar o telefone obrigatório |
| Título ou descrição do merge request |
Formulário de contacto: tornar o telefone obrigatório (abc123-4) |
- Maiúsculas e minúsculas não importam, e é permitido um
# no início.
- Se o ID estiver no nome do branch, contam apenas os commits que existem só neste branch. Os commits do branch predefinido que vêm junto ao criar o branch não aparecem na tarefa.
- Os commits noutros branches só aparecem se o ID estiver na respetiva mensagem de commit.
- O ID só é válido dentro do projeto ligado. O FeatValue nunca atribui repositórios ligados a outro projeto ou que não estejam ligados.
- Pipelines e deployments pertencem à tarefa se correrem para um dos seus branches, commits ou merge requests.
O que aparece na tarefa
A tarefa mostra a secção Desenvolvimento com uma linha compacta, por exemplo: MR !12 mesclada · Pipeline concluída · Publicado em Staging. Clique em Mostrar detalhes para expandir:
- Pipelines com etapas e jobs e o respetivo estado
- Ambientes com um link para os abrir, por exemplo Staging e Production
- Merge requests, Branches e Commits
O que aparece no projeto
No projeto, a secção Desenvolvimento mostra os ambientes com o último deployment e o último pipeline no branch predefinido. Clique em Mostrar todas as pipelines para ver os Últimos pipelines. É também aqui que encontra as Definições do projeto.
O que veem os clientes?
No projeto, nas Definições da secção Desenvolvimento, escolha em O que veem os clientes?:
| Definição |
O seu cliente vê |
| Nada |
nenhuma informação do GitLab |
| Estado simples |
uma frase sem termos técnicos: Em andamento, Publicado em Staging com o link teste aqui, ou No ar com o link ver agora |
| Detalhes |
as secções que marcar em Detalhes para clientes: commits, branches, merge requests, pipelines, ambientes e comentários de histórico |
Esta definição pode ser alterada pelas pessoas da sua empresa que podem editar o projeto. Como o seu cliente depois testa e aceita, explicamos em Revisão e aceitação.
Configurar os comentários de histórico
O FeatValue regista os passos importantes como comentários no histórico da tarefa. Em Comentários de histórico na tarefa escolhe, para cada projeto, que eventos criam um comentário:
- Merge request mesclada
- Pipeline bem-sucedida
- Pipeline falhou (com jobs com falha)
- Implantado no ambiente
Os eventos desmarcados continuam a atualizar o estado na tarefa, mas deixam de criar um comentário. Se o seu cliente vê os comentários depende da definição em O que veem os clientes?.
Executar jobs a partir do FeatValue
Starter
Inicia jobs manuais do seu pipeline, por exemplo deploy-production, diretamente no FeatValue. Esta função está disponível a partir do plano Starter (ver Planos).
-
Permitir jobs
No projeto, abra as Definições da secção Desenvolvimento. Em Executar jobs a partir do FeatValue encontra os jobs manuais que o GitLab comunicou até agora. Marque os jobs que devem aparecer no FeatValue e clique em Guardar.
-
Também para clientes
Se o seu cliente também deve poder iniciar os jobs selecionados, marque Os clientes também podem executar os jobs selecionados.
-
Executar um job
Quando um job permitido aguarda o início manual, aparece com o botão Executar. Depois do clique, o FeatValue mostra Iniciado, e acompanha o resto no pipeline.
Se aparecer Ainda não foram comunicados jobs manuais., ainda não correu nenhum pipeline com um job manual. Assim que o GitLab comunicar um, pode permiti-lo.
Segurança
- Só repositórios ligados: O FeatValue só lê os repositórios que ligou a um projeto e só atribui IDs de tarefa dentro desse projeto.
- Sem código: O FeatValue não guarda ficheiros do seu repositório, apenas informações sobre branches, commits, merge requests, pipelines e ambientes.
- Webhook verificado: Cada webhook recebe o seu próprio token secreto. O FeatValue só aceita chamadas que enviem este token.
- Os seus direitos no GitLab: O FeatValue trabalha com os direitos do início de sessão ou do token. Só pode iniciar jobs que tenha permitido.
- Desligar a qualquer momento: Desligar remove uma ligação, e o FeatValue apaga o webhook.
Resolução de problemas
O meu repositório não aparece na lista
O FeatValue só mostra repositórios em que tem pelo menos a função Maintainer. Verifique a sua função no GitLab ou pesquise o nome com Pesquisar repositório.
Não foi possível criar o webhook
A ligação mostra então A cada 10 minutos em vez de De imediato por webhook. Nesse caso, o FeatValue consulta o GitLab a cada 10 minutos, por isso nada se perde, apenas chega mais tarde. Causas frequentes: falta a função Maintainer, ou a sua instância do GitLab não pode enviar pedidos para a internet. Verifique isto e depois clique em Alterar e outra vez em Ligar.
Não aparece nada na tarefa
- O repositório está ligado ao projeto a que a tarefa pertence?
- O ID completo da tarefa está no nome do branch, na mensagem de commit ou no merge request?
- Sem webhook, os dados novos demoram até 10 minutos a chegar.
O GitLab não aceitou o token
Verifique o endereço da instância, o token e o âmbito api. O token não pode ter expirado.
Não é possível iniciar um job
Executar jobs está disponível a partir do plano Starter. Além disso, o job tem de estar permitido nas definições do projeto e a aguardar o início manual nesse momento. Se aparecer Não foi possível iniciar, verifique no GitLab se o início de sessão ainda pode iniciar o job.