Precisa de ajuda?

Para a realização do processo de guarda e verificação de qualidade, a TOTVS disponibiliza um serviço de armazenagem de artefatos.

Trata-se de uma ferramenta de controle de versão realizado por meio de um Git.

Controle de Versão

O controle de versão é um sistema que registra as mudanças feitas em um arquivo ou um conjunto de arquivos ao longo do tempo, de forma que seja possível recuperar versões específicas.

O controle de versão permite reverter arquivos ou um projeto inteiro para um estado anterior, comparar mudanças feitas no decorrer do tempo, descobrir quem foi o último a modificar algo que pode estar causando problemas, quem introduziu um bug e quando isso ocorreu, além de muito mais. Usar um controle de versão, normalmente significa que se algo foi danificado ou se arquivos foram perdidos, facilmente será possível reavê-los. Além disso, você pode controlar tudo sem maiores esforços.

Git é um sistema de controle de versão de arquivos. Através dele, podemos desenvolver projetos, onde diversas pessoas podem contribuir simultaneamente, editando e criando novos arquivos e permitindo que os mesmos possam existir sem o risco de suas alterações serem sobrescritas.

Se não houvesse um sistema de versão, imagine o caos quando duas pessoas abrissem um arquivo ao mesmo tempo. Uma das aplicações do Git é justamente permitir que um arquivo possa ser editado ao mesmo tempo por pessoas diferentes. Por mais complexo que isso seja, ele tenta manter tudo em ordem para evitar problemas para os desenvolvedores.

Para o SmartERP Protheus, seguiremos o conceito do Git Flow.

O Git Flow, trata-se de um modelo de organização de branches desenvolvido especialmente para o Git. Por ser primariamente um modelo de organização de branches, isso significa que o Git Flow estabelece algumas regras de nomenclaturas para tipos de branches enquanto, ao mesmo tempo, define o que cada tipo de branch faz. Para referência, segue uma lista dos tipos de branches definidos pelo Git Flow e suas respectivas descrições:

