cómo usar GitLab desde la línea de comandos

Encontré glab ¹ que es una CLI de GitLab para usar desde la terminal, y si bien es muy completa ², me topé con una dificultad y es que necesitaba utilizar una instancia de GitLab detrás de una VPN dentro de una red aislada de INET y por ello, en principio no había manera de llegar directamente, o al menos no encontré como configurar a glab.

Se me ocurrió hacer un wrapper llamado gl que esencialmente solo habilitaba el uso de la variable https_proxy y mediante LocalForward de ssh pude redireccionar un puerto local 127.0.0.1:3128 a un Proxy HTTP que puede llegar a la instancia de GitLab

localhost -> vpn -> proxy-http -> gitlab

Con el pasar de los días, fui generando una serie de scripts que simplificaban y/o permitían automatizar a glab extendiendo de cierta manera su funcionalidad con el comando gl, el cual es invocado desde muchos comandos específicos, algunos muy simples, pero que ayudan a usar la misma metodología e integrar GitLab con otras tools propias.

La primer necesidad a cubrir fue el registro de tiempos de cada issue, algo que anteriormente al usar Redmine ³ había resuelto con redmine-bash-utils ⁴ y ahora daría origen a glab-bash-utils ⁵

Si bien GitLab utiliza el formato /spend 00h25m, mi script gl-issue-spend espera recibir el formato 00:25 y obviamente lo convierte, el porqué?, es simple, desde el 2008 que a todos mis commits en la última línea del mensaje agrego el tiempo que tardé, de la siguiente manera @ 00:25 hs, entonces puedo usar pipe | para recuperar el tiempo registrado en el commit e enviárselo a GitLab.

Ejemplo:

# git log -1

  commit 6b3f0285abe9847124b17c2f9c4523f6caa01df4
  Author: OSiRiS <osiris@gcoop.coop>
  Date:   Sat Aug 20 11:21:33 2022 -0300

      gl-config: add GL_DEFAULT_REVIEWER: admin as config example

        @ 00:01 hs

# git log -1 | gl-issue-spend 14

  send /spend 01m to 14

Trabajar con formato hh:mm permite fácilmente hacer operaciones de suma y resta de tiempos.

Desde 2017 que utilizo jrnl ⁶ para registrar el desarrollo de cada tarea, a veces es un simple paste luego del copy, pero muchas veces, hay un paso a paso muy detallado y ordenado que vale la pena compartirlo en forma de comentario de un issue y como ahí tengo registrado el tiempo invertido, es muy fácil enviarlo a GitLab y en este caso ni siquiera debo indicar el ID del issue porque ya es parte del header del journal, entonces basta con ejecutar

jv | glin

• jv es un alias de jrnl view
• glin es un alias de gl-issue-note

jv

2022-08-20 15:40 @gcoop-libre gitlab-bash-utils#14 gl-mr-new: set reviewer with default reviewer or assignee when default is empty

  @ 00:01 hs

Un flujo común de trabajo usando jrnl y gl es el siguiente:

Ahora para crear issues no necesito utilizar Firefox, lo puedo hacer desde BASH invocando a gl-issue-new (o usando el alias gliw) de la siguiente manera:

gl-issue-new 'publish first public version' 'commit actual state of scripts art'

  - Creating issue in gcoop-libre/gitlab-bash-utils
  #1 publish first public version (less than a minute ago)
   https://gitlab.com/gcoop-libre/gitlab-bash-utils/-/issues/1

Una gran utilidad de GitLab es crear un MR por cada Branch para poder realizar una revisión de código antes de terminar un feature, hotfix o un nuevo release y utilizando gl-mr-new basta con indicar el ID del issue y el MR se crea con una serie de valores por defecto que aceleran la operatoria:

El comando glab permite definir alias en el archivo ~/.config/glab-cli/aliases.yml, y los que definí son los siguientes:

ci: pipeline ci
co: mr checkout
ic: issue close
il: issue list
in: issue note
iu: issue update
iv: issue view
iw: issue new
ma: mr approve
mc: mr close
ml: mr list
mv: mr view
my: mr ready

Entonces si tipeo gl ic 14 voy a cerrar el issue 14.

En cambio para el comando gl, los alias se definen en gl-src-alias y entonces si tipeo glic 14 el resultado es el siguiente:

- [ ] gl-mr-new: set reviewer with default reviewer or assignee when default is empty [gitlab-bash-utils#14](https://gitlab.com/gcoop-libre/gitlab-bash-utils/-/issues/14)

Obtengo un checkbox del issue 14 con su descripción un link en formato Markdown, ésto me resulta muy útil para organizarme al registrar estado de las tareas en una minuta.

El 2022-08-04 liberé la primer versión pública con el tag v0.1.0 y desde entonces, acepto sugerencias y parches, aunque ya registré varios issues ⁷ por resolver sigo trabajando en mejoras a medida que las voy necesitando.

• tarea en progreso
• git commit timesum

• 2023-06-26 22:03 agregar DESCRIPTION, KEYWORDS y actualizar OpenGraph en Cómo usar GitLab desde la línea de comandos
• 2022-11-13 20:39 agregar y actualizar tags OpenGraph
• 2022-10-11 10:05 agregar cómo usar GitLab desde la línea de comandos