Merge pull request 'feature: add branch types, commit types, support for breaking changes' (#67) from feature/extend-branch-and-commit-types into main

Reviewed-on: #67

README.md

@@ -1,5 +1,8 @@
 # Git Flow
 
+[![PyPI Version](https://img.shields.io/pypi/v/git-flow-envs)](https://pypi.org/project/git-flow-envs/)
+![Python Version](https://img.shields.io/python/required-version-toml?tomlFilePath=https://git.jonathanteran.dev/jt/git-flow/raw/branch/main/pyproject.toml)
+
 Herramienta para establecer un workflow siguiendo [Conventional Commits
 (CC)](https://www.conventionalcommits.org), [Conventional Branch
 (CB)](https://conventional-branch.github.io/), y [SemVer](https://semver.org/).
@@ -9,27 +12,12 @@ derivar versiones automaticamente de los merges sobre ramas principales.
 
 ## Instalación
 
-Para instalar Git Flow, se sugiere utilizar [pipx](https://github.com/pypa/pipx) (seguir la
+Se puede instalar con `pip` ejecutando el siguiente comando: `pip install git-flow-envs`. Sin
-documentación para instalarlo). Una vez instalado `pipx`, simplemente clonamos el repositorio en una
+embargo, se sugiere utilizar [pipx](https://github.com/pypa/pipx) (seguir la documentación para
-carpeta local, y lo instalamos:
+instalarlo), ya que aisla las dependencias de la herramienta en un `venv`. Una vez instalado,
+simplemente ejecutamos `pipx install git-flow-envs`
 
-```sh
+Luego podemos verificar que se haya instalado correctamente ejecutando: `git-flow --help`
-cd ~/Downloads
-git clone ssh://git@git.jonathanteran.dev:59169/jt/git-flow.git
-cd git-flow
-pipx install .
-```
-
-Luego podemos verificar que se haya instalado correctamente ejecutando: `git-flow -h`
-
-Para actualizarlo, hacemos un pull de los cambios recientes del repositorio, y hacemos el upgrade
-mediante `pipx`:
-
-```sh
-cd ~/Downloads/git-flow
-git pull
-pipx upgrade git-flow
-```
 
 ## Configuración
 
@@ -46,10 +34,10 @@ El comando solicitará 2 opciones:
 - **Remoto** (opcional): Nombre del remoto que se usará para crear PRs, y taggear merges
   automáticamente. Por el momento, se soportan los siguientes remotos:
 
-    - [x] Bitbucket
+  - [x] Bitbucket
-    - [x] Github
+  - [x] Github
-    - [x] Gitea
+  - [x] Gitea
-    - [x] Gitlab
+  - [x] Gitlab
 
   La configuración del remoto requiere tener un Access Token para poder crear los PRs y tags
   automáticamente. Ver la sección [Remotos soportados](#remotos-soportados) para las instrucciones
@@ -60,13 +48,13 @@ El comando solicitará 2 opciones:
 
 ## Utilización
 
-Git Flow cuenta con los siguientes comandos para guiar el workflow (ver `git-flow <command> -h` para
+Git Flow cuenta con los siguientes comandos para guiar el workflow (ver `git-flow <command> --help` para
 más información):
 
 - `init`: Inicializa el repositorio para utilizar git-flow (ramas principales y remoto).
 - `new`: Crea una nueva rama siguiendo CB.
 - `commit`: Crea un commit siguiendo CC.
-- `merge`: Mergea la rama actual a una de las ramas principales.
+- `merge`: Mergea la rama actual a uno de los entornos.
 - `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 ls`: Lista las ramas del repositorio, agrupadas por entorno objetivo.
@@ -74,6 +62,9 @@ más información):
   `--remote`), dejando un reporte CSV (`branch-clean-report.csv`) con nombre, commit, autor y
   fecha de cada rama eliminada.
 
+Por defecto solo se muestra cada paso que se ejecuta. Con `git-flow --verbose <command>` (o `-v`) se
+muestra además la salida de cada comando git y el traceback completo de los errores.
+
 El workflow para el cual se penso la herramienta es el siguiente:
 
 1. Sobre la primer rama principal configurada (por ejemplo, `dev`), se crea una nueva rama con
@@ -111,7 +102,18 @@ 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.
+  implica un salto de versión, se avisa y el comando termina con código de salida 1. Se toma el
+  mayor incremento entre los commits:
+
+  | Tipo de commit                                                 | Incremento |
+  | -------------------------------------------------------------- | ---------- |
+  | cualquier tipo marcado como breaking (`feature!: ...`)         | major      |
+  | `feature` (o `feat`)                                           | minor      |
+  | `bugfix` (o `fix`), `hotfix`, `refactor`, `perf`, `revert`     | patch      |
+  | `docs`, `style`, `test`, `build`, `ci`, `chore`, `wip`         | ninguno    |
+  | personalizado (opción `otro` en `git-flow commit`)             | ninguno    |
+
+  `git-flow commit` pregunta si el commit es un breaking change (salvo en commits `wip`).
 - 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.
 - Si el merge viene del entorno anterior (por ejemplo, `dev` a `test`), no se calcula una nueva
@@ -153,12 +155,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 10
 
       - uses: astral-sh/setup-uv@v3
 
       - run: uv run git-flow tag --token=${{ secrets.GIT_FLOW_TOKEN }}
-
       - run: uv build
       - run: uv publish --token=${{ secrets.PYPI_TOKEN }}
 ```
@@ -177,11 +178,14 @@ Ejemplo de pipeline (GitLab CI) para taggear automáticamente en cada push a una
 # .gitlab-ci.yml
 tag:
   image: python:3.14
+  variables:
+    GIT_DEPTH: 10
   rules:
     - if: $CI_COMMIT_BRANCH == "main"
   script:
     - pip install uv
-    - uv run git-flow tag --token=$GIT_FLOW_TOKEN
+    # GitLab hace checkout en detached HEAD, por lo que la rama se indica explícitamente
+    - uv run git-flow tag --target=$CI_COMMIT_BRANCH --token=$GIT_FLOW_TOKEN
     - uv build
     - uv publish --token=$PYPI_TOKEN
 ```
@@ -203,6 +207,9 @@ ver el archivo `bitbucket-pipelines.yml` como ejemplo:
 # bitbucket-pipelines.yml
 image: python:3.14
 
+clone:
+  depth: 10
+
 pipelines:
   branches:
     'main':
@@ -245,19 +252,18 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 10
 
       - uses: astral-sh/setup-uv@v3
 
       - run: uv run git-flow tag --token=${{ secrets.GIT_FLOW_TOKEN }}
-
       - run: uv build
       - run: uv publish --token=${{ secrets.PYPI_TOKEN }}
 ```
 
 ## Taggeo automático por pipeline
 
-En todos los casos, `git-flow tag` detecta que se está ejecutando desde un pipeline (no encuentra
+En todos los casos, al pasar `--token=<TOKEN>` `git-flow tag` asume que se está ejecutando desde un
-`.repository-token` en el repositorio) y usa el token pasado por `--token=<TOKEN>` tanto para crear
+pipeline: obtiene los commits del último PR / MR y el último tag por API del remoto, y usa el token
-el tag en el remoto como para pushear el commit del `CHANGELOG.md` generado, en vez de crear el tag
+tanto para crear el tag en el remoto como para pushear el commit del `CHANGELOG.md` generado (con
-únicamente en forma local como sucede al ejecutarlo manualmente sin remoto configurado.
+`--update-changelog`), en vez de resolver todo en forma local.

src/git_flow/__init__.py

@@ -1,15 +1,6 @@
 GitFlowError = ValueError
 
 BRANCH_TYPES = [
-    "feature",
-    "refactor",
-    "bugfix",
-    "hotfix",
-    "chore",
-    "docs",
-]
-
-COMMIT_TYPES = [
     "feature",
     "bugfix",
     "hotfix",
@@ -18,6 +9,24 @@ COMMIT_TYPES = [
     "docs",
     "style",
     "test",
+    "build",
+    "ci",
+    "chore",
+]
+
+COMMIT_TYPES = [
+    "feature",
+    "bugfix",
+    "hotfix",
+    "refactor",
+    "perf",
+    "revert",
+    "docs",
+    "style",
+    "test",
+    "build",
+    "ci",
+    "chore",
     "wip",
 ]
 
@@ -32,15 +41,25 @@ SEMVER_PATCH = 1
 # Commits con estos tipos no alteran la versión
 SEMVER_SKIP = 0
 
+# Un commit marcado como breaking change (<tipo>!: <mensaje>) incrementa SEMVER_MAJOR sin importar
+# el tipo. Los tipos que no figuran aquí no alteran la versión.
 COMMIT_TYPE_INCREMENT = {
     "feature": SEMVER_MINOR,
     "bugfix": SEMVER_PATCH,
     "hotfix": SEMVER_PATCH,
     "refactor": SEMVER_PATCH,
     "perf": SEMVER_PATCH,
+    "revert": SEMVER_PATCH,
     "docs": SEMVER_SKIP,
     "style": SEMVER_SKIP,
     "test": SEMVER_SKIP,
+    "build": SEMVER_SKIP,
+    "ci": SEMVER_SKIP,
+    "chore": SEMVER_SKIP,
+    "wip": SEMVER_SKIP,
+    # Alias de Conventional Commits, para commits creados fuera de git-flow
+    "feat": SEMVER_MINOR,
+    "fix": SEMVER_PATCH,
 }
 
 SUPPORTED_REMOTE_URL_SCHEMAS = [

src/git_flow/command/base.py

@@ -1,11 +1,15 @@
+import re
+import time
 from os.path import isfile
 
 import questionary
 import rich
 import rich.panel
+from rich.table import Table
 
 from git_flow import (
     BRANCH_TYPES,
+    COMMIT_TYPE_INCREMENT,
     COMMIT_TYPES,
     FLOWCONFIG_FILENAME,
     FLOWCONFIG_VERSION,
@@ -152,8 +156,30 @@ def is_valid_ticket(ticket: str) -> bool:
     )
 
 
+CUSTOM_COMMIT_TYPE_OPTION = "otro"
+
+
 def get_commit_message(commit_types: list[str] = COMMIT_TYPES) -> str:
-    commit_type = io_choice("Tipo de commit", commit_types)
+    commit_type = io_choice("Tipo de commit", commit_types + [CUSTOM_COMMIT_TYPE_OPTION])
+
+    if commit_type == CUSTOM_COMMIT_TYPE_OPTION:
+        commit_type = io_prompt(
+            "Tipo de commit personalizado",
+            strip=True,
+            validator=lambda s: re.fullmatch(r"\w+", s.strip()) is not None,
+            instruction="letras, números o _",
+        )
+
+        if commit_type not in COMMIT_TYPE_INCREMENT:
+            io_warning(
+                f"El tipo '{commit_type}' no produce un salto de versión, "
+                "salvo que se marque como breaking change."
+            )
+
+    # Los commits WIP se squashean en uno final, que es el que puede marcarse como breaking
+    if commit_type != "wip" and io_confirm("¿Es un breaking change?", False):
+        commit_type += "!"
+
     commit_message = io_prompt(
         "Mensaje de commit",
         validator=lambda s: 0 < len(s) and len(s) < 100,
@@ -162,6 +188,55 @@ def get_commit_message(commit_types: list[str] = COMMIT_TYPES) -> str:
     return commit_type + ": " + commit_message
 
 
+# <tipo>[(alcance)][!]: <mensaje>, para no confundir "Merge pull request 'feature: ...'" con un tipo
+COMMIT_SUBJECT_RE = re.compile(r"^(\w+)(?:\([^)]*\))?(!)?:\s*(.*)$")
+
+
+def show_commits(title: str, revision_range: str):
+    """Muestra en una tabla los commits del rango (fecha relativa, tipo y mensaje).
+    Si no hay commits aborta, ya que no hay nada para mergear."""
+    # fecha de autor: la de commit cambia al hacer rebase (por ejemplo, en release)
+    lines = Git("log", revision_range, format="%at%x09%s").lines()
+
+    if not lines:
+        raise GitFlowError("No hay cambios a mergear.")
+
+    table = Table(title=title, title_justify="left", title_style="bold")
+    table.add_column("Fecha", style="dim", no_wrap=True)
+    table.add_column("Tipo", style="cyan", no_wrap=True)
+    table.add_column("Mensaje")
+
+    now = time.time()
+
+    for line in lines:
+        timestamp, subject = line.split("\t", 1)
+        match = COMMIT_SUBJECT_RE.match(subject)
+        commit_type, breaking, message = match.groups() if match else ("-", None, subject)
+        commit_type += breaking or ""
+        table.add_row(format_time_ago(now - int(timestamp)), commit_type, message)
+
+    console.print(table)
+
+
+def format_time_ago(seconds: float) -> str:
+    units = [
+        (365 * 24 * 3600, "año", "años"),
+        (30 * 24 * 3600, "mes", "meses"),
+        (7 * 24 * 3600, "semana", "semanas"),
+        (24 * 3600, "día", "días"),
+        (3600, "hora", "horas"),
+        (60, "minuto", "minutos"),
+    ]
+
+    for size, singular, plural in units:
+        amount = int(seconds // size)
+
+        if amount >= 1:
+            return f"hace {amount} {singular if amount == 1 else plural}"
+
+    return "hace un momento"
+
+
 def io_error(message: str, title: str | None = None):
     _io_status(message, "✖ Error: ", "red", title)
 

src/git_flow/command/merge.py

@@ -71,15 +71,7 @@ def run_local(branch: str, target: str):
 
 
 def show_commits_to_merge(target):
-    commits = Git("log", target + "..", format="%s").lines()
+    base.show_commits("Cambios a mergear", target + "..")
-
-    if not commits:
-        raise GitFlowError("No hay cambios a mergear.")
-
-    print("Cambios a mergear:")
-
-    for commit in commits:
-        print("- " + commit)
 
 
 def check_merge_conflicts(target: str):

src/git_flow/command/release.py

@@ -32,15 +32,7 @@ def release():
     )
 
     fork_point = Git.get_first_fork_point(branch, env)
-    commits = Git("log", fork_point + "..", format="%s").lines()
+    base.show_commits("Cambios a pasar al próximo entorno", fork_point + "..")
-
-    if not commits:
-        raise GitFlowError("No hay cambios a mergear.")
-
-    print("Cambios a pasar al proximo entorno:")
-
-    for commit in commits:
-        print("- " + commit)
 
     if has_remote and Git.get_tracking_branch(next_env):
         Git("switch", next_env).exec(print="Cambiando a la rama objetivo")

src/git_flow/command/tag.py

@@ -128,8 +128,14 @@ def get_next_tag_from_commits(
 ) -> str | None:
     increment = SEMVER_SKIP
     for commit in commits:
-        commit_type = commit.partition(":")[0]
+        match = base.COMMIT_SUBJECT_RE.match(commit)
-        increment = max(increment, COMMIT_TYPE_INCREMENT.get(commit_type, SEMVER_SKIP))
+
+        if not match:
+            continue
+
+        commit_type, breaking, _ = match.groups()
+        commit_increment = SEMVER_MAJOR if breaking else COMMIT_TYPE_INCREMENT.get(commit_type)
+        increment = max(increment, commit_increment or SEMVER_SKIP)
 
     if increment == SEMVER_SKIP:
         return None

src/git_flow/git.py

@@ -1,6 +1,10 @@
 import subprocess
 from dataclasses import dataclass
 
+from rich.markup import escape
+from rich.panel import Panel
+from rich.text import Text
+
 from git_flow import FLOWCONFIG_FILENAME
 from git_flow.io import *
 
@@ -180,10 +184,13 @@ class Git:
         self._run(**kwargs)
 
     def _get(self, print: str | None = None, check: bool = True):
-        process = subprocess.run(self.command, capture_output=True, text=True)
+        process = subprocess.run(self.command, capture_output=True, text=True, check=False)
 
-        if print is not None:
+        # Sin --verbose solo se muestra el paso; si falla, la salida la muestra main()
-            self._print_process(process.stdout, process.stderr, print)
+        if print is not None and settings.verbose:
+            self._print_process(process, print)
+        elif print is not None:
+            console.print(Text.assemble(("› ", "cyan"), print))
 
         if check:
             process.check_returncode()
@@ -193,7 +200,7 @@ class Git:
     def _run(self, print: str | None = None, check: bool = True):
         return self._get(print, check)
 
-    def _print_process(self, stdout: str, stderr: str, title: str):
+    def _print_process(self, process: subprocess.CompletedProcess, title: str | None):
         command = []
 
         for arg in self.command:
@@ -205,12 +212,25 @@ class Git:
 
             command.append(arg)
 
-        text = f"[green]$ {' '.join(command)}[/green]"
+        ok = process.returncode == 0
+        # git escribe mensajes informativos en stderr, así que solo se resalta si falló
+        stderr_style = "dim" if ok else "red"
+        text = Text.assemble(("$ ", "dim"), (" ".join(command), "bold yellow"))
 
-        for line in stdout.splitlines():
+        for line in process.stdout.splitlines():
-            text += "\n" + line
+            text.append("\n" + line)
 
-        for line in stderr.splitlines():
+        for line in process.stderr.splitlines():
-            text += "\n[red]" + line + "[/red]"
+            text.append("\n" + line, stderr_style)
 
-        panel(title or "Ejecutando", text)
+        console.print(
+            Panel(
+                text,
+                title=f"[bold]{escape(title or 'Ejecutando')}[/bold]",
+                title_align="left",
+                subtitle=None if ok else f"código de salida {process.returncode}",
+                subtitle_align="right",
+                border_style="bright_black" if ok else "red",
+                expand=False,
+            )
+        )

src/git_flow/io.py

@@ -1,10 +1,19 @@
 from rich.console import Console
-from rich.prompt import Prompt, Confirm
 from rich.panel import Panel
+from rich.prompt import Confirm, Prompt
 
 console = Console(highlight=False)
 
 
+class Settings:
+    """Opciones globales de ejecución, configuradas desde la línea de comandos."""
+
+    verbose: bool = False
+
+
+settings = Settings()
+
+
 def success(msg: str):
     console.print(f":white_check_mark: [green]{msg}[/green]")
 

src/git_flow/main.py

@@ -1,12 +1,16 @@
 #!/usr/bin/env python3
 
-import traceback
+from subprocess import CalledProcessError, SubprocessError
-from subprocess import SubprocessError
+from typing import Annotated
 
+import click
 import typer
+from rich.markup import escape
+from rich.traceback import Traceback
 
 from git_flow import GitFlowError
 from git_flow.command import base, branch, commit, init, merge, new, release, tag
+from git_flow.io import console, settings
 
 REPOSITORY_TOKEN_PATH = ".repository-token"
 LOCALE = "es_AR.UTF-8"
@@ -22,15 +26,55 @@ app.add_typer(release.app)
 app.add_typer(branch.app)
 
 
+@app.callback()
+def options(
+    verbose: Annotated[
+        bool,
+        typer.Option(
+            "--verbose",
+            "-v",
+            help="Muestra la salida de los comandos git y el traceback de los errores",
+        ),
+    ] = False,
+):
+    settings.verbose = verbose
+
+
 def main():
     try:
         app()
         print()
     except GitFlowError as e:
-        lines = [str(e), ""]
+        _print_error(escape(str(e)), "Git Flow", e)
-        lines += traceback.format_exception(e)
+    except CalledProcessError as e:
-        base.io_error("".join(lines), title="Git Flow")
+        _print_error(_format_process_error(e), "Comando", e)
     except SubprocessError as e:
-        base.io_error(str(e), title="Comando")
+        _print_error(escape(str(e)), "Comando", e)
     except KeyboardInterrupt:
         base.io_error("Ejecución abortada")
+
+
+def _format_process_error(e: CalledProcessError) -> str:
+    command = " ".join(e.cmd) if isinstance(e.cmd, list) else str(e.cmd)
+    message = f"[bold]$ {escape(command)}[/bold]\nTerminó con código de salida {e.returncode}"
+
+    for output in (e.stdout, e.stderr):
+        if isinstance(output, str) and output.strip():
+            message += "\n\n" + escape(output.strip())
+
+    return message
+
+
+def _print_error(message: str, title: str, e: BaseException):
+    if settings.verbose:
+        base.io_error(message, title=title)
+        console.print(
+            Traceback.from_exception(
+                type(e), e, e.__traceback__, suppress=[click, typer]
+            )
+        )
+    else:
+        base.io_error(
+            message + "\n\n[dim]Ejecutar con `git-flow --verbose <comando>` para ver el detalle[/dim]",
+            title=title,
+        )