Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- pres:gerti:devops:informacoes:nomes_commits [19/04/2026 21:32] – lvinicius
+++ pres:gerti:devops:informacoes:nomes_commits [19/04/2026 22:17] (atual) – removida lvinicius
@@ Linha 1: / Linha 1: @@
-===== Nomenclatura dos Commits =====
-Adotamos o padrão [[https://www.conventionalcommits.org/pt-br/v1.0.0/|Conventional Commits]] para nomear os commits de nossos projetos.
-Também nos inspiramos no [[https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md|Guia de Commits do Angular]].
-===== Objetivos =====
-  * Automatizar o versionamento de nossos projetos
-  * Automatizar a geração do Changelog
-  * Tornar o histórico de commits mais legível
-  * Padronizar a comunicação entre a equipe
-==== Automação do versionamento ====
-É importante que usemos esse padrão pois o [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/tree/main/templates/versioning|Job de Versionamento]] das Pipelines de CI/CD lê os nomes dos commits e gera a tag da próxima versão, usando o padrão de [[https://semver.org/|Versionamento Semântico]].
-===== Como funciona? =====
-Exemplo com este [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/commit/57a578138253f7e1c5c1382984234c9d1b269daf|commit]] feito no [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates|TCE.Pipelines]]:
-  - Encontrei um bug no Job de Versionamento.
-  - Corrigi o erro em minha máquina, testei e estou pronto para commitar.
-  - Como a alteração é uma **correção de bug**  no módulo **versioning**, o commit se chamou: ''<nowiki>fix(versioning): corrige output do NEXT_VERSION</nowiki>''.
-  - Fiz push. No Gitlab, o Job de Versionamento [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/jobs/23380|leu o nome do commit]] entendeu que é um ''<nowiki>fix</nowiki>'', e criou uma nova tag nesse commit. A tag anterior era ''<nowiki>3.0.0</nowiki>'', então ele aumentou para ''<nowiki>3.0.1</nowiki>''.
-  - Após isso, o [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/tree/main/templates/versioning|Job de Versionamento]] também gerou um [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/releases#3.0.1|changelog]] com as alterações.
-===== Sintaxe dos Commits =====
-Esta é a sintaxe dos commits que o [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/tree/main/templates/versioning|Job de Versionamento]] está configurado para entender
-<code>
-<tipo>(<escopo opcional>): <descrição> [#<task redmine>]
-</code>
-  * ''<nowiki><tipo></nowiki>'': Obrigatório. Refere-se ao tipo da alteração: se ele corrige um bug é um ''<nowiki>fix</nowiki>'', se adiciona um feature, é um ''<nowiki>feat</nowiki>''. Veja: [[#quais_20tipos_20de_20commits_20existem|Quais Tipos de Commits existem]]
-  * ''<nowiki><escopo opcional></nowiki>'': Opcional. Descreve qual módulo do sistema foi alterado
-  * ''<nowiki><descrição></nowiki>'': Descrição do o que o seu commit faz. Inicie sempre com verbos no **presente do indicativo**, ex.: ''<nowiki>corrige</nowiki>'', ''<nowiki>altera</nowiki>'', ''<nowiki>implementa</nowiki>'', ''<nowiki>refatora</nowiki>'', ''<nowiki>adiciona</nowiki>''.
-==== Quais Tipos de Commits existem? ====
-Para o campo ''<nowiki><tipo></nowiki>'', há as seguintes opções:
-^Tipo  ^Descrição  ^Versão  ^Roda a pipeline?|
-|**build**   |Mudanças que afetam o sistema de build (Dockerfile) ou dependências externas (requirements.txt)|Não altera  |Sim  |
-|**ci**   |Alterações na pipeline de CI/CD  |Não altera  |Sim  |
-|**docs**   |Alterações na Documentação  |Não altera  |Não  |
-|**feat**   |Um feature novo (alterações que adicionam funcionalidade)  |Aumenta a Minor|Sim  |
-|**fix**   |Uma correção de bug (alteração que corrige funcionalidade)  |Aumenta o Patch|Sim  |
-|**perf**   |Uma mudança no código que melhora a performance  |Aumenta a Minor|Sim  |
-|**refactor** |Uma mudança de código que nem corrige bugs, nem adiciona features. Apenas Refatoração.  |Não altera  |Sim  |
-|**test**   |Adição de novos testes ou correção de testes existentes  |Não altera  |Sim  |
-> **Dica:**  Commits que começam ''<nowiki>docs:</nowiki>''  não disparam a pipeline. Caso não queria disparar a pipeline, pode usá-lo.
-===== Exemplos =====
-Veja como exemplo um histórico de commits de um projeto fictício para entender como que
-^Versão Atual^Nome do Commit  ^Nova Versão^Tipo de Alteração  |
-|1.2.4  |fix: Corrige a formatação do parser markdown  |1.2.5  |Altera a versão de Patch|
-|1.2.5  |feat: Adiciona comando de pull para baixar novas páginas  |1.3.0  |Altera a versão Minor  |
-|1.3.0  |docs(comandos): Cria sessão explicando como usar o comando de pull|1.3.0  |Versão se mantem igual  |
-===== Dica: Iniciar descrição do commit com o presente do indicativo =====
-Por convenção, inicie a **Descrição**  do commit com **verbos no presente do indicativo**. A descrição deve indicar o que o commit **faz**. Exemplos:
-  * fix: **corrige**  a formatação do parser markdown
-  * feat: **adiciona**  comando de pull para baixar novas páginas
-A intenção é facilitar a leitura do histórico de commits, e dos changelogs.
-====== Mais informações ======
-Para informações completas da sintaxe dos commits e versionamento semântico: [[https://semver.org/|Versionamento Semântico]] e [[https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md|guia de commits do Angular]].