Guia Básico de GitLab
O GitLab é uma plataforma completa de DevOps que oferece uma variedade de ferramentas para controle de versão, integração e entrega contínua (CI/CD), gerenciamento de código-fonte e colaboração em projetos de desenvolvimento de software. Ele permite que equipes trabalhem juntas em um único ambiente para planejar, criar, testar, e implantar aplicações de forma rápida e eficiente.
1. Acesso e Registro de conta
Caso você não possua uma conta registrada no GitLab, poderá realizar esse registro de acordo com o passo a passo a seguir:
1 - Acesse o site do GitLab
Abra o navegador e vá para o site Gitlab.
Esta é a tela de login, é possível acessar, por meio dela, a tela de registro de conta e outras telas auxiliares.
2 - Acesse a página de registro
Para fazer o registro, clique no link do texto "Registre-se agora", acompanhado pelo trecho "Ainda não tem uma conta?".
Nesta tela, será possível realizar o registro direto de uma conta, atribuída a um email, ou selecionar alguma das opções de sites externos que servirão para o mesmo objetivo, como Google, GitHub, BitBucket ou Salesforce.
Por esses sites, é possível vincular sua respectiva conta ao GitLab, para que assim não seja necessária a criação por registro direto. Segue a imagem da tela em questão:
3 - Registro Direto
Realize o registro preenchendo o formulário disponibilizado, inserindo:
-
Nome;
-
Último nome;
-
Nome de Usuário;
-
E-mail;
-
Senha;
Tenha em mente que ao realizar o registro você concordará com os Termos de Serviço e a Política de Privacidade do GitLab.
Ao clicar no botão continuar, você será redirecionado para uma tela que irá solicitar um código de verificação enviado ao e-mail que foi registrado. Acesse seu e-mail para obter o código e siga clicando no botão "Verificar endereço de e-mail", seguido de "Continuar". Se tudo estiver correto, seu registro foi realizado com sucesso.
4 - Registro Externo
Acesse o site ou plataforma de sua escolha na parte inferior da página, logo após o trecho "Continuar com:", e realize login na plataforma escolhida de acordo com seu devido passo a passo. Após ser realizado o login, você será redirecionado ao GitLab em sua própria conta.
2. Login de Usuário
Caso você já possua uma conta registrada no GitLab, poderá apenas realizar o login pelo mesmo link disponibilizado: Gitlab.
Nesta tela, será possível utilizar quaisquer das opções disponibilizadas para acessar sua conta:
1 - Registro direto
Preencha o formulário de login disponibilizado na área superior da página de acordo com seus dados, com o seguinte:
-
Nome de usuário ou e-mail principal;
-
Senha;
E realize o login clicando no botão "Fazer login" logo abaixo do formulário.
2 - Registro externo
Acesse o site ou plataforma de sua escolha na parte inferior da página, logo após o trecho "ou faça login com", e realize login na plataforma escolhida de acordo com seu devido passo a passo. Após ser realizado o login, você será redirecionado ao GitLab.
3. Navegação pelo GitLab
3.1. Grupo Squad 07
O grupo do squad 07 está criado dentro da organização da disciplina do GitLab, o link direto é:
https://gitlab.com/unb-esw/fga-pi2/semestre-2024-3/squad07
Dentro do grupo, serão criados os repositórios que serão utilizados para documentação, versionamento de código, etc. Segue imagem:
Fonte: Própria
Dentro do grupo principal, foi criado um quadro, que tem por objetivo organizar o fluxo de trabalho do grupo durante o desenrolar do projeto, o quadro pode ser acessado da seguinte forma:
Fonte: Própria
Cujo link direto é:
O quadro se trata de um quadro kanban, que apresenta algumas colunas principais para organização do fluxo de trabalho:
- Abrir: Todas as tarefas (tickets) que foram criados no projeto, pode ser entendido como o Backlog do Produto, ou seja, todas as issues que devem ser feitas durante o projeto;
- Para fazer: Tarefas que são prioritárias e devem ser feitas na sprint que estamos no momento;
- Em execução: Tarefas que estão sendo desenvolvidas no momento. Nesse momento, os responsáveis pela tarefa devem se atribuir a ela, isso será mostrado adiante;
- Entregue: Tarefas que foram feitas e ainda precisam de validação;
- Fechadas: Tarefas já feitas e validadas.
Fonte: Própria
3.2. Repositório
Um repositório no GitLab é basicamente um diretório que serve para armazenar vários arquivos e o código fonte de cada domínio do projeto. Futuramente serão criados projetos para as diferentes engenharias do proejto.
Dentro de um repositório criamos os tickets, que são as tarefas de cada repositório, para criar um ticket é necessário acessar o tópico tíquetes na barra lateral do repositório:
Fonte: Própria
Cujo link é:
E apertar no botão de criação de nova issue.
3.3. Branches
No gitlab, as branches, que foram explicadas nos tópicos de git, podem ser acessadas da seguinte forma:
Fonte: Própria
Os arquivos serão apresentados conforme a branch selecionada.
3.3. Merge Requests
Para um eficiente versionamento e colaboração no gitlab, deve ser criada uma branch para fazer novas contribuições no código, porém, para atualizar as branches principais com as alterações feitas, é necessário abrir um Merge Requet, também conhecido como MR. O merge request basicamente é uma solicitação de merge da branch trabalhada com a branch principal.
Para visualizar também deve ser clicado no botão lateral, que é em
Fonte: Própria
Código -> Solicitações de merge
Fonte: Própria
Para criar uma solicitação de merge: "Nova solicitação de merge"
Ao detalhas um MR, ele é apresentado da seguinte forma:
Fonte: Própria
Aprovar um MR: Para mergear um MR, é necessária a aprovação de um mantenedor do projeto, que deve fazer a revisão. Após isso, é possível fazer o merge da branch trabalhada com a branch desejada.
Para visualizar todas as alterações feitas no MR:
Fonte: Própria
3.4. Tarefas
Campos importantes na criação da issue:
Fonte: Própria
- Responsáveis: Deve ser assinado o responsável pela issue;
- Etiquetas: Selecionar em que subdomínio a issue está inserida e em que estado está (Para fazer, em execução e concluído);
4. Acesso ao GitPages
O GitLab Pages, ou GitPages, é a ferramenta do GitLab que irá fazer uso do MKDocs para hospedar um site com o conteúdo de nossa documentação. Para mais informações, verifique o guia sobre MKDocs em nosso projeto.
Após acessado o repositório, é possível encontrar um link para o GitPages do projeto em questão, que estará posicionado logo abaixo do trecho "Informações do projeto" na página inicial do repositório.
Fonte: Própria
Este é o link para o GitPages do nosso projeto: GitPages Squad 07
Tabela de versionamento
| Versão | Data | Descrição | Responsável |
|---|---|---|---|
| 1.0 | 31/10/2024 | Criação dos tópicos de Registro e Login ao GitLab | Gabriel Moretti |
| 1.1 | 31/10/2024 | Adição de documentação | Adne Moretti |
| 1.2 | 02/11/2024 | Melhorando documentação do GitPages | Gabriel Moretti |
| 1.2 | 25/11/2024 | Revisão final de imagens | Gabriel Moretti |