79 lines
2.6 KiB
Markdown
79 lines
2.6 KiB
Markdown
# Instrucciones para el uso de `tea` CLI
|
|
|
|
Este proyecto utiliza `tea` para interactuar con el repositorio de Gitea.
|
|
|
|
## Crear un Issue (Modo no Interactivo)
|
|
|
|
Para crear un nuevo issue de forma no interactiva, se utiliza el siguiente comando, proporcionando todos los datos necesarios mediante flags:
|
|
|
|
```bash
|
|
tea issue create --title "Título del Issue" --description "Descripción detallada del issue." --labels "etiqueta1,etiqueta2"
|
|
```
|
|
|
|
- `--title`: Especifica el título del issue.
|
|
- `--description`: Especifica la descripción o cuerpo del issue.
|
|
- `--labels`: Especifica una o más etiquetas separadas por comas.
|
|
|
|
---
|
|
|
|
## Comentar en un Issue
|
|
|
|
Para agregar un comentario a un issue existente, se utiliza el comando `comment` seguido del número del issue y el texto del comentario entre comillas.
|
|
|
|
**Formato correcto:**
|
|
```bash
|
|
tea comment <NÚMERO_ISSUE> "Tu comentario aquí"
|
|
```
|
|
**Ejemplo:**
|
|
```bash
|
|
tea comment 3 "Comentario de prueba"
|
|
```
|
|
|
|
**Nota:** No se deben utilizar flags como `-i` o `--message`. El formato es directo.
|
|
|
|
---
|
|
|
|
## Realizar Commits
|
|
|
|
Debido a problemas de interpretación de comillas en el shell de ejecución, el uso de `git commit -m "mensaje"` puede fallar. Para evitar estos problemas, se debe pasar el mensaje del commit a través de la entrada estándar (`stdin`).
|
|
|
|
### Método Recomendado
|
|
|
|
Utiliza el comando `echo` y una tubería (`|`) para enviar el mensaje a `git commit -F -`.
|
|
|
|
**Commit de una sola línea:**
|
|
```bash
|
|
echo "feat(scope): Tu mensaje de commit conciso" | git commit -F -
|
|
```
|
|
|
|
**Commit multilínea:**
|
|
Para mensajes de commit multilínea, la forma más segura es usar `printf` que maneja mejor los saltos de línea (`\n`):
|
|
```bash
|
|
printf "feat(scope): Título del commit\n\nCuerpo del mensaje con una descripción más detallada.\n\n- Un punto importante.\n- Otro punto importante.\n\nResolves: #123" | git commit -F -
|
|
```
|
|
Esto asegura que el formato del mensaje del commit se preserve correctamente.
|
|
|
|
---
|
|
|
|
## Contexto del Proyecto
|
|
|
|
Al iniciar cada sesión de trabajo, es **mandatorio** leer los siguientes documentos para comprender el contexto completo de los requerimientos y el diseño técnico:
|
|
|
|
- `documents/requirements/RequerimientoInicial.md`
|
|
- `documents/requirements/ToBeDesing.md`
|
|
|
|
## Levantamiento de la Instancia de Odoo 18
|
|
|
|
Para levantar la instancia efímera de Odoo 18 junto con la base de datos de PostgreSQL, se utiliza Docker Compose.
|
|
|
|
**Comando:**
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
Este comando levantará los servicios definidos en el archivo `docker-compose.yml` en modo "detached" (`-d`), lo que significa que se ejecutarán en segundo plano.
|
|
|
|
Para detener los servicios, utiliza:
|
|
```bash
|
|
docker-compose down
|
|
``` |