• Branch master - É a branch que contém código em nível de produção, ou seja, o código mais maduro existente na sua aplicação. Todo o código novo produzido eventualmente é juntado com a branch master, em algum momento do desenvolvimento;
• Branch develop - É a branch que contém código em nível preparatório para o próximo deploy. Ou seja, quando features são terminadas, elas são juntadas com a branch develop, testadas (em conjunto, no caso de mais de uma feature), e somente depois as atualizações da branch develop passam por mais um processo para então ser juntadas com a branch master;
• Branches feature/* - São branches no qual são desenvolvidos recursos novos para o projeto em questão. Essas branches tem por convenção nome começando com feature/ (exemplo: feature/new-layout) e são criadas a partir da branch develop (pois um recurso pode depender diretamente de outro recurso em algumas situações) e, ao final, são juntadas com a branch develop;
• Branches hotfix/* - São branches no qual são realizadas correções de bugs críticos encontrados em ambiente de produção, e que por isso são criadas a partir da branch master, e são juntadas diretamente com a branch master e com a branch develop (pois os próximos deploys também devem receber correções de bugs críticos, certo?). Por convenção, essas branches tem o nome começando com hotfix/ e terminando com o próximo sub-número de versão (exemplo: hotfix/2.31.1), normalmente seguindo as regras de algum padrão de versionamento.
• Branches release/* - São branches com um nível de confiança maior do que a branch develop, e que se encontram em nível de preparação para ser juntada com a branch master e com a branch develop (para caso tenha ocorrido alguma correção de bug na branch release/* em questão). Note que, nessas branches, bugs encontrados durante os testes das features que vão para produção podem ser corrigidos mais tranquilamente, antes de irem efetivamente para produção. Por convenção, essas branches tem o nome começando com release/ e terminando com o número da próxima versão do software (seguindo o exemplo do hotfix, dado acima, seria algo como release/2.32.0), normalmente seguindo as regras do versionamento semântico, como mencionado acima.

O processo de trabalho ficaria assim:

Image Removed

$ git clone usuario:senha@endereço do git

$ git flow init

$ git flow feature start testebranch

$ cd src
$ touch teste.prw
$ git add .
$ git commit -m "Criado cadastro de usuarios"

$ git flow feature finish cadastro-usuarios

$ git flow release start 1.0.0

$ git flow release finish 1.0.0

Instalação

O Git pode ser instalado tanto via linha de comando como por meio de download. Para obter o Git em sua máquina confira o passo a passo neste link: https://git-scm.com/book/pt-br/v1/Primeiros-passos-Instalando-Git

Configurando o usuário Git

Nesta etapa vamos configurar o nome de usuário e e-mail que o Git irá utilizar sempre que realizarmos uma alteração em um arquivo de código fonte, estes dados serão importantes no futuro, pois dentro do processo de submeter um código fonte para aprovação e aplicação em um ambiente, o responsável por esta avaliação irá checar estas informações.

Para concluir esta etapa de configuração, basta executar dois comandos cujo objetivo é informar ao Git qual o nome de usuário da pessoa que está utilizando a ferramenta e qual seu e-mail.

Os comandos devem ser executados em um terminal, caso você esteja utilizando Windows, ao instalar o Git será instalado uma ferramenta de terminal chamada Git Bash.

1. Para abrir o Git Bash, execute o Windows Explorer.
2. Acesse uma pasta de sua preferência.
3. Clique com o botão direito e escolha a opção Git Bash Here.

Image Removed

      4. Com o terminal Git aberto, digite:

$ git config --global user.name "Seu usuário"

$ git config --global user.email "Seu e-mail"

Estas configurações ficam alocadas no arquivo ~/.gitconfig, onde: o ~ é o diretório home.

No Windows, ficam em c:\Usuarios\<username>\.gitconfig.

clone usuario:senha@endereço do git

Exemplo: 

• Usuário: [email protected]
• Senha: asdfgh1234qwert
• Endereço do git: https://git-codecommit.us-east-2.amazonaws.com/v1/repos/smartprotheus-cxxxxxx-repository

$ git clone https://joao.dasilva%40.totvs.com.br:[email protected]/v1/repos/smartprotheus-cxxxxxx-repository

Importante: Temos que converter os caracteres especiais para a decimal, pois os caracteres especiais são entendidos como composto do endereço, neste caso, o @ do e-mail fica %40.

Após clonar o ambiente, será realizado o download de todo conteúdo do cliente salvo no repositório. De padrão temos as seguintes pastas/arquivos criados:

Importante: Na criação do repositório remote GIT, automaticamente serão criadas algumas pastas e estas estrutura deve ser mantida. 

Image Added

• src: Pasta que contêm todos os fontes (.prw) e includes (*.ch) customizados, que serão compilados no RPO do ambiente
• protheus_data: Pasta que contêm todos os artefatos customizados que serão atualizados na RootPath(\proteus_data) do ambiente. Este é utilizado caso o cliente queira manter a versão de um artefato mesmo após a atualização do ambiente. Na prática, a cada atualização realizamos a cópia ou substituição de diversos artefatos dentro do volume do cliente e caso o cliente tenha personalizado um artefato atualizável, este será perdido.
• dictionary.json: Arquivo de configuração que contêm todos os projeto do Master Metadata (dicionários) que devem ser aplicados no ambiente
• .git: A pasta .git é uma pasta oculta e não deve ser alterada;

3. Inicializando o Git Flow

Vamos inicializar o Git Flow no nosso repositório:

$ git flow init

Algumas perguntas referentes à nomenclatura serão feitas, recomendo apenas apertar ENTER e não alterar nenhuma configuração aqui.

Image Added

Interessante observar que apenas executando o comando acima já foi criado e feito o checkout para a branch develop.

4. Iniciando uma feature branch

Vamos realizar a criação de uma feature para inclusão de um fonte personalizado:

$ git flow feature start testebranch

Image Added

Após executado o comando acima, vamos entrar na pasta SRC e criar um arquivo teste.prw (apenas para simular o desenvolvimento de uma feature). E após isso vou realizar o commit.

$ cd src
$ touch teste.prw
$ git add .
$ git commit -m "inclusão do fonte para teste da branch"

Image Added

Caso queira realizar o teste do fonte criado dentro do ambiente SmartERP, precisamos empurrar o que comitamos para o repositório remoto. Até este momento, todas as ações efetuadas foram no nosso repositório clonado em nossa maquina, ou seja, o ambiente SmartERP não sabe que existe este novo fonte para compilar e disponibilizar dentro do ambiente.

Para isto temos que utilizar o comando GIT PUSH

Image Added

Após isto, basta acessar o painel TCLOUD, acompanhar a build na aba builds e coletar o endpoint para homologação na aba meus ambientes.

Image Added

Dica: o nome do environment é o mesmo nome da featurebranch criada, ou seja, teremos um endpoint com o nome da featurebranch e o environment do protheus também.

5. Finalizando a feature branch

Agora que já temos nossa feature criada, podemos finalizar a branch e mesclá-la com a develop.

$ git flow feature finish testebranch
$ git push

Image Added

Se você está seguindo o passo a passo, irá notar que o Git Flow abre o editor de texto para que possamos editar algumas coisas:

• Primeira para editar o texto do merge commit relacionado ao merge entre a release branch 1.0.0 e master (texto opcional)

Feito isso seu código está na develop pronto para ir para produção e sem maiores problemas de versionamento.

Para realizar o processo para a master, basta realizar o processo idêntico ao descrito até agora.

Caso tenha alguma dúvida no processo completo (sem gitflow) acesse: 8.1.2. SmartERP Protheus - Promovendo alterações na prática

Baixando um Repositório

Após configurar o usuário e e-mail, pode-se baixar uma cópia local do repositório. 

O primeiro passo é obter as credências e a url para obtenção dos arquivos.

Todos os repositórios para customização do SmartERP Protheus são protegidos e sua cópia somente pode ocorrer mediante o usuário possuir um par de chaves (credencial + senha) que serão utilizados sempre que enviar suas alterações para o servidor.

Em posse do par de chaves e da url utilize o comando git clone:

git clone git.totvs.com/v1/repos/smartprotheus-XXXXXXX-repository

(Este link você poderá coletar diretamente em seu painel de serviços TCLOUD)

Ao executar o git clone, o projeto é "baixado" para a máquina e uma pasta com o nome do projeto é criada.

Comandos iniciais do Git

Com o repositório na máquina, verificaremos quatro comandos iniciais importantíssimos:

$ git add <arquivos...>

Este comando adiciona o(s) arquivo(s) em um lugar que chamamos de INDEX, que funciona como uma área do Git, no qual os arquivos possam ser enviados ao Repositório ERP. É importante saber que ADD não está adicionando um arquivo novo ao repositório, mas sim dizendo que o arquivo (novo ou não) está sendo preparado para entrar na próxima revisão do repositório.

$ git commit -m "comentário qualquer"

Este comando realiza o que chamamos de commit, que significa pegar todos os arquivos que foram adicionados pelo comando add, no INDEX e criar uma revisão com um número e um comentário, que será vista por todos.

$ git push

Push (empurrar) é usado para publicar todos os commits para o repositório ERP. Neste momento, é solicitada a pedido a senha.Push (empurrar) é usado para publicar todos os commits para o repositório ERP. Neste momento, é solicitado um pedido de senha.

$ git status

Exibe o status do repositório atual.

Errei a mensagem do commit, como corrijo?

Imagine que você tenha errado a mensagem que escreveu no commit ou simplesmente queira melhorar a descrição do seu trabalho.

Se você já entregou a mensagem, mas ainda não fez o push das suas modificações para o servidor, pode usar a flag --amend:

$ git commit --amend

O git commit --amend modifica a mensagem do commit mais recente, ou seja, o último commit.

Além de mudar a mensagem do commit, também é possível adicionar ou retirar arquivos. 

O Git cria um commit totalmente novo e corrigido.

$ git branch

$ git branch especifico

$ git checkout específico

$ git checkout -b especifico

$ git log –all

$ git log --graph

Reunindo commits de outra branch

Como liberar as melhorias e novas funcionalidades?

É preciso mesclar o código de uma branch com a branch master.

Em geral, os sistemas de controle de versão têm um comando chamado merge, que permite fazer a junção de uma branch em outra, de maneira automática.

Vamos dizer que temos o seguinte cenário: a master tem os commits A e B.

Então:

1. Cria-se uma branch especifica;
2. Implementa-se uma nova funcionalidade;
3. Realiza-se o commit D;
4. Retorna-se à master, obtém-se o repositório remoto (as mudanças feitas por um outro membro do time);
5. Recebe-se o commit C.

Image Removed

Se estivermos na branch master, podemos fazer o merge das alterações que estão na branch específica da seguinte maneira:

$ git merge especifico

Ao realizar o merge, as alterações da branch especifica são colocadas na branch master e é criado um commit M, apenas para o merge.

O git, até mesmo abre um editor de texto para que seja possível definir a mensagem desse commit de merge.

Os comandos git log --graph ou gitk exibem o gráfico de commits da master:

Image Removed

Para normalizarmos os nomes das branches, convencionaremos a utilização da seguinte sintaxe:

$ git checkout -b feature/nova_branch

Processo de Inovação no ambiente SmartERP

Para iniciar um processo de personalização dentro do ambiente do cliente, deve-se primeiramente, criar uma referência do projeto do cliente na máquina local do desenvolvedor. Para isto, clona-se o repositório com o seguinte comando:

$ git clone https://repositorio_do_cliente.totvs.com.br (este link será fornecido pelo cliente no início do projeto)

Após, será solicitado o usuário e senha do repositório, que devem ser fornecidos pelo cliente.

Feita a clonagem do repositório do cliente, deve-se criar uma nova branch de trabalho, para isto devemos utilizar os seguintes comandos:

$ git checkout -b feature/minha-inovacao

O nome da branch deve seguir o conceito do projeto que será executado dentro do cliente. Recomendamos separar o projeto por frente de trabalho, em ciclos pequenos de desenvolvimento. Desta forma, a promoção das personalizações fica mais simples.

A partir deste ponto, o desenvolvedor irá codificar as personalizações solicitadas pelo cliente em máquina local.

Como o desenvolvimento poderá demorar, é recomendável que de tempos em tempos seja feita a gravação dos dados dentro da branch criada, pois assim, garantimos que não ocorram inconvenientes como perda de informações e/ou retrabalho.

Para isto, utilizamos os seguintes comandos:

$ git add --all

$ git commit -m "Descricao da alteracao"

$ git push origin feature/minha-inovacao

Estes comandos servem para "empurrar os artefatos para dentro da branch e, com isto, o robô de análise de código entrará em ação para avisar sobre qualquer ocorrência fora do padrão de desenvolvimento TOTVS.

Neste momento, provisionaremos um ambiente de desenvolvimento para a branch criada, para que o desenvolvedor realize a homologação das personalizações realizadas.

• Aprender mais sobre o Git
• Ciclo de Vida
• Como fazer pesquisas no TDN
• FAQs do produto
• Protheus 12
• Tecnologia TOTVS - TOTVSTEC

...