Skip to content

Commit 13ca0e4

Browse files
committed
docs: Adicionar a documentação sobre os **operadores** na seção **Escrevendo commits**.
Foi adicionada a documentação sobre os **operadores** na seção **Escrevendo commits**. Para saber como usá-los, [clique aqui.](https://github.com/kempdec/AutoRelease#operadores)
1 parent fac33d1 commit 13ca0e4

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,8 @@ Veja como usar um arquivo de configuração [clicando aqui.](#configurações)
175175

176176
## Escrevendo commits
177177

178+
### Conventional Commits
179+
178180
O Auto Release usa o padrão do [**Conventional Commits**](https://www.conventionalcommits.org) (com poucas diferenças)
179181
para ler os commits e gerar o release automaticamente.
180182

@@ -194,7 +196,6 @@ Os tipos `feat` e `fix` e o operador `!` funcionam como está descrito em [**Con
194196

195197
- Caso a propriedade `Types` (arquivo) ou `types` (CLI) seja especificada, o primeiro tipo terá o funcionamento de `feat`,
196198
de incrementar a versão `minor` e todos os demais tipos incrementarão a versão `patch`.
197-
- Caso o corpo ou rodapé da mensagem de commit for especificado, somente eles serão utilizados nas notas geradas pelo Auto Release.
198199
- O texto `BREAKING CHANGE:` não é utilizado como sinalizador para quebra de compatbilidade, somente o operador `!`, mas você pode usar os 2 em conjunto.
199200

200201
Exemplo da mensagem de commit:
@@ -218,6 +219,28 @@ de incrementar a versão `minor` e todos os demais tipos incrementarão a versã
218219
Obs.: Somente de exemplo.
219220
```
220221

222+
### Operadores
223+
224+
Você pode utilizar operadores para que o Auto Release trate as suas mensagens de commit de maneira diferente.
225+
Atualmente é possível utilizar somente um operador por vez.
226+
227+
Para utilizar um operador, coloque-o no final do tipo da mensagem de commit e antes do separador : (dois pontos).
228+
229+
Exemplo com o operador `^`:
230+
``` txt
231+
feat^: Essa descrição será ignorada.
232+
233+
Somente esse corpo será adicionado as notas do release.
234+
```
235+
236+
Os operadores disponíveis são:
237+
238+
| **Operador** | **Descrição** |
239+
| ------------ | ------------- |
240+
| `!` | A mensagem de commit traz uma quebra de compatibilidade e a versão `major` deve ser incrementada. |
241+
| `#` | A mensagem de commit deve ser ignorada e não deve ser adicionada as notas do release. |
242+
| `^` | A mensagem de commit deve ter somente o seu corpo adicionado as notas de release, ou seja, a sua descrição deve ser ignorada. |
243+
221244
## Configurações
222245

223246
### Arquivo de configuração

0 commit comments

Comments
 (0)