Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6e760f7866 | ||
|
|
67eb6fb6d1 | ||
|
|
8ba5f8f5da | ||
|
|
839f71962f | ||
|
|
26ac95e5cf | ||
|
|
8a28ce3a7e | ||
|
|
3d65356f7a | ||
|
|
44fa8bc1d6 |
@@ -1,5 +1,8 @@
|
|||||||
# Git Flow
|
# Git Flow
|
||||||
|
|
||||||
|
[](https://pypi.org/project/git-flow-envs/)
|
||||||
|

|
||||||
|
|
||||||
Herramienta para establecer un workflow siguiendo [Conventional Commits
|
Herramienta para establecer un workflow siguiendo [Conventional Commits
|
||||||
(CC)](https://www.conventionalcommits.org), [Conventional Branch
|
(CC)](https://www.conventionalcommits.org), [Conventional Branch
|
||||||
(CB)](https://conventional-branch.github.io/), y [SemVer](https://semver.org/).
|
(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
|
## 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
|
## Configuración
|
||||||
|
|
||||||
@@ -60,13 +48,13 @@ El comando solicitará 2 opciones:
|
|||||||
|
|
||||||
## Utilización
|
## 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):
|
más información):
|
||||||
|
|
||||||
- `init`: Inicializa el repositorio para utilizar git-flow (ramas principales y remoto).
|
- `init`: Inicializa el repositorio para utilizar git-flow (ramas principales y remoto).
|
||||||
- `new`: Crea una nueva rama siguiendo CB.
|
- `new`: Crea una nueva rama siguiendo CB.
|
||||||
- `commit`: Crea un commit siguiendo CC.
|
- `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)).
|
- `tag`: Crea un tag sobre el ultimo merge siguiendo SemVer (ver [Tag](#tag)).
|
||||||
- `release`: Prepara la rama actual para pasarse al siguiente entorno configurado.
|
- `release`: Prepara la rama actual para pasarse al siguiente entorno configurado.
|
||||||
- `branch ls`: Lista las ramas del repositorio, agrupadas por entorno objetivo.
|
- `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
|
`--remote`), dejando un reporte CSV (`branch-clean-report.csv`) con nombre, commit, autor y
|
||||||
fecha de cada rama eliminada.
|
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:
|
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
|
1. Sobre la primer rama principal configurada (por ejemplo, `dev`), se crea una nueva rama con
|
||||||
@@ -114,6 +105,11 @@ Comportamiento:
|
|||||||
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.
|
||||||
- Con más de un entorno configurado, cada rama versiona por separado con el nombre del entorno como
|
- 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.
|
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
|
||||||
|
versión: se promueve la del entorno anterior cambiando el sufijo (si `dev` está en `v1.2.0-dev` y
|
||||||
|
`test` en `v1.0.0-test`, el nuevo tag es `v1.2.0-test`), sin importar los tipos de commit. Si ese
|
||||||
|
tag ya existe en el destino, el comando falla. En un pipeline, el merge se detecta por la rama
|
||||||
|
origen del PR; localmente, porque el merge trae tags del entorno anterior que el destino no tenía.
|
||||||
|
|
||||||
## Remotos soportados
|
## Remotos soportados
|
||||||
|
|
||||||
@@ -148,12 +144,11 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 10
|
||||||
|
|
||||||
- uses: astral-sh/setup-uv@v3
|
- uses: astral-sh/setup-uv@v3
|
||||||
|
|
||||||
- run: uv run git-flow tag --token=${{ secrets.GIT_FLOW_TOKEN }}
|
- run: uv run git-flow tag --token=${{ secrets.GIT_FLOW_TOKEN }}
|
||||||
|
|
||||||
- run: uv build
|
- run: uv build
|
||||||
- run: uv publish --token=${{ secrets.PYPI_TOKEN }}
|
- run: uv publish --token=${{ secrets.PYPI_TOKEN }}
|
||||||
```
|
```
|
||||||
@@ -172,11 +167,14 @@ Ejemplo de pipeline (GitLab CI) para taggear automáticamente en cada push a una
|
|||||||
# .gitlab-ci.yml
|
# .gitlab-ci.yml
|
||||||
tag:
|
tag:
|
||||||
image: python:3.14
|
image: python:3.14
|
||||||
|
variables:
|
||||||
|
GIT_DEPTH: 10
|
||||||
rules:
|
rules:
|
||||||
- if: $CI_COMMIT_BRANCH == "main"
|
- if: $CI_COMMIT_BRANCH == "main"
|
||||||
script:
|
script:
|
||||||
- pip install uv
|
- 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 build
|
||||||
- uv publish --token=$PYPI_TOKEN
|
- uv publish --token=$PYPI_TOKEN
|
||||||
```
|
```
|
||||||
@@ -198,6 +196,9 @@ ver el archivo `bitbucket-pipelines.yml` como ejemplo:
|
|||||||
# bitbucket-pipelines.yml
|
# bitbucket-pipelines.yml
|
||||||
image: python:3.14
|
image: python:3.14
|
||||||
|
|
||||||
|
clone:
|
||||||
|
depth: 10
|
||||||
|
|
||||||
pipelines:
|
pipelines:
|
||||||
branches:
|
branches:
|
||||||
'main':
|
'main':
|
||||||
@@ -240,19 +241,18 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 10
|
||||||
|
|
||||||
- uses: astral-sh/setup-uv@v3
|
- uses: astral-sh/setup-uv@v3
|
||||||
|
|
||||||
- run: uv run git-flow tag --token=${{ secrets.GIT_FLOW_TOKEN }}
|
- run: uv run git-flow tag --token=${{ secrets.GIT_FLOW_TOKEN }}
|
||||||
|
|
||||||
- run: uv build
|
- run: uv build
|
||||||
- run: uv publish --token=${{ secrets.PYPI_TOKEN }}
|
- run: uv publish --token=${{ secrets.PYPI_TOKEN }}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Taggeo automático por pipeline
|
## 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.
|
||||||
|
|||||||
@@ -1,8 +1,11 @@
|
|||||||
|
import re
|
||||||
|
import time
|
||||||
from os.path import isfile
|
from os.path import isfile
|
||||||
|
|
||||||
import questionary
|
import questionary
|
||||||
import rich
|
import rich
|
||||||
import rich.panel
|
import rich.panel
|
||||||
|
from rich.table import Table
|
||||||
|
|
||||||
from git_flow import (
|
from git_flow import (
|
||||||
BRANCH_TYPES,
|
BRANCH_TYPES,
|
||||||
@@ -162,6 +165,54 @@ def get_commit_message(commit_types: list[str] = COMMIT_TYPES) -> str:
|
|||||||
return commit_type + ": " + commit_message
|
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, message = match.groups() if match else ("-", subject)
|
||||||
|
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):
|
def io_error(message: str, title: str | None = None):
|
||||||
_io_status(message, "✖ Error: ", "red", title)
|
_io_status(message, "✖ Error: ", "red", title)
|
||||||
|
|
||||||
|
|||||||
@@ -71,15 +71,7 @@ def run_local(branch: str, target: str):
|
|||||||
|
|
||||||
|
|
||||||
def show_commits_to_merge(target):
|
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):
|
def check_merge_conflicts(target: str):
|
||||||
|
|||||||
@@ -32,15 +32,7 @@ def release():
|
|||||||
)
|
)
|
||||||
|
|
||||||
fork_point = Git.get_first_fork_point(branch, env)
|
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):
|
if has_remote and Git.get_tracking_branch(next_env):
|
||||||
Git("switch", next_env).exec(print="Cambiando a la rama objetivo")
|
Git("switch", next_env).exec(print="Cambiando a la rama objetivo")
|
||||||
|
|||||||
@@ -37,9 +37,6 @@ def tag(target: str | None = None, token: str | None = None, update_changelog: b
|
|||||||
base.io_info(f"El último merge ya tiene un tag: {merge_commit_tag}")
|
base.io_info(f"El último merge ya tiene un tag: {merge_commit_tag}")
|
||||||
return
|
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)
|
token, ci = get_token_and_ci(token)
|
||||||
|
|
||||||
if ci and not token:
|
if ci and not token:
|
||||||
@@ -48,20 +45,49 @@ def tag(target: str | None = None, token: str | None = None, update_changelog: b
|
|||||||
# Con varios entornos cada uno versiona por separado (v1.0.0-prod), con uno solo no hace falta
|
# 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 ""
|
suffix = f"-{target}" if len(base.environments) > 1 else ""
|
||||||
|
|
||||||
if ci:
|
# Un merge desde el entorno anterior (por ejemplo, dev a test) promueve su versión tal cual
|
||||||
|
target_index = base.environments.index(target)
|
||||||
|
source_env = base.environments[target_index - 1] if target_index > 0 else None
|
||||||
|
source_suffix = f"-{source_env}"
|
||||||
|
promoted_tag = None
|
||||||
|
api = base.get_remote_api(token) if ci else None
|
||||||
|
|
||||||
|
if api:
|
||||||
# Commits se obtienen por API del ultimo PR / MR mergeado
|
# Commits se obtienen por API del ultimo PR / MR mergeado
|
||||||
commits = base.get_remote_api(token).get_merge_commits(merge_commit)
|
commits = api.get_merge_commits(merge_commit)
|
||||||
commits = [c for c in commits if not c.is_merge]
|
commits = [c for c in commits if not c.is_merge]
|
||||||
# Último tag se obtiene por API filtrando por sufijo
|
# Último tag se obtiene por API filtrando por sufijo
|
||||||
current_tag = base.get_remote_api(token).get_latest_tag(suffix)
|
current_tag = api.get_latest_tag(suffix)
|
||||||
|
|
||||||
|
if source_env and api.get_merge_source_branch(merge_commit) == source_env:
|
||||||
|
promoted_tag = api.get_latest_tag(source_suffix)
|
||||||
|
else:
|
||||||
|
branch = Git("show", merge_commit + "^2", patch=False, format="%H").firstline()
|
||||||
|
promoted_tag = Git.get_promoted_tag(merge_commit, source_suffix) if source_env else None
|
||||||
|
|
||||||
|
if promoted_tag:
|
||||||
|
# Todos los cambios que el entorno anterior trae al destino
|
||||||
|
commits = Git.get_commits(merge_commit + "^1", branch, first_parent=False)
|
||||||
else:
|
else:
|
||||||
# Commits se obtienen del último merge, listando hasta el primer forkpoint
|
# Commits se obtienen del último merge, listando hasta el primer forkpoint
|
||||||
branch = Git("show", merge_commit + "^2", patch=False, format="%H").firstline()
|
|
||||||
fork_point = Git.get_first_fork_point(branch, target)
|
fork_point = Git.get_first_fork_point(branch, target)
|
||||||
commits = Git.get_commits(fork_point, branch)
|
commits = Git.get_commits(fork_point, branch)
|
||||||
|
|
||||||
# Último tag se obtiene localmente
|
# Último tag se obtiene localmente
|
||||||
current_tag = Git.get_current_tag(suffix)
|
current_tag = Git.get_current_tag(suffix)
|
||||||
|
|
||||||
|
if promoted_tag:
|
||||||
|
next_tag = promoted_tag.removesuffix(source_suffix) + suffix
|
||||||
|
base.io_info(
|
||||||
|
f"Merge desde {source_env}: se promueve la versión {promoted_tag} a {target}."
|
||||||
|
)
|
||||||
|
|
||||||
|
# Puede existir si el destino ya llegó a esa versión por otro lado (por ejemplo, un release)
|
||||||
|
existing = api.list_tags(suffix) if api else Git("tag", next_tag, list=True).lines()
|
||||||
|
|
||||||
|
if next_tag in existing:
|
||||||
|
raise GitFlowError(f"El tag {next_tag} ya existe en {target}.")
|
||||||
|
else:
|
||||||
next_tag = get_next_tag_from_commits(
|
next_tag = get_next_tag_from_commits(
|
||||||
[c.subject for c in commits], suffix, current_tag
|
[c.subject for c in commits], suffix, current_tag
|
||||||
)
|
)
|
||||||
|
|||||||
+51
-12
@@ -1,6 +1,10 @@
|
|||||||
import subprocess
|
import subprocess
|
||||||
from dataclasses import dataclass
|
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 import FLOWCONFIG_FILENAME
|
||||||
from git_flow.io import *
|
from git_flow.io import *
|
||||||
|
|
||||||
@@ -73,6 +77,21 @@ class Git:
|
|||||||
exclude=None if suffix else "*-*",
|
exclude=None if suffix else "*-*",
|
||||||
).firstline(check=False, print="Obteniendo tag actual")
|
).firstline(check=False, print="Obteniendo tag actual")
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_promoted_tag(merge_commit: str, suffix: str) -> str | None:
|
||||||
|
"""Si el merge trae tags con el sufijo indicado que la rama destino no tenía (por ejemplo,
|
||||||
|
un merge de dev a test trae tags *-dev nuevos), devuelve el más alto de ellos."""
|
||||||
|
tags = Git(
|
||||||
|
"tag",
|
||||||
|
"v[0-9]*.[0-9]*.[0-9]*" + suffix,
|
||||||
|
list=True,
|
||||||
|
merged=merge_commit + "^2",
|
||||||
|
no_merged=merge_commit + "^1",
|
||||||
|
sort="-v:refname",
|
||||||
|
).lines()
|
||||||
|
|
||||||
|
return tags[0] if tags else None
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def get_first_fork_point(branch: str, env: str):
|
def get_first_fork_point(branch: str, env: str):
|
||||||
# Lista de commits alcanzables por el entorno (por ejemplo, dev),
|
# Lista de commits alcanzables por el entorno (por ejemplo, dev),
|
||||||
@@ -84,10 +103,14 @@ class Git:
|
|||||||
return Git("show", env_commits[-1] + "^", patch=False, format="%h").firstline()
|
return Git("show", env_commits[-1] + "^", patch=False, format="%h").firstline()
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def get_commits(base: str, branch: str) -> list[Commit]:
|
def get_commits(base: str, branch: str, first_parent: bool = True) -> list[Commit]:
|
||||||
"""Commits propios de la rama (sin merges), del más nuevo al más viejo."""
|
"""Commits propios de la rama (sin merges), del más nuevo al más viejo."""
|
||||||
lines = Git(
|
lines = Git(
|
||||||
"log", base + ".." + branch, first_parent=True, merges=False, format="%h%x09%ae%x09%s"
|
"log",
|
||||||
|
base + ".." + branch,
|
||||||
|
first_parent=first_parent or None,
|
||||||
|
merges=False,
|
||||||
|
format="%h%x09%ae%x09%s",
|
||||||
).lines()
|
).lines()
|
||||||
commits = []
|
commits = []
|
||||||
|
|
||||||
@@ -161,10 +184,13 @@ class Git:
|
|||||||
self._run(**kwargs)
|
self._run(**kwargs)
|
||||||
|
|
||||||
def _get(self, print: str | None = None, check: bool = True):
|
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:
|
if check:
|
||||||
process.check_returncode()
|
process.check_returncode()
|
||||||
@@ -174,7 +200,7 @@ class Git:
|
|||||||
def _run(self, print: str | None = None, check: bool = True):
|
def _run(self, print: str | None = None, check: bool = True):
|
||||||
return self._get(print, check)
|
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 = []
|
command = []
|
||||||
|
|
||||||
for arg in self.command:
|
for arg in self.command:
|
||||||
@@ -186,12 +212,25 @@ class Git:
|
|||||||
|
|
||||||
command.append(arg)
|
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,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|||||||
+10
-1
@@ -1,10 +1,19 @@
|
|||||||
from rich.console import Console
|
from rich.console import Console
|
||||||
from rich.prompt import Prompt, Confirm
|
|
||||||
from rich.panel import Panel
|
from rich.panel import Panel
|
||||||
|
from rich.prompt import Confirm, Prompt
|
||||||
|
|
||||||
console = Console(highlight=False)
|
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):
|
def success(msg: str):
|
||||||
console.print(f":white_check_mark: [green]{msg}[/green]")
|
console.print(f":white_check_mark: [green]{msg}[/green]")
|
||||||
|
|
||||||
|
|||||||
+50
-6
@@ -1,12 +1,16 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
import traceback
|
from subprocess import CalledProcessError, SubprocessError
|
||||||
from subprocess import SubprocessError
|
from typing import Annotated
|
||||||
|
|
||||||
|
import click
|
||||||
import typer
|
import typer
|
||||||
|
from rich.markup import escape
|
||||||
|
from rich.traceback import Traceback
|
||||||
|
|
||||||
from git_flow import GitFlowError
|
from git_flow import GitFlowError
|
||||||
from git_flow.command import base, branch, commit, init, merge, new, release, tag
|
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"
|
REPOSITORY_TOKEN_PATH = ".repository-token"
|
||||||
LOCALE = "es_AR.UTF-8"
|
LOCALE = "es_AR.UTF-8"
|
||||||
@@ -22,15 +26,55 @@ app.add_typer(release.app)
|
|||||||
app.add_typer(branch.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():
|
def main():
|
||||||
try:
|
try:
|
||||||
app()
|
app()
|
||||||
print()
|
print()
|
||||||
except GitFlowError as e:
|
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:
|
except SubprocessError as e:
|
||||||
base.io_error(str(e), title="Comando")
|
_print_error(escape(str(e)), "Comando", e)
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
base.io_error("Ejecución abortada")
|
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,
|
||||||
|
)
|
||||||
|
|||||||
@@ -74,6 +74,11 @@ class RemoteAPI(ABC):
|
|||||||
viejo), sin depender del historial local."""
|
viejo), sin depender del historial local."""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def get_merge_source_branch(self, merge_commit: str) -> str:
|
||||||
|
"""Nombre de la rama origen del PR que generó el merge commit."""
|
||||||
|
pass
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
def list_tags(self, suffix: str = "") -> list[str]:
|
def list_tags(self, suffix: str = "") -> list[str]:
|
||||||
"""Nombres de los tags del repositorio, sin orden garantizado. `suffix` es solo una pista
|
"""Nombres de los tags del repositorio, sin orden garantizado. `suffix` es solo una pista
|
||||||
|
|||||||
@@ -48,12 +48,7 @@ class BitbucketRemoteAPI(RemoteAPI):
|
|||||||
raise GitFlowError("Ocurrió un error al crear el tag: " + response.text)
|
raise GitFlowError("Ocurrió un error al crear el tag: " + response.text)
|
||||||
|
|
||||||
def get_merge_commits(self, merge_commit: str) -> list[Commit]:
|
def get_merge_commits(self, merge_commit: str) -> list[Commit]:
|
||||||
prs = self.get_json(self.get_endpoint(f"commit/{merge_commit}/pullrequests")).json()
|
pr = self._get_merge_pull_request(merge_commit)
|
||||||
pr = next((p for p in prs["values"] if p["state"] == "MERGED"), None)
|
|
||||||
|
|
||||||
if not pr:
|
|
||||||
raise GitFlowError(f"No se encontró un PR para el commit {merge_commit}")
|
|
||||||
|
|
||||||
commits: list[Commit] = []
|
commits: list[Commit] = []
|
||||||
url: str | None = self.get_endpoint(f"pullrequests/{pr['id']}/commits")
|
url: str | None = self.get_endpoint(f"pullrequests/{pr['id']}/commits")
|
||||||
|
|
||||||
@@ -77,6 +72,18 @@ class BitbucketRemoteAPI(RemoteAPI):
|
|||||||
|
|
||||||
return commits
|
return commits
|
||||||
|
|
||||||
|
def get_merge_source_branch(self, merge_commit: str) -> str:
|
||||||
|
return self._get_merge_pull_request(merge_commit)["source"]["branch"]["name"]
|
||||||
|
|
||||||
|
def _get_merge_pull_request(self, merge_commit: str) -> dict:
|
||||||
|
prs = self.get_json(self.get_endpoint(f"commit/{merge_commit}/pullrequests")).json()
|
||||||
|
pr = next((p for p in prs["values"] if p["state"] == "MERGED"), None)
|
||||||
|
|
||||||
|
if not pr:
|
||||||
|
raise GitFlowError(f"No se encontró un PR para el commit {merge_commit}")
|
||||||
|
|
||||||
|
return pr
|
||||||
|
|
||||||
def list_tags(self, suffix: str = "") -> list[str]:
|
def list_tags(self, suffix: str = "") -> list[str]:
|
||||||
names: list[str] = []
|
names: list[str] = []
|
||||||
url: str | None = self.get_endpoint("refs/tags")
|
url: str | None = self.get_endpoint("refs/tags")
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ class GiteaRemoteAPI(RemoteAPI):
|
|||||||
raise GitFlowError("Ocurrió un error al crear el tag: " + response.text)
|
raise GitFlowError("Ocurrió un error al crear el tag: " + response.text)
|
||||||
|
|
||||||
def get_merge_commits(self, merge_commit: str) -> list[Commit]:
|
def get_merge_commits(self, merge_commit: str) -> list[Commit]:
|
||||||
pr = self.get_json(self.get_endpoint(f"/commits/{merge_commit}/pull")).json()
|
pr = self._get_merge_pull_request(merge_commit)
|
||||||
url = self.get_endpoint(f"/pulls/{pr['number']}/commits")
|
url = self.get_endpoint(f"/pulls/{pr['number']}/commits")
|
||||||
items: list = []
|
items: list = []
|
||||||
page = 1
|
page = 1
|
||||||
@@ -74,6 +74,12 @@ class GiteaRemoteAPI(RemoteAPI):
|
|||||||
for c in reversed(items)
|
for c in reversed(items)
|
||||||
]
|
]
|
||||||
|
|
||||||
|
def get_merge_source_branch(self, merge_commit: str) -> str:
|
||||||
|
return self._get_merge_pull_request(merge_commit)["head"]["ref"]
|
||||||
|
|
||||||
|
def _get_merge_pull_request(self, merge_commit: str) -> dict:
|
||||||
|
return self.get_json(self.get_endpoint(f"/commits/{merge_commit}/pull")).json()
|
||||||
|
|
||||||
def list_tags(self, suffix: str = "") -> list[str]:
|
def list_tags(self, suffix: str = "") -> list[str]:
|
||||||
tags = self.get_all_pages(self.get_endpoint("/tags"), 50, size_param="limit")
|
tags = self.get_all_pages(self.get_endpoint("/tags"), 50, size_param="limit")
|
||||||
|
|
||||||
|
|||||||
@@ -44,12 +44,7 @@ class GithubRemoteAPI(RemoteAPI):
|
|||||||
raise GitFlowError("Ocurrió un error al crear el tag: " + response.text)
|
raise GitFlowError("Ocurrió un error al crear el tag: " + response.text)
|
||||||
|
|
||||||
def get_merge_commits(self, merge_commit: str) -> list[Commit]:
|
def get_merge_commits(self, merge_commit: str) -> list[Commit]:
|
||||||
prs = self.get_json(self.get_endpoint(f"/commits/{merge_commit}/pulls")).json()
|
pr = self._get_merge_pull_request(merge_commit)
|
||||||
pr = next((p for p in prs if p.get("merge_commit_sha") == merge_commit), None)
|
|
||||||
|
|
||||||
if not pr:
|
|
||||||
raise GitFlowError(f"No se encontró un PR para el commit {merge_commit}")
|
|
||||||
|
|
||||||
items = self.get_all_pages(self.get_endpoint(f"/pulls/{pr['number']}/commits"), 100)
|
items = self.get_all_pages(self.get_endpoint(f"/pulls/{pr['number']}/commits"), 100)
|
||||||
|
|
||||||
# La API los devuelve del más viejo al más nuevo
|
# La API los devuelve del más viejo al más nuevo
|
||||||
@@ -63,6 +58,18 @@ class GithubRemoteAPI(RemoteAPI):
|
|||||||
for c in reversed(items)
|
for c in reversed(items)
|
||||||
]
|
]
|
||||||
|
|
||||||
|
def get_merge_source_branch(self, merge_commit: str) -> str:
|
||||||
|
return self._get_merge_pull_request(merge_commit)["head"]["ref"]
|
||||||
|
|
||||||
|
def _get_merge_pull_request(self, merge_commit: str) -> dict:
|
||||||
|
prs = self.get_json(self.get_endpoint(f"/commits/{merge_commit}/pulls")).json()
|
||||||
|
pr = next((p for p in prs if p.get("merge_commit_sha") == merge_commit), None)
|
||||||
|
|
||||||
|
if not pr:
|
||||||
|
raise GitFlowError(f"No se encontró un PR para el commit {merge_commit}")
|
||||||
|
|
||||||
|
return pr
|
||||||
|
|
||||||
def list_tags(self, suffix: str = "") -> list[str]:
|
def list_tags(self, suffix: str = "") -> list[str]:
|
||||||
return [t["name"] for t in self.get_all_pages(self.get_endpoint("/tags"), 100)]
|
return [t["name"] for t in self.get_all_pages(self.get_endpoint("/tags"), 100)]
|
||||||
|
|
||||||
|
|||||||
@@ -49,14 +49,7 @@ class GitlabRemoteAPI(RemoteAPI):
|
|||||||
raise GitFlowError("Ocurrió un error al crear el tag: " + response.text)
|
raise GitFlowError("Ocurrió un error al crear el tag: " + response.text)
|
||||||
|
|
||||||
def get_merge_commits(self, merge_commit: str) -> list[Commit]:
|
def get_merge_commits(self, merge_commit: str) -> list[Commit]:
|
||||||
mrs = self.get_json(
|
mr = self._get_merge_request(merge_commit)
|
||||||
self.get_endpoint(f"/repository/commits/{merge_commit}/merge_requests")
|
|
||||||
).json()
|
|
||||||
mr = next((m for m in mrs if m.get("merge_commit_sha") == merge_commit), None)
|
|
||||||
|
|
||||||
if not mr:
|
|
||||||
raise GitFlowError(f"No se encontró un MR para el commit {merge_commit}")
|
|
||||||
|
|
||||||
items = self.get_all_pages(self.get_endpoint(f"/merge_requests/{mr['iid']}/commits"), 100)
|
items = self.get_all_pages(self.get_endpoint(f"/merge_requests/{mr['iid']}/commits"), 100)
|
||||||
|
|
||||||
# GitLab ya los devuelve del más nuevo al más viejo
|
# GitLab ya los devuelve del más nuevo al más viejo
|
||||||
@@ -70,6 +63,20 @@ class GitlabRemoteAPI(RemoteAPI):
|
|||||||
for c in items
|
for c in items
|
||||||
]
|
]
|
||||||
|
|
||||||
|
def get_merge_source_branch(self, merge_commit: str) -> str:
|
||||||
|
return self._get_merge_request(merge_commit)["source_branch"]
|
||||||
|
|
||||||
|
def _get_merge_request(self, merge_commit: str) -> dict:
|
||||||
|
mrs = self.get_json(
|
||||||
|
self.get_endpoint(f"/repository/commits/{merge_commit}/merge_requests")
|
||||||
|
).json()
|
||||||
|
mr = next((m for m in mrs if m.get("merge_commit_sha") == merge_commit), None)
|
||||||
|
|
||||||
|
if not mr:
|
||||||
|
raise GitFlowError(f"No se encontró un MR para el commit {merge_commit}")
|
||||||
|
|
||||||
|
return mr
|
||||||
|
|
||||||
def list_tags(self, suffix: str = "") -> list[str]:
|
def list_tags(self, suffix: str = "") -> list[str]:
|
||||||
# "search" soporta "$" para anclar al final del nombre
|
# "search" soporta "$" para anclar al final del nombre
|
||||||
params = {"search": suffix + "$"} if suffix else None
|
params = {"search": suffix + "$"} if suffix else None
|
||||||
|
|||||||
Reference in New Issue
Block a user