You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-1Lines changed: 24 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -175,6 +175,8 @@ Veja como usar um arquivo de configuração [clicando aqui.](#configurações)
175
175
176
176
## Escrevendo commits
177
177
178
+
### Conventional Commits
179
+
178
180
O Auto Release usa o padrão do [**Conventional Commits**](https://www.conventionalcommits.org) (com poucas diferenças)
179
181
para ler os commits e gerar o release automaticamente.
180
182
@@ -194,7 +196,6 @@ Os tipos `feat` e `fix` e o operador `!` funcionam como está descrito em [**Con
194
196
195
197
- Caso a propriedade `Types` (arquivo) ou `types` (CLI) seja especificada, o primeiro tipo terá o funcionamento de `feat`,
196
198
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.
198
199
- O texto `BREAKING CHANGE:` não é utilizado como sinalizador para quebra de compatbilidade, somente o operador `!`, mas você pode usar os 2 em conjunto.
199
200
200
201
Exemplo da mensagem de commit:
@@ -218,6 +219,28 @@ de incrementar a versão `minor` e todos os demais tipos incrementarão a versã
218
219
Obs.: Somente de exemplo.
219
220
```
220
221
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. |
0 commit comments