diff --git a/CHANGELOG.md b/CHANGELOG.md index 18af17e..f3fdb19 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,11 @@ El formato sigue [Keep a Changelog](https://keepachangelog.com/es-ES/1.1.0/) y e ## [Sin publicar] +### Cambiado + +- Con la v1.0.0 publicada y `v1` apuntando a ella, el README, la guía de uso y la web dejan de avisar de que el cactus y `go run …@latest workflow` necesitan una versión aún sin publicar, y los ejemplos de versión exacta pasan a `@v1.0.0`. +- `release/checksums.txt` sale de `main`: describe los binarios de la v1.0.0 ya publicada (va en su etiqueta) y no los de `main`, que ha cambiado. La próxima versión lo vuelve a generar en su commit. + ## [1.0.0] - 2026-10-26 Primera versión estable (la 0.8.0 preparada nunca se publicó: todo sale aquí). Reúne todo lo hecho desde la v0.7.0: las fases de seguridad y documentación, la instalación guiada paso a paso, la tercera especie cactus, el selector de tema de la web y el binario precompilado. **La interfaz de `action.yml` no cambia** (mismas entradas, misma salida `path`, mismos archivos) y las tarjetas SVG del brote de musgo y del hongo son byte a byte las de v0.7.0 (las 96 huellas de v0.5.0 pasan). Quien usa `BertMarti/commitling@v1` la recibe sin tocar nada. diff --git a/MEMORY.md b/MEMORY.md index 1a1ee1b..7c6027d 100644 --- a/MEMORY.md +++ b/MEMORY.md @@ -2,6 +2,8 @@ Última actualización: 2026-10-26 por Claude Code (Opus 5.5, jefe de la fase 5, rama `v1-2026-10-26`) ## Estado actual +**Tras publicar la v1.0.0 (rama `v1-tras-publicar`, se fusiona después de la release y de mover `v1`)**: sin avisos de «aún no publicada» (README, `docs/USO.md`, web), ejemplos de versión exacta `@v1.0.0` y sin `release/checksums.txt` en `main` (va en la etiqueta v1.0.0; regenerarlo con la misma versión daría SHA-256 distintos de los subidos porque la plantilla embebida cambió). `@main` compila siempre con Go. + **Versión 1.0.0 (fase 5, 26/10/2026, rama `v1-2026-10-26`, PR contra `main`)**: la 0.8.0 nunca se publicó y se salta: todo lo de las fases 1 a 4 sale como **v1.0.0** (CLI, Action, web y docs en 1.0.0; CHANGELOG `[1.0.0] - 2026-10-26`). El commit lleva `release/checksums.txt` de la 1.0.0 (generado tras el último cambio de código; la plantilla de la web va embebida en el binario), así que al publicar la release el workflow «Release» sube los binarios y la Action deja de compilar. Antes de publicarla, el paso `bin` recibe un 404 y compila con Go (probado en el job `binario`, que ahora prueba también la release real). El job `action` fuerza la ruta de `go run` (`COMMITLING_RELEASE_URL` a un puerto cerrado) para que el chequeo del Go parcheado no dependa de si la release existe. Lo que solo es cierto tras publicar está en la rama `v1-tras-publicar` (sin PR): quita los avisos del cactus y del `go run …@latest`, pone los ejemplos `@v1.0.0` y borra `release/checksums.txt`. `v1` sigue en v0.7.0 hasta que el orquestador la mueva. **Fase 3 (25-26/10/2026, rama `fase3-2026-10-25`, PR contra `main`)**: v0.8.0 sigue sin publicar (fases 1 y 2 fusionadas); la fase 3 se suma a sus notas. Tercera especie `cactus` (musgo y hongo byte a byte iguales: galería comparada con `main`, 120 SVG + favicon idénticos; 8 combinaciones de la CLI idénticas), selector de tema de la web (`theme.js`, `commitling:theme`), Trusted Types en la CSP (0 violaciones en Chromium con demo, generador real y criatura en vivo), acciones por SHA y binario precompilado preparado e inactivo (paso `bin` de `action.yml`, `scripts/build-release.sh`, `release.yml`). `action.yml`: mismas entradas, salida y archivos; sin `release/checksums.txt` se comporta igual que antes (salvo `setup-go` fijado por SHA, el mismo código). diff --git a/PLAN.md b/PLAN.md index 0eb0926..92c69b6 100644 --- a/PLAN.md +++ b/PLAN.md @@ -11,7 +11,7 @@ Hoja de ruta priorizada. Fechada el 24/10/2026 y actualizada el 26/10/2026 (vers ## Siguiente (por orden) 1. **Orquestador/Alberto**: fusionar el PR de `v1-2026-10-26`, publicar la release `v1.0.0` desde ese commit (título y notas en el informe de la fase 5) y mover `v1` a ella (orden exacta en el README, «Lo que tienes que hacer tú»). Comprobar que el workflow «Release» sube los 6 binarios y `checksums.txt`. -2. **Orquestador**: abrir el PR de la rama `v1-tras-publicar` (quita los avisos de «aún no publicada», pone los ejemplos `@v1.0.0` y borra `release/checksums.txt`) y fusionarlo. +2. ~~**Orquestador**: PR de la rama `v1-tras-publicar`~~ Hecho: avisos de «aún no publicada» fuera, ejemplos `@v1.0.0` y `release/checksums.txt` borrado de `main`. 3. Tras el despliegue: abrir https://bertmarti.github.io/commitling/ con la consola y comprobar 0 violaciones de CSP/Trusted Types (demo, generador con un usuario real, selector de tema). La primera ejecución del perfil de BertMarti tras mover `v1` no debe tener el paso de `setup-go` (usa el binario). 4. Subir la línea `go` de `go.mod` con cada parche de Go (y el mínimo de `TestGoModPinsAPatchedGo`); govulncheck en el CI avisará. diff --git a/README.md b/README.md index fb57d10..1bfcbbe 100644 --- a/README.md +++ b/README.md @@ -92,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? Desde la versión 1.0.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). +¿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). ## Opciones @@ -133,9 +133,6 @@ 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 1.0.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: @@ -263,22 +260,22 @@ No. Es un diseño original, dibujado píxel a píxel para este proyecto.
¿Qué versión uso? -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. +Usa `BertMarti/commitling@v1` para recibir mejoras compatibles. Si quieres fijar una versión concreta, usa una etiqueta exacta (por ejemplo `@v1.0.0`) o el SHA de un commit. Evita `@main`: es la rama de desarrollo.
## Lo que tienes que hacer tú (mantenedor) Esto es solo para Alberto, que publica las versiones: -1. **Publicar la v1.0.0 y mover `v1` a ella.** Desde un clon con `main` al día (las notas salen del `CHANGELOG.md`): +1. **Publicar una versión nueva** (la guía paso a paso está en `.claude/skills/publicar-version/SKILL.md`). Con el PR de la versión fusionado y `main` al día, cambiando `X.Y.Z` por la versión: ```bash - gh release create v1.0.0 --repo BertMarti/commitling --target main --title "v1.0.0 · Primera versión estable" --notes "$(awk '/^## \[1.0.0\]/{f=1;next} /^## \[0.7.0\]/{f=0} f' CHANGELOG.md)" - git fetch --tags && git tag -f v1 v1.0.0 && git push -f origin v1 + gh release create vX.Y.Z --repo BertMarti/commitling --target main --title "vX.Y.Z · …" --notes "$(awk '/^## \[X.Y.Z\]/{f=1;next} /^## \[/{f=0} f' CHANGELOG.md)" + git fetch --tags && git tag -f v1 vX.Y.Z && 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, los mensajes de error nuevos y el binario precompilado. Al publicar la release, el workflow «Release» sube los binarios (su SHA-256 ya está en `release/checksums.txt`); mientras tanto, o si algo falla, la Action compila con Go como siempre ([guía de desarrollo](docs/DESARROLLO.md#binario-precompilado)). -2. **Después**, fusionar la rama `v1-tras-publicar` (ya preparada): quita el aviso «El cactus llega a la Action con la versión 1.0.0» de este README, de la guía de uso y de la web, y el «Desde la versión 1.0.0» de la orden `go run`. + Mueve `v1` solo si la versión es compatible (mismas entradas y salida de la Action). Si el commit de la versión lleva `release/checksums.txt`, el workflow «Release» sube los binarios precompilados ([guía de desarrollo](docs/DESARROLLO.md#binario-precompilado)). +2. **Opcional:** publicar la Action en el GitHub Marketplace: edita la release en GitHub, marca «Publish this Action to the GitHub Marketplace» y acepta el acuerdo (solo la primera vez). ## Privacidad diff --git a/SECURITY.md b/SECURITY.md index 43a3999..6dd8e5c 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -22,6 +22,6 @@ Respondo en cuanto pueda (proyecto personal, sin plazos garantizados). ## Buenas prácticas para quien usa la Action -- Fíjala a `@v1`, a una versión exacta (por ejemplo `@v0.7.0`) o a un SHA, nunca a `@main`. +- Fíjala a `@v1`, a una versión exacta (por ejemplo `@v1.0.0`) o a un SHA, nunca a `@main`. - Da a tu workflow solo `permissions: contents: write` (lo necesita para guardar el SVG) y nada más. - No hace falta ningún token personal: basta el `GITHUB_TOKEN` del propio workflow. diff --git a/docs/DESARROLLO.md b/docs/DESARROLLO.md index 3f568c2..60ad627 100644 --- a/docs/DESARROLLO.md +++ b/docs/DESARROLLO.md @@ -105,13 +105,13 @@ La entrada de la Action `keep-on-error` está activa por defecto. Si la caída e ## Versiones y GitHub Marketplace - `BertMarti/commitling@v1` sigue la versión mayor 1: la etiqueta móvil `v1` apunta a la última versión compatible y la mueve Alberto al publicar. -- Una etiqueta exacta (`@v0.7.0`) o el SHA de un commit es lo más reproducible. +- Una etiqueta exacta (`@v1.0.0`) o el SHA de un commit es lo más reproducible. - `@main` funciona, pero es la rama de desarrollo; los ejemplos nunca la usan (`TestExamplesUseV1`). - La Action declara nombre, descripción y `branding` (icono `feather`, color `green`) en `action.yml`, que es lo que muestra el Marketplace. **La interfaz de `action.yml` (entradas, salida `path`, archivos y formato del SVG) no se rompe**: hay perfiles que la usan a diario. ## Binario precompilado -Sin binario, la Action compila la CLI con `go run` en cada ejecución. Desde la v1.0.0 usa en su lugar el binario precompilado de la release, **solo** si el árbol de la Action (la etiqueta a la que apunta `@v1`) contiene `release/checksums.txt` y el binario descargado tiene exactamente ese SHA-256. Si falta el archivo, la release aún no tiene binarios, la plataforma no está en la lista, falla la red o el SHA-256 no coincide, la Action compila con Go como siempre (con un aviso en el log); nunca falla por esto. El commit de la v1.0.0 lleva su `release/checksums.txt`, así que entre la fusión y la publicación de la release (y si el workflow «Release» fallara) los perfiles siguen compilando con Go. +Sin binario, la Action compila la CLI con `go run` en cada ejecución. Desde la v1.0.0 usa en su lugar el binario precompilado de la release, **solo** si el árbol de la Action (la etiqueta a la que apunta `@v1`) contiene `release/checksums.txt` y el binario descargado tiene exactamente ese SHA-256. Si falta el archivo, la release aún no tiene binarios, la plataforma no está en la lista, falla la red o el SHA-256 no coincide, la Action compila con Go como siempre (con un aviso en el log); nunca falla por esto. El commit de cada versión (el de la etiqueta) lleva su `release/checksums.txt`; en `main` se borra tras publicarla (ver abajo), así que `@main` compila siempre con Go. - `scripts/build-release.sh ` compila los 6 binarios (Linux, macOS y Windows; amd64 y arm64) de forma **reproducible** (`CGO_ENABLED=0`, `-trimpath`, `-buildvcs=false`, `-buildid=`, la versión exacta de Go de `go.mod`): el mismo código da los mismos bytes en cualquier máquina, así que el SHA-256 se puede subir **antes** de que exista la release. - `--write` copia los SHA-256 a `release/checksums.txt`; `--check` falla si no coinciden. diff --git a/docs/USO.md b/docs/USO.md index c6edf84..937a079 100644 --- a/docs/USO.md +++ b/docs/USO.md @@ -113,7 +113,7 @@ Qué hace este archivo, en cristiano: - `schedule` / `cron`: lo ejecuta solo cada día a las 05:23 UTC (07:23 en el horario de verano de la España peninsular, 06:23 en invierno). GitHub puede retrasar unos minutos las ejecuciones programadas. - `workflow_dispatch`: añade el botón **Run workflow** para lanzarlo a mano. - `permissions: contents: write`: le permite guardar la imagen en tu repositorio. Sin esto fallaría al guardar. -- `BertMarti/commitling@v1`: es la Action de commitling, que crea el archivo `commitling.svg`. `@v1` significa «la versión 1»: recibes las mejoras compatibles sin tocar nada. Si prefieres fijar una versión exacta, usa una etiqueta exacta de las [releases](https://github.com/BertMarti/commitling/releases), por ejemplo `@v0.7.0`. +- `BertMarti/commitling@v1`: es la Action de commitling, que crea el archivo `commitling.svg`. `@v1` significa «la versión 1»: recibes las mejoras compatibles sin tocar nada. Si prefieres fijar una versión exacta, usa una etiqueta exacta de las [releases](https://github.com/BertMarti/commitling/releases), por ejemplo `@v1.0.0`. - El último paso guarda `commitling.svg` en tu repositorio solo si ha cambiado, con un commit «chore: actualiza commitling». ### Paso 3. Añade la imagen a tu README @@ -188,8 +188,6 @@ 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 1.0.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 @@ -329,7 +327,7 @@ En el workflow, la línea `uses: BertMarti/commitling@...` decide qué versión | Escribes | Qué significa | Cuándo usarla | |---|---|---| | `@v1` | La versión mayor 1: la etiqueta `v1` se mueve con cada versión 1.x compatible, así que recibes mejoras y correcciones sin tocar nada | Lo recomendado | -| `@v0.7.0` (o la última de las releases) | Una versión exacta, que nunca cambia | Si quieres controlar tú cuándo actualizas | +| `@v1.0.0` (o la última de las releases) | Una versión exacta, que nunca cambia | Si quieres controlar tú cuándo actualizas | | `@` (huella de un commit) | Una copia exacta del código, la opción más reproducible | Si te importa la máxima seguridad | | `@main` | La rama de desarrollo, que puede cambiar en cualquier momento (y romper tu workflow) | Solo para probar cambios | diff --git a/internal/gallery/index.html.tmpl b/internal/gallery/index.html.tmpl index 185f058..af7e6cb 100644 --- a/internal/gallery/index.html.tmpl +++ b/internal/gallery/index.html.tmpl @@ -235,7 +235,6 @@
{{range $i, $c := .GenSpecies}}
{{end}}
-

El cactus llega a la Action con la versión 1.0.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.

Tema @@ -294,7 +293,7 @@

Elige «Automático» arriba y sustituye tu archivo por el nuevo, o añade un segundo paso con theme: dark y out: commitling-dark.svg (y súmalo al git add). En el README usa:

{{.ReadmeDrk}}

-

¿Prefieres la terminal? Con Go instalado y a partir de la versión 1.0.0, go run github.com/BertMarti/commitling/cmd/commitling@latest workflow --user tu-usuario --theme both escribe el mismo archivo.

+

¿Prefieres la terminal? Con Go instalado, go run github.com/BertMarti/commitling/cmd/commitling@latest workflow --user tu-usuario --theme both escribe el mismo archivo.

diff --git a/release/checksums.txt b/release/checksums.txt deleted file mode 100644 index 40f9f06..0000000 --- a/release/checksums.txt +++ /dev/null @@ -1,6 +0,0 @@ -2fb218c0cd1b55f491b94089bb1765906a154e9f979007cb23d39fa3752acba2 commitling_1.0.0_darwin_amd64 -c2ccb2374b952ad832a76d84f13d0dd2ae94b69715237464e32c31a5023a1a3e commitling_1.0.0_darwin_arm64 -579d5119043c329ffb788bb0e874b54548eef64c8481130c508e9b1b772f5dab commitling_1.0.0_linux_amd64 -3d846c89b6dadce14d9411837813bd7ac2cbc4121f8ad172fb3584d10b35630c commitling_1.0.0_linux_arm64 -cd9e610e3006c49ef8d4d7019a24311010e277ed6fa5951e88addf7663795c8d commitling_1.0.0_windows_amd64.exe -b1065c02dc64f0426866fe4d9333fc884f66248ce83eea4d360e1ef6b7748acb commitling_1.0.0_windows_arm64.exe