@cristian.aragao/milharis-core 1.30.59 → 1.30.61

package/README.md

@@ -7,10 +7,25 @@ Este pacote é publicado no npm e segue a convenção de Semantic Versioning par
 ## 📦 Instalação
 Este projeto deve usar npm para instalação e publicação.
 
+**Versão do Node.js:** Este projeto foi criado com Node.js versão `v20.19.0` (gerenciado via nvm).
+
 ```bash
 npm install
 ```
 
+## 🚀 Comandos de Deploy
+**IMPORTANTE:** Use sempre `npm` para os comandos de deploy, não `yarn`:
+
+```bash
+# ✅ Correto
+npm run deploy:fix "Correção de bug"
+npm run deploy:feat "Nova funcionalidade"  
+npm run deploy:break "Breaking change"
+
+# ❌ Incorreto
+yarn deploy:fix "Correção de bug"
+```
+
 ## 🚀 Scripts Disponíveis
 
 Os scripts definidos no package.json são usados para construir, testar e publicar novas versões da biblioteca.
@@ -39,7 +54,7 @@ Ideal rodar antes de qualquer commit importante.
 Publica uma nova versão major (X.0.0).
 
 ```bash
-npm run deploy:break
+npm run deploy:break "Refatoração completa da API"
 ```
 📌 Quando usar:
 
@@ -51,6 +66,8 @@ APIs removidas ou alteradas de forma que quebrem implementações existentes.
 
 - Roda os testes (jest).
 - Compila o projeto (tsup).
+- Commita suas mudanças com a mensagem fornecida.
+- Faz push para o repositório.
 - Incrementa a versão major (npm version major).
 - Publica no npm (npm publish).
 
@@ -58,7 +75,7 @@ APIs removidas ou alteradas de forma que quebrem implementações existentes.
 Publica uma nova versão minor (X.Y.0).
 
 ```bash
-npm run deploy:feat
+npm run deploy:feat "Adiciona nova funcionalidade X"
 ```
 📌 Quando usar:
 
@@ -66,9 +83,12 @@ Novas funcionalidades compatíveis com versões anteriores.
 
 Alterações que não quebram código existente.
 
-Fluxo:
-- Testes (jest).
-- Build (tsup).
+#### Passos executados automaticamente:
+
+- Roda os testes (jest).
+- Compila o projeto (tsup).
+- Commita suas mudanças com a mensagem fornecida.
+- Faz push para o repositório.
 - Incrementa a versão minor (npm version minor).
 - Publica no npm (npm publish).
 
@@ -76,16 +96,19 @@ Fluxo:
 Publica uma nova versão patch (X.Y.Z).
 
 ```bash
-npm run deploy:fix
+npm run deploy:fix "Correção de bug na validação"
 ```
 📌 Quando usar:
 
 - Correções de bugs.
 - Ajustes pequenos que não adicionam novas funcionalidades.
 
-Fluxo:
-- Testes (jest).
-- Build (tsup).
+#### Passos executados automaticamente:
+
+- Roda os testes (jest).
+- Compila o projeto (tsup).
+- Commita suas mudanças com a mensagem fornecida.
+- Faz push para o repositório.
 - Incrementa a versão patch (npm version patch).
 - Publica no npm (npm publish).
 
@@ -99,23 +122,56 @@ O projeto segue Semantic Versioning no formato:
 - PATCH: Correções e melhorias internas.
 
 ## 🛠 Fluxo de Publicação
-Certifique-se de estar na branch principal (main ou master).
 
-Atualize seu código e garanta que todos os testes passam:
+### Deploy Automatizado
+O projeto possui scripts de deploy que automatizam todo o processo:
 
 ```bash
-npm test
+# Para correções (patch)
+npm run deploy:fix "Correção de bug na validação"
+
+# Para novas funcionalidades (minor)  
+npm run deploy:feat "Adiciona nova funcionalidade X"
+
+# Para mudanças que quebram compatibilidade (major)
+npm run deploy:break "Refatoração completa da API"
 ```
-Escolha o tipo de release:
-- Quebra de compatibilidade → npm run deploy:break
-- Nova feature compatível → npm run deploy:feat
-- Correção → npm run deploy:fix
 
-Após rodar o script:
+⚠️ **IMPORTANTE:** A mensagem de commit é obrigatória! Sem ela, o deploy falhará.
+
+### O que acontece automaticamente:
 
-A versão será atualizada automaticamente no package.json.
+1. **Executa testes** - Se algum teste falhar, o processo para
+2. **Faz build** - Compila o TypeScript para JavaScript
+3. **Commit automático** - Pega todas as mudanças e commita com sua mensagem
+4. **Push automático** - Envia para o repositório (incluindo tags de versão)
+5. **Incrementa versão** - Atualiza package.json automaticamente
+6. **Publica no npm** - Faz o publish automaticamente
 
-Um commit e uma tag serão criados.
+### Fluxo Manual (se necessário):
+
+```bash
+# 1. Testar
+npm test
+
+# 2. Build
+npm run build
+
+# 3. Commit manual
+git add .
+git commit -m "Sua mensagem"
+git push
+
+# 4. Incrementar versão
+npm version patch  # ou minor/major
+
+# 5. Publicar
+npm publish
+```
 
-O pacote será enviado para o npm registry.
+### ⚠️ Importante:
+- Certifique-se de estar na branch principal (main)
+- Todos os testes devem passar antes do deploy
+- **A mensagem de commit é obrigatória** - sem ela o deploy falhará
+- A mensagem de commit será usada para descrever as mudanças