Diferenças

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

--- pres:gerti:devops:informacoes:nomenclatura_commits [19/04/2026 22:18] – criada lvinicius
+++ pres:gerti:devops:informacoes:nomenclatura_commits [20/04/2026 11:42] (atual) – [Automatizar o versionamento] lvinicius
@@ Linha 1: / Linha 1: @@
-===== # Nomenclatura dos Commits =====
+====== 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.
+Este artigo descreve o padrão que adotamos para realizar a nomenclatura dos commits em 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]].
+Adotamos o padrão [[https://www.conventionalcommits.org/pt-br/v1.0.0/|Conventional Commits]], o qual inicia o commit com um prefixo como ''%%fix:%%'', ''%%feat:%%'', ''%%docs:%%'' para identificar o tipo da mudança.
+Para mais informações, veja também o [[https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md|Guia de Commits do Angular]] que também usa o [[https://www.conventionalcommits.org/pt-br/v1.0.0/|Conventional Commits]].
 ===== Objetivos =====
@@ Linha 12: / Linha 14: @@
   * Padronizar a comunicação entre a equipe
-==== Automação do versionamento ====
+==== Automatizar o 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 [[pres:gerti:devops:informacoes:versionamento_semantico|Versionamento Semântico]].
+É importante utilizar esse padrão pois os repositórios possuem (devem possuir) um [[https://gitsource.tce.go.gov.br/GER-TI/tce.kubernetes/tce.templates/-/tree/main/templates/versioning|Job de Versionamento]] na Pipeline de CI/CD. Esse job lê o nome dos commits e gera automaticamente a tag da versão do repositório no padrão de [[:pres:gerti:devops:informacoes:versionamento_semantico|]].
-===== Como funciona? =====
+{{:pres:gerti:devops:informacoes:20260420083356.png?nolink&1281x183}}
-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: ''%%fix(versioning): corrige output do NEXT_VERSION%%''.
-  - 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 ''%%fix%%'', e criou uma nova tag nesse commit. A tag anterior era ''%%3.0.0%%'', então ele aumentou para ''%%3.0.1%%''.
-  - 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 =====
@@ Linha 34: / Linha 29: @@
 </code>
-  * ''%%<tipo>%%'': Obrigatório. Refere-se ao tipo da alteração: se ele corrige um bug é um ''%%fix%%'', se adiciona um feature, é um ''%%feat%%''. Veja: [[#Quais%20Tipos%20de%20Commits%20existem?|Quais Tipos de Commits existem?]]
+  * ''%%<tipo>%%'': **Obrigatório.** Refere-se ao tipo da alteração: se ele corrige um bug é um ''%%fix%%'', se adiciona um feature, é um ''%%feat%%''. Veja: [[#Quais%20Tipos%20de%20Commits%20existem?|Quais Tipos de Commits existem?]]
-  * ''%%<escopo opcional>%%'': Opcional. Descreve qual módulo do sistema foi alterado
+  * ''%%<escopo opcional>%%'': **Opcional.** Descreve qual módulo do sistema foi alterado
-  * ''%%<descrição>%%'': Descrição do o que o seu commit faz. Inicie sempre com verbos no **presente do indicativo**, ex.: ''%%corrige%%'', ''%%altera%%'', ''%%implementa%%'', ''%%refatora%%'', ''%%adiciona%%''.
+  * ''%%<descrição>%%'': **Obrigatório.** Descrição do o que o seu commit faz. Inicie sempre com verbos no **presente do indicativo**, ex.: ''%%corrige%%'', ''%%altera%%'', ''%%implementa%%'', ''%%refatora%%'', ''%%adiciona%%''.
+  * ''%%[#<task redmine>]%%'': **Opcional.** Este é o ID da task do Redmine caso seu commit esteja relacionado. Ex: ''%%#39042%%''
 ==== Quais Tipos de Commits existem? ====
@@ Linha 60: / Linha 56: @@
 ^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.2.5       |feat: Adiciona comando de pull para baixar novas páginas #37093   |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  |
+===== 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: ''%%fix(versioning): corrige output do NEXT_VERSION%%''.
+  - 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 ''%%fix%%'', e criou uma nova tag nesse commit. A tag anterior era ''%%3.0.0%%'', então ele aumentou para ''%%3.0.1%%''.
+  - 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.
 ===== Dica: Iniciar descrição do commit com o presente do indicativo =====