Merge pull request 'docs: update readme to reflect new tag command' (#56) from docs/update-readme into main

Reviewed-on: #56

.gitea/workflows/bump-build-publish.yaml

@@ -5,13 +5,13 @@ on:
       - main
 
 jobs:
-  Publish-to-PyPI:
+  Bump-Build-Publish:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v7
         with:
-          fetch-depth: 0
+          fetch-depth: 10
 
       - name: Configure git
         run: |
@@ -19,7 +19,7 @@ jobs:
           git config --global user.email "actions@git.jonathanteran.dev"
           git config --global --add safe.directory "$GITHUB_WORKSPACE"
 
-      - name: "Set up Python"
+      - name: Set up Python
         uses: actions/setup-python@v6
         with:
           python-version-file: ".python-version"
@@ -27,11 +27,23 @@ jobs:
       - name: Install uv
         uses: astral-sh/setup-uv@v8.3.2
 
-      - name: Bump version
+      - name: Install git-flow and bump version
+        id: version
         run: |
-          uv run git-flow tag --token="${{ secrets.GITEA_TOKEN }}"
+          pip install git-flow-envs=="${{ vars.GITFLOWENVS_VERSION }}"
+          git-flow tag --token="${{ secrets.GITEA_TOKEN }}"
+          RESULT="$?"
+
+          if [ "$RESULT" -eq 0 ]; then
+            echo "New tag available."
+            echo "should_build=true" >> $GITHUB_OUTPUT
+          else
+            echo "No new tag available, skipping next step."
+            echo "should_build=false" >> $GITHUB_OUTPUT
+          fi
 
       - name: Build and publish
+        if: steps.version.outputs.should_build == 'true'
         run: |
           uv build
           uv publish --token="${{ secrets.PYPI_TOKEN }}"

CHANGELOG.md

@@ -1,3 +1,10 @@
+## v1.23.0 - 2026-09-21
+
+- **feature**:  add fetch depth [[jonathan.nerat](mailto:jonathan.nerat@gmail.com)] (68cec91)
+
+---
+
+
 ## v1.22.3 - 2026-09-21
 
 - **bugfix**:  tag locally for workflow to run [[jteran](mailto:jteran@renatre.org.ar)] (24a40c9)

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=<RAMA>] [--token=<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

src/git_flow/command/base.py

@@ -1,26 +1,24 @@
-import sys
+from os.path import isfile
+
+import questionary
+import rich
+import rich.panel
 
 from git_flow import (
     BRANCH_TYPES,
-    REPOSITORY_TOKEN_FILENAME,
+    COMMIT_TYPES,
     FLOWCONFIG_FILENAME,
     FLOWCONFIG_VERSION,
-    COMMIT_TYPES,
+    REPOSITORY_TOKEN_FILENAME,
     GitFlowError,
 )
 from git_flow.git import Git
+from git_flow.io import *
 from git_flow.remote.base import RemoteAPI
 from git_flow.remote.bitbucket import BitbucketRemoteAPI
-from git_flow.remote.github import GithubRemoteAPI
 from git_flow.remote.gitea import GiteaRemoteAPI
+from git_flow.remote.github import GithubRemoteAPI
 from git_flow.remote.gitlab import GitlabRemoteAPI
-from git_flow.io import *
-from os.path import isfile
-
-from typing import Optional
-import rich
-import rich.panel
-import questionary
 
 flowconfig = Git.get_config(FLOWCONFIG_FILENAME) if isfile(FLOWCONFIG_FILENAME) else {}
 environments = (
@@ -104,7 +102,7 @@ def ensure_clean_worktree(has_remote: bool):
     if not status:
         return
 
-    not_empty = any(map(lambda s: s.index != " " or s.worktree != " ", status))
+    not_empty = any(s.index != " " or s.worktree != " " for s in status)
 
     if not_empty:
         if not has_remote:
@@ -164,23 +162,23 @@ def get_commit_message(commit_types: list[str] = COMMIT_TYPES) -> str:
     return commit_type + ": " + commit_message
 
 
-def io_error(message: str, title: Optional[str] = None):
-    _io_status(message, "✖ Error: ", "red", title, file=sys.stderr)
+def io_error(message: str, title: str | None = None):
+    _io_status(message, "✖ Error: ", "red", title)
 
 
-def io_warning(message: str, title: Optional[str] = None):
+def io_warning(message: str, title: str | None = None):
     _io_status(message, "⚠ Warning: ", "yellow", title)
 
 
-def io_info(message: str, title: Optional[str] = None):
+def io_info(message: str, title: str | None = None):
     _io_status(message, "ℹ Info: ", "blue", title)
 
 
-def io_success(message: str, title: Optional[str] = None):
+def io_success(message: str, title: str | None = None):
     _io_status(message, "✔ Success: ", "green", title)
 
 
-def _io_status(message: str, prefix: str, style: str, title: Optional[str] = None, file=None):
+def _io_status(message: str, prefix: str, style: str, title: str | None = None):
     if title:
         rich.print(
             rich.panel.Panel(
@@ -189,8 +187,7 @@ def _io_status(message: str, prefix: str, style: str, title: Optional[str] = Non
                 style=style,
                 expand=False,
                 title_align="left",
-            ),
-            file=file
+            )
         )
     else:
         rich.print(f"[{style}]{prefix}{message}[/{style}]")

src/git_flow/command/tag.py

@@ -1,8 +1,5 @@
-from typing import Optional
-
 import typer
 
-import git_flow.command.base as base
 from git_flow import (
     COMMIT_TYPE_INCREMENT,
     SEMVER_MAJOR,
@@ -12,38 +9,45 @@ from git_flow import (
     GitFlowError,
 )
 from git_flow.changelog import Changelog
+from git_flow.command import base
 from git_flow.git import Git
 
 app = typer.Typer()
 
 
 @app.command()
-def tag(token: Optional[str] = None):
+def tag(target: str | None = None, token: str | None = None, update_changelog: bool = False):
     """Crea un nuevo tag para el último merge."""
     base.ensure_initialized()
 
-    target = Git.get_current_branch()
+    target = target or Git.get_current_branch()
 
     if target not in base.environments:
         raise GitFlowError("Solo se pueden taggear commits en ramas principales.")
 
-    token, ci = get_token_and_ci(token)
-
-    if ci and not token:
-        raise GitFlowError("No hay token disponible")
-
     merge_commit = Git(
         "log", first_parent=True, merges=True, max_count=1, format="%H"
     ).firstline()
 
     if not merge_commit:
-        if not ci:
-            raise GitFlowError("No hay merges a taggear.")
+        raise GitFlowError("No hay merges a taggear.")
+
+    merge_commit_tag = Git("tag", "--points-at", merge_commit).firstline()
+    if merge_commit_tag:
+        base.io_info(f"El último merge ya tiene un tag: {merge_commit_tag}")
         return
 
     # Con varios entornos cada uno versiona por separado (v1.0.0-prod), con uno solo no hace falta
     suffix = f"-{target}" if len(base.environments) > 1 else ""
 
+    token, ci = get_token_and_ci(token)
+
+    if ci and not token:
+        raise GitFlowError("No hay token disponible")
+
+    # Con varios entornos cada uno versiona por separado (v1.0.0-prod), con uno solo no hace falta
+    suffix = f"-{target}" if len(base.environments) > 1 else ""
+
     if ci:
         # Commits se obtienen por API del ultimo PR / MR mergeado
         commits = base.get_remote_api(token).get_merge_commits(merge_commit)
@@ -52,7 +56,7 @@ def tag(token: Optional[str] = None):
         current_tag = base.get_remote_api(token).get_latest_tag(suffix)
     else:
         # Commits se obtienen del último merge, listando hasta el primer forkpoint
-        branch = Git("show", merge_commit + "^2", patch=False, format="%h").firstline()
+        branch = Git("show", merge_commit + "^2", patch=False, format="%H").firstline()
         fork_point = Git.get_first_fork_point(branch, target)
         commits = Git.get_commits(fork_point, branch)
         # Último tag se obtiene localmente
@@ -63,28 +67,30 @@ def tag(token: Optional[str] = None):
     )
 
     if not next_tag:
-        if not ci:
-            base.io_info(
-                "Los cambios realizados no implican un salto de versión, se mantiene la anterior."
-            )
-        return
+        base.io_warning(
+            "Los cambios realizados no implican un salto de versión, se mantiene la anterior."
+        )
 
-    changelog = Changelog()
+        raise typer.Exit(code=1)
 
-    changelog.update(next_tag, commits)
-    Git("add", Changelog.FILENAME).exec(print=None if ci else "Agregando nuevo CHANGELOG.md")
-    Git("commit", message=Changelog.COMMIT_MESSAGE).exec(print=None if ci else "Creando commit")
-    tag_commit = Git("show", "HEAD", patch=False, format="%h").firstline()
+    if update_changelog:
+        changelog = Changelog()
+        changelog.update(next_tag, commits)
+        Git("add", Changelog.FILENAME).exec(print="Agregando nuevo CHANGELOG.md")
+        Git("commit", message=Changelog.COMMIT_MESSAGE).exec(print="Creando commit")
+
+        if ci:
+            Git("push").exec()
+
+    tag_commit = Git("show", "HEAD", patch=False, format="%H").firstline()
 
     if ci:
-        Git("push").exec()
-        base.get_remote_api(token).create_tag(next_tag, tag_commit)
-        print(next_tag)
+        base.io_success(base.get_remote_api(token).create_tag(next_tag, tag_commit))
 
-    Git("tag", next_tag, tag_commit).exec(print=None if ci else "Creando tag localmente")
+    Git("tag", next_tag, tag_commit).exec(print="Creando tag localmente")
 
 
-def get_token_and_ci(token: Optional[str]):
+def get_token_and_ci(token: str | None):
     if token:
         return (token, True)
     else:

src/git_flow/remote/gitlab.py

@@ -46,7 +46,7 @@ class GitlabRemoteAPI(RemoteAPI):
         if response.ok:
             return "Tag creado exitosamente: " + tag
         else:
-            raise GitFlowError("Ocurrió un error al crear el tag para repositorio " + quote(self.repository, safe="") + ": " + response.text)
+            raise GitFlowError("Ocurrió un error al crear el tag: " + response.text)
 
     def get_merge_commits(self, merge_commit: str) -> list[Commit]:
         mrs = self.get_json(