4.1. Autenticação no Sistema - Login
4.3.1. Procedimento para identificar a URL de um repositório
4.4. Criar uma pasta dentro do repositório
4.5. Incluir um novo documento
4.6. Atualizar um documento (funções “Commit”, “Commit & Push” e “Push”)
4.6.2. Executar um Commit & Push
4.9. Função “Clean up” Função “Clean up”
4.10. Visualizar o histórico de versões do documento
4.11. Visualizar um documento em uma versão anterior
4.12. Comparar as versões de um documento
4.13. Recuperar uma versão anterior sobrescrevendo a última versão do documento
4.15. Link de uma versão específica do documento
4.16. Link de uma versão específica da branch (a ser informado no Documento de Deploy)
1. Identificação do Sistema
|
Sigla/Nome do sistema: |
Git |
||
| Endereço de acesso: | https://www.fnde.gov/repositorio | ||
| Configuração Recomendada: | |||
|
Sistemas operacionais: Para utilização do TortoiseGit (2.5.0.0 ou superior):
|
Navegador da Internet: Para utilização do Git Lab (9.4.4 ou superior):
|
||
|
Em produção desde: |
Agosto/2017 |
Versão atual do sistema: |
9.4.4 |
2. Introdução
O GIT é uma ferramenta de controle de versão distribuido (Distributed Version Control Systems – DVCS), adotada pela DIRTI como repositório para gerenciamento de todas as atividades executadas pelas coordenações CGDES, CGGOV e CGINF. Com a implantação da ferramenta GIt tem-se grandes benecifico no gerenciamento de projetos de desenvolvimento de sistemas, no que se refere a versionamento de código fonte e documentação de sistemas (manutenção evolutiva e execução de projetos).
3. Perfis de Acesso
|
Perfil |
Descrição |
Funcionalidades disponíveis |
|
Reporter |
Perfil básico do Git, no qual o usuário consegue apenas visualizar e baixar repositórios. |
|
|
Developer |
Perfil intermediário do Git, utilizado geralmente para desenvolvimento, no qual o usuário é capaz de criar e excluir branches. |
|
| Master | Perfil avançado do Git. Além das demais funcionalidades citadas acima, o usuário é capaz de realizar commit/push na master. Opção que não é permitida para os outros perfis. |
|
4. Funcionalidades do Sistema
Antes de começar a trabalhar com o Git, é necessário atender a duas pré-condições que possibilitam a utilização da ferramenta. Sendo estas:
-
Realizar o primeiro acesso ao GIT para desbloqueio de usuário:
Para acesso aos repositórios contidos no GIT, se faz necessária solicitação de permissão à equipe de arquitetura, que será realizada por meio do primeiro acesso ao endereço https://www.fnde.gov.br/repositorio. Devendo ser utilizado o usuário e senha da rede do FNDE.
Ao acessar o endereço do repositório, será apresentada a tela de acesso ao GIT. Informe o usuário e senha de rede e aguarde o desbloqueio e liberação de acesso para escrita aos seus respectivos repositórios.
-
Solicitar Instalação do TortoiseGit:
Para atualização dos arquivos armazenados no repositório GIT, é essencial a instalação da ferramenta TortoiseGIT, possibilitando assim a realização de consulta, inclusão, alteração e remoção de arquivos por meio do Windows.
Para solicitar a instalação do TortoiseGIT, acesse o endereço servicos.fnde.gov.br para realizar a abertura de chamado, realizando os seguintes passos:
A tela contendo o formulário para abertura da requisição será apresentada para preenchimento e envio da solicitação para atendimento.
4.1. Autenticação no Sistema - Login
Já tendo o usuário desbloqueado pela equipe de arquitetura, basta acessar o endereço wwww.fnde.gov.br/repositorio, inserir as informações de login da rede do FNDE e selecionar a oção Sign in.
4.2. Página Inicial
Após realizar o login no Git Lab será apresentada a tela inicial contendo a lista de todos os repositórios aos quais o usuário possui permissão de visualização (leitura).
Um usuário pode ter acesso de leitura à diversos repositórios, todavia, provavelmente irá trabalhar somente com alguns deles. Para facilitar a negavação o Git Lab permite a configuração de repositórios favoritos. Para utilizar este recurso basta efetuar os seguintes passos:
Passo01. Acessar o repositório desejado e selecionar a opção Star conforme destaque na imagem abaixo.
Passo02. Para visualizar os repositórios marcados como favoritos, basta selecionar a opção Starred projects na tela inicial do Git Lab.
4.3. Baixar um repositório
Para baixar um repositório no Git é necessário realizar a função "Git Clone". O Git Clone permite obter uma cópia completa do repositório (e seu histórico) na máquina do usuário.
Segue abaixo todas as instruções necessárias para baixar um repositório no Git.
Utilizar preferencialmente a partição de disco (D:) para realizar o clone do repositório desejado. Somente após a instalação e configuração do GIT deverá ser realizada a ação de clonar o repositório. Para realizar um Git Clone, siga os seguintes passos:
Passo01. Na partição de disco (D:) criar uma pasta com nome "Repositório". Dentro desta pasta clique com o botão direito do mouse e selecione a opção Git Clone.
Passo02. Após acionar a opção Git Clone, a seguinte tela será apresentada. Informe o endereço do repositório conforme exemplo: https://www.fnde.gov.br/repositorio/doc-geral/treinamentoGit.git e selecione a opção Ok. Caso não saiba a URL do repositório desejado, veja como identifica-la no tópico 4.3.1.
Passo03. Após a confirmação da realização do GIT Clone, será realizado o download dos arquivos para dentro da pasta no disco (D:), conforme exemplo: Cloning into 'D:\treinamentoGit'. Após finalizar o download, selecionar a opção Close.
4.3.1. Procedimento para identificar a URL de um repositório
Passo01. Para identificar o endereço do repositório desejado, acesse o endereço www.fnde.gov.br/repositorio. Será apresentada a lista de todos os repositórios aos quais o usuário possui permissão de acesso, basta clicar sobre o repositório desejado.
Passo02. Copiar a URL apresentada no campo indicado na imagem abaixo.
4.4. Criar uma pasta dentro do repositório
Para criar uma pasta dentro de um repositório, basta seguir as instruções descritas abaixo.
Passo 1: Após criada a pasta (composta por pelo menos um arquivo), com o botão direito sobre a pasta selecionar a opção TortoiseGit + Add.
Passo 2: Será apresentada uma janela para confirmação da inclusão. Nesta, clicar sobre a opção OK.
Passo 3: Em seguida será apresentada uma janela de conclusão da adição do(s) novo(s) documento(s). Nesta, clicar sobre a opção OK.
Passo 4: Após adicionada a pasta, clicar com o botão direito sobre esta e selecionar a opção Git Commit.
Passo 5: Inserir um comentário para a criação do(s) documento(s) que compõe(m) a pasta em questão e clicar sobre o botão Commit & Push.
Passo 5: Aguardar o upload do(s) arquivo(s) adicionado(s) e em seguida clicar sobre a opção Close.
Obs.: A estrutura de repositórios no GIT é composta da seguinte maneira:
- Branches;
- Tags;
- Master.
Todas as pastas relativas à documentação deverão ser criadas dentro da pasta Master, conforme estrutura representada abaixo:
- Master
- Documentação do Sistema;
- Demandas.
- Branch
- Tag
4.5. Incluir um novo documento
Para incluir um novo documento no repositório GIT, é necessário realizar os seguintes passos:
Passo 1: Após criado o documento, com o botão direito sobre o arquivo selecionar a opção TortoiseGit + Add.
Passo 2: Será apresentada uma janela de conclusão da adição do documento. Nesta, clicar sobre a opção OK.
Passo 3: Após adicionado o arquivo, clicar com o botão direito sobre este e selecionar a opção Git Commit.
Passo 4: Verificar se o arquivo adicionado aparece marcado na lista, inserir um comentário para a criação do documento em questão e clicar sobre o botão Commit & Push.
Passo 5: Aguardar o upload do arquivo adicionado e em seguida clicar sobre a opção Close.
4.6. Atualizar um documento (funções “Commit”, “Commit & Push” e “Push”)
- Commit
Foi modificado um arquivo e você deseja salvar uma nova versão deste para não correr o risco de perder o que já foi feito. Você irá realizar um Commit e comentar o que foi modificado. Todavia, no GIT esta função estará apenas salvando uma nova versão do arquivo no repositório local (ou seja, em sua máquina), e esta não irá para o servidor até que seja realizado o comando Push.
- Commit & Push
Foi modificado um arquivo e você deseja salvar esta nova versão enviando-a direto para o servidor. Para isto você irá realizar um Commit & Push comentando o que foi modificado. O comando Commit irá salvar esta versão do arquivo no repositório local enquanto o Push disponibilizará uma cópia desta no servidor. Quando os outros integrantes da equipe fizerem um Pull, esta versão do arquivo será baixada e incluída no repositório local da pessoa.
- Push
Foi modificado um arquivo várias vezes e você commitou descrevendo o que fez exatamente naquelas modificações, e agora precisa enviar tudo isso para o servidor. O comando Push envia as suas modificações para o servidor incluindo-as no histórico do projeto. Quando os outros integrantes da equipe fizerem um Pull, essas modificações serão baixadas e incluídas no repositório local da pessoa. Todavia, é importante lembrar que o comando Push só irá enviar para o servidor as modificações que tiveram Commit realizado.
4.6.1. Função Commit
Após modificar um arquivo é possível realizar a função Commit (salvar a versão do arquivo no repositório local) realizando os seguintes passos:
Passo01. Após modificado o arquivo, clicar sobre este com o botão direito do mouse e selecionar a opção Git Commit.
Passo 2: Inserir o comentário e selecionar a opção Commit conforme destacado na imagem abaixo.
Passo 3: Após concluída a atualização do arquivo, selecionar a opção Close.
4.6.2. Função Commit & Push
Após modificar um arquivo é possível realizar a função Commit & Push (salvar a versão do arquivo no repositório local criando uma cópia deste no servidor do projeto) realizando os seguintes passos:
Passo 1: Após modificado o arquivo, clicar sobre este com o botão direito do mouse e selecionar a opção Git Commit.
Passo 2: Inserir o comentário e selecionar a opção Commit & Push conforme destacado na imagem abaixo.
Passo 3: Após concluída a atualização do arquivo, selecionar a opção Close.
4.6.3. Função Push
Após modificar um arquivo uma ou várias vezes realizando o Commit de cada versão no repositório local, é possível realizar a função Commit & Push (enviar a(s) versão(ões) do arquivo para o servidor do projeto) realizando os seguintes passos:
Passo 1: Clicar sobre o arquivo com o botão direito do mouse e selecionar a opção TortoiseGit + Push.
Passo 2: Será apresentada a janela abaixo, selecionar a opção Ok.
Passo 3: Após concluída a atualização do arquivo, selecionar a opção Close.
4.7. Excluir um documento
Para excluir um documento do repositório, é necessário seguir os seguintes passos:
Passo 1: Clicar com o botão direito sobre o documento desejado e selecionar a opção TortoiseGIT + Delete.
Passo 2: Ao abrir a janela abaixo, selecionar a opção Remove.
Passo 3: Será apresentada a quantidade de arquivos que foram removidos, confirmar mensagem clicando sobre a opção Ok.
Passo 4: Após excluir um arquivo do diretório em que se encontra, com o botão direito do mouse sobre a pasta que teve o arquivo excluído, selecionar a opção Git Commit.
Passo 5: Verificar se o arquivo excluído aparece marcado na lista, inserir um comentário que justifique o motivo da exclusão do documento em questão e clicar sobre o botão Commit & Push.
Passo 6: Aguardar a conclusão da exclusão realizada e em seguida clicar sobre a opção Close.
4.8. Renomear um documento
Para renomear um arquivo no servidor do projeto sem perder seu histórico, é necessário seguir os seguintes passos:
Passo 1: Com o botão direito do mouse sobre o arquivo desejado, selecionar a opção TortoiseGit + Rename.
Passo 2: Na janela apresentada, editar o nome do arquivo conforme desejado e selecionar a opção Ok.
Passo 3: Após editado o nome do arquivo, clicar sobre este com o botão direito do mouse e selecionar a opção Git Commit.
Passo 4: Inserir o comentário e selecionar a opção Commit & Push. Observe que o arquivo em questão estará marcado e com Status “Rename”.
Passo 5: Aguardar a atualização do nome do arquivo no servidor e em seguida clicar sobre a opção “Close”.
Após renomear um arquivo, para poder visualizar o histórico deste antes da alteração de seu nome, é necessário selecionar a opção Show Whole Project na janela do Show Log, conforme destacado na figura abaixo.
4.9. Função “Clean up”
Caso ocorra algum erro ao tentar realizar o comando Commit, Commit & Push ou Pull, é necessário fechar os documentos em questão caso estejam abertos e realizar o comando Clean up. Esta ação irá limpar todos os bloqueios de gravação sem que você perca sua cópia do documento.
Caso a limpeza falhar, considere marcar demais opções na caixa de diálogo do “Clean up”.
4.10. Visualizar o histórico de versões do documento
Para visualizar o histórico de um documento, é necessário seguir os seguintes passos:
Passo 1: Com o botão direito do mouse sobre o arquivo desejado, selecionar a opção TortoiseGit + Show log.
Passo 2: Será apresentada uma janela com todo o histórico de versões do arquivo em questão.
Passo 3: Caso tenha renomeado um arquivo, para poder visualizar o histórico deste antes da alteração de seu nome, é necessário selecionar a opção Show Whole Project, conforme destacado na figura abaixo. Ou caso deseje visualizar o histórico de todo o repositório, basta selecionar a mesma opção.
4.11. Visualizar um documento em uma versão anterior
Para visualizar um documento em uma versão anterior, basta seguir os seguintes passos:
Passo 1: Com o botão direito do mouse sobre o arquivo desejado, selecionar a opção TortoiseGit + Show log.
Passo 2: Clicar sobre a versão desejada, e no arquivo apresentado abaixo (em Path) clicar com o botão direito do mouse e selecionar a opção Open.
4.12. Comparar as versões de um documento
Para comparar duas versões de um documento, é necessário seguir os seguintes passos.
Passo 1: Caso queira comparar a versão anterior á atual, basta clicar com o botão direito sobre o arquivo desejado e selecionar a opção TortoiseGit + Diff whit previous version. Se desejar comparar uma versão mais antiga, executar o Passo 2.
Passo 2: Caso queira comparar uma versão mais antiga, é necessário com o botão direito sobre o arquivo desejado e selecionar a opção TortoiseGit + Show log.
Passo 3: Clicar sobre a versão desejada, e em seguida clicar duas vezes sobre o arquivo apresentado abaixo (em Path).
4.13. Recuperar uma versão anterior sobrescrevendo a última versão do documento
Para retornar o documento a uma versão anterior sem perder o histórico de alterações, é necessário seguir os seguintes passos:
Passo 1: Com o botão direito do mouse sobre o arquivo desejado, selecionar a opção TortoiseGit + Show log.
Passo 2: Selecionar a versão desejada na lista apresentada e em seguida clicar com o botão direito do mouse sobre o arquivo em Path e selecionar a opção Revert to this revision. Em seguida selecionar a opção Ok.
Passo 3: Posteriormente é necessário realizar o comando Commit & Push para esta ação subir para o servidor, conforme instrução apresentada neste manual.
4.14. Link de um documento
Caso deseje pegar o link que irá dar acesso diretamente a um determinado documento. Siga os seguintes passos:
Passo 1: Acessar o endereço www.fnde.gov.br/repositorio. Será apresentada a lista de repositórios, clicar sobre o repositório desejado.
Passo 2: Ao abrir a página do repositório em questão, selecionar o arquivo desejado.
Passo 3: Será apresentada a seguinte página, por meio da qual é possível ter acesso a algumas informações do documento, conforme destacado na imagem abaixo.
4.15. Link de uma versão específica do documento
Caso deseje pegar o link que irá dar acesso diretamente a uma versão específica de um documento, é necessário seguir os seguintes passos:
Passo 1: Acessar o endereço www.fnde.gov.br/repositorio. Será apresentada a lista de repositórios, clicar sobre o repositório desejado.
Passo 2: Ao abrir a página do repositório em questão, selecionar o arquivo desejado.
Passo 3: Na página apresentada, selecionar a opção History conforme destacado na imagem abaixo.
Passo 4: Serão apresentadas todas as versões do arquivo em questão, para a versão desejada clicar sobre a opção Browse File.
Passo 5: Na tela apresentada será possível copiar o link de duas formas. Uma é copiar o link apresentdo no navegador, que dará acesso à tela apresentada abaixo referente a esta versão específica do documento. Outra forma é clicar com o botão direito do mouse em Download e selecionar a opção Copiar Link/Copiar endereço do link (conforme o navegador utilizado), que dará acesso direto ao download do documento nesta versão específica. Entretanto, é importante saber que ambas as formas remete ao documento nesta versão selecionada, contendo o mesmo número de hash no endereço.
4.16. Link de uma versão específica da branch (a ser informado no Documento de Deploy)
Caso deseje pegar o link que irá dar acesso diretamente a uma versão específica de uma branch, é necessário seguir os seguintes passos:
Passo 1: Acessar o endereço www.fnde.gov.br/repositorio. Será apresentada a lista de repositórios, clicar sobre o repositório desejado e na tela inicial deste clicar sobre a opção Branches.
Passo 2: Selecionar a branch desejada conforme destacado na imagem abaixo.
Passo 3: Na página apresentada, selecionar a opção History.
Passo 4: Serão apresentadas todas as versões da branch em questão, para a versão desejada clicar sobre a opção Browse Files.
Passo 5: Copiar o link apresentado no navegador que dará acesso à tela abaixo, referente a esta versão específica da branch.
