Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion PLAN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Hoja de ruta priorizada. Fechada el 24/10/2026 y actualizada el 26/10/2026. Las

## Siguiente (por orden)
1. **Alberto**: fusionar el PR, crear la release `v0.8.0` con las notas del CHANGELOG y mover `v1` a ella (la Action es compatible: mismas entradas, salida y SVG byte a byte).
2. **Alberto**: activar «Private vulnerability reporting» en Settings → Security (lo enlaza `SECURITY.md`).
2. ~~**Alberto**: activar «Private vulnerability reporting»~~ Hecho (comprobado activo el 26/10/2026).
3. Tras el despliegue: abrir https://bertmarti.github.io/commitling/ con la consola abierta y comprobar que no hay violaciones de CSP (demo, generador con un usuario y descarga).
4. Publicar la Action en el Marketplace si aún no lo está (nombre `commitling`, branding ya declarado).
5. Subir la línea `go` de `go.mod` con cada parche de Go (y el mínimo de `TestGoModPinsAPatchedGo`) (govulncheck en el CI avisará).
Expand Down
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ En la [web](https://bertmarti.github.io/commitling/#generador) escribes tu usuar

¿Sin usuario a mano? Pulsa **«Ver demo: míralo crecer»**: en unos 15 segundos verás a una criatura de ejemplo pasar de semilla a árbol, con pausa, parada y un control para recorrer los días. No pide nada a GitHub.

En la cabecera, bajo los enlaces, eliges el tema de la web: **Sistema**, **Claro** u **Oscuro**. Cambia la página y todas las tarjetas al momento, y tu navegador lo recuerda para la próxima visita.

> Sin iniciar sesión, GitHub deja hacer unas 60 consultas por hora. Si se agotan, la web te dice a qué hora vuelve a funcionar y te ofrece la demo mientras tanto. La Action de tu perfil no tiene ese límite.

## Úsalo en tu perfil en 4 pasos
Expand Down Expand Up @@ -90,7 +92,7 @@ jobs:

No hace falta tocar nada más: la línea `permissions: contents: write` deja que el workflow guarde la imagen en tu repositorio con un token temporal que GitHub crea en cada ejecución, y la Action usa como usuario al dueño del repositorio.

¿Tienes Go instalado y prefieres la terminal? `go run github.com/BertMarti/commitling/cmd/commitling@latest workflow --user tu-usuario --theme both` escribe el mismo archivo (con `--theme both`, claro y oscuro).
¿Tienes Go instalado y prefieres la terminal? Desde la versión 0.8.0, `go run github.com/BertMarti/commitling/cmd/commitling@latest workflow --user tu-usuario --theme both` escribe el mismo archivo (con `--theme both`, claro y oscuro).

## Opciones

Expand Down Expand Up @@ -131,6 +133,9 @@ Las tres especies son originales y tienen las mismas reglas, fases, ánimos y ac

`species` también acepta `musgo`, `hongo` y `seta`, sin distinguir mayúsculas.

> [!IMPORTANT]
> **El cactus llega a la Action con la versión 0.8.0, que aún no está publicada.** Hasta entonces `@v1` es la v0.7.0, que solo conoce el brote de musgo y el hongo: con `species: cactus` el workflow sale en rojo con «especie no válida». En la [web](https://bertmarti.github.io/commitling/#generador) ya puedes ver el cactus con tu usuario y descargar su SVG.

### Tarjeta compacta

Para una firma, una barra lateral o una cabecera, usa una insignia de 200x60:
Expand Down Expand Up @@ -261,6 +266,20 @@ No. Es un diseño original, dibujado píxel a píxel para este proyecto.
Usa `BertMarti/commitling@v1` para recibir mejoras compatibles. Si quieres fijar una versión concreta, usa una etiqueta exacta (por ejemplo `@v0.7.0`) o el SHA de un commit. Evita `@main`: es la rama de desarrollo.
</details>

## Lo que tienes que hacer tú (mantenedor)

Esto es solo para Alberto, que publica las versiones:

1. **Publicar la v0.8.0 y mover `v1` a ella.** Desde un clon con `main` al día (las notas salen del `CHANGELOG.md`):

```bash
gh release create v0.8.0 --repo BertMarti/commitling --target main --title "v0.8.0 · Blindada" --notes "$(awk '/^## \[0.8.0\]/{f=1;next} /^## \[0.7.0\]/{f=0} f' CHANGELOG.md)"
git fetch --tags && git tag -f v1 v0.8.0 && git push -f origin v1
```

Es compatible con la v0.7.0 (mismas entradas, misma salida y las tarjetas del musgo y del hongo idénticas), así que los perfiles que usan `@v1` siguen igual y ganan el cactus y los mensajes de error nuevos. Opcional, **antes** de la release: activar el binario precompilado (pasos en la [guía de desarrollo](docs/DESARROLLO.md#binario-precompilado-preparado-inactivo-hasta-una-release)).
2. **Después**, quitar el aviso «El cactus llega a la Action con la versión 0.8.0» de este README, de la guía de uso (`docs/USO.md`, apartado de especies) y de la web (`internal/gallery/index.html.tmpl`, sección «Instálalo en tu perfil»), y el «Desde la versión 0.8.0» de la orden `go run`.

## Privacidad

commitling solo usa la API pública de eventos de GitHub. No lee repositorios privados, no guarda datos fuera de tu repositorio y no necesita más permisos que el `GITHUB_TOKEN` de tu propio workflow.
Expand Down
2 changes: 2 additions & 0 deletions docs/USO.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,8 @@ Valores que acepta `species` (sin distinguir mayúsculas ni espacios alrededor):

Cualquier otro valor (por ejemplo `dragon`) hace fallar el paso a propósito, con el mensaje `especie no válida "dragon" (usa moss, mushroom o cactus)`, para que un error tipográfico no pase desapercibido, y no escribe ningún archivo. Puedes ver todas las fases de las tres especies en la [galería](https://bertmarti.github.io/commitling/#galeria).

> **Ojo:** el cactus llega a la Action con la versión 0.8.0, que aún no está publicada. Mientras `@v1` siga en la v0.7.0, `species: cactus` falla con «especie no válida» (la v0.7.0 solo conoce `moss` y `mushroom`). En la web y en la CLI compilada desde `main` ya funciona.

¿Varias a la vez? Sí: usa la Action dos veces con `out` distinto (por ejemplo `commitling.svg` y `commitling-hongo.svg`, cada uno con su `species`), suma el segundo archivo al `git add` y enseña la imagen que quieras en el README.

### Elegir el tamaño: tarjeta compacta
Expand Down
1 change: 1 addition & 0 deletions internal/gallery/index.html.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@
<div class="opts">{{range $i, $c := .GenSpecies}}
<div class="opt"><input type="radio" name="ins-species" value="{{$c.Value}}" id="ins-sp-{{$c.Value}}"{{if eq $i 0}} checked{{end}}><label for="ins-sp-{{$c.Value}}">{{$c.Label}}</label></div>{{end}}
</div>
<p class="note hint">El cactus llega a la Action con la versión 0.8.0, aún sin publicar: hasta entonces, un workflow con el cactus sale en rojo con «especie no válida». El brote de musgo y el hongo funcionan ya.</p>
</fieldset>
<fieldset>
<legend>Tema</legend>
Expand Down
Loading