From ae81260e38ebd76bfd18d547704e393f24405b34 Mon Sep 17 00:00:00 2001 From: Jonathan Teran Carballo Date: Mon, 21 Sep 2026 16:22:01 -0300 Subject: [PATCH] docs: update readme to reflect new tag command --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2484fbf..80c6486 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ más información): - `new`: Crea una nueva rama siguiendo CB. - `commit`: Crea un commit siguiendo CC. - `merge`: Mergea la rama actual a una de las ramas principales. -- `tag`: Crea un tag sobre el ultimo merge siguiendo SemVer. +- `tag`: Crea un tag sobre el ultimo merge siguiendo SemVer (ver [Tag](#tag)). - `release`: Prepara la rama actual para pasarse al siguiente entorno configurado. - `branch`: Lista las ramas del repositorio, agrupadas por entorno objetivo. @@ -91,6 +91,27 @@ El workflow para el cual se penso la herramienta es el siguiente: En cualquier momento se puede usar `git-flow branch` para ver en qué entorno está cada rama, y cuáles están todavía en progreso (`wip/`) o descartadas (`trash/`). +### Tag + +`git-flow tag [--target=] [--token=] [--update-changelog]` + +- `--target`: rama principal sobre la que se taggea. Por defecto, la rama actual. Debe ser una de las + ramas principales configuradas. +- `--token`: Access Token del remoto. Si se pasa, se asume que corre en un pipeline: los commits y el + último tag se obtienen por API del remoto y el tag se crea en el remoto (y también localmente). Si + no, se usa `.repository-token` y todo se resuelve localmente. +- `--update-changelog`: genera la entrada correspondiente en `CHANGELOG.md` y la commitea antes de + taggear (en un pipeline, además hace push del commit). + +Comportamiento: + +- El tag se crea sobre el último merge (first-parent) de la rama. Si ese merge ya tiene un tag, no se + hace nada. +- La versión se calcula a partir de los tipos de commit (CC) del último merge. Si ningún commit + implica un salto de versión, se avisa y el comando termina con código de salida 1. +- Con más de un entorno configurado, cada rama versiona por separado con el nombre del entorno como + sufijo (por ejemplo, `v1.2.0-prod`). Con un solo entorno no se agrega sufijo. + ## Remotos soportados Cada remoto necesita un Access Token con permisos para crear Pull/Merge Requests y tags. El token se