Chuleta sobre GIT

Este apunte contiene mi ficha de ayuda sobre GIT: Es mi hoja recordatorio que utilizo como programador, donde tengo las comando que más utilizo. Viene bien por ejemplo cuando borro accidentalmente un fichero, quiero consultar una versión anterior de código o quiero ignorar una modificación en un archivo concreto.

Importante: Este apunte lo uso como referencia, por lo tanto asume que conoces GIT. Si necesitas saber más te recomiendo este otro apunte sobre GIT en detalle

Básicos

git config --global user.name "Don Quijote"
git config --global user.email "donquijote@email.com"

mkdir -p /home/proyectos/miproyecto
cd /home/proyectos/miproyecto
git init

cd /home/proyectos
git clone https://github.com/LuisPalacios/LuisPalacios.github.io

cd /home/proyectos/miproyecto
git status

Alias

$ git config --global alias.lo '!git --no-pager log --graph --decorate --pretty=oneline --abbrev-commit'
$ git config --global alias.lg '!git lg1'
$ git config --global alias.lg1 '!git lg1-specific --all'
$ git config --global alias.lg1-specific "log --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %s - %an %C(blue)%d%C(reset)'"

$ git lo
$ git lg

Deshacer

Técnicamente consiste en Volver a la versión anterior de un archivo de la working copy. Muy útil cuando hemos borrado o modificado un archivo por error y queremos deshacer por completo y volver a su versión anterior (la del último commit). Ojo que es destructivo, vuelve a dejar el contenido anterior del fichero y lo que hayamos modificado se pierde…

git restore Capstone/dataset/0.dataclean/datos.ipynb

GitHub CLI (`gh`)

El 95% de las veces uso el comando git para todo lo relacionado con Git, pero trabajamos mucho con GitHub y si tú también lo haces, te recomiendo instalarte GitHub CLI, es un gran invento:

brew install gh  (MacOS)
apt install gh   (Ubuntu)

Trabaja siempre estando Autenticado con un usuario concreto y todas las operaciones las realiza usando un Personal Access Token. Si tienes más de una cuenta (personal y trabajo) deberás conmutar entre ellas según el repositorio en el que te encuentras.

Configurar `ssh`

Imprescindible tener SSH bien configurado, tanto si tienes una única cuenta Personal como si tienes varias. Te recomiendo el apunte Git y SSH multicuenta si tienes varias cuentas, es imprescindible tener perfectamente operativa tu configuración SSH para que gh se comporte como esperas.

Configurar `gh` cuenta Personal

Este es el caso más habitual, solo trabajas con un usuario y lo único que necesitas es dar de alta tu PAT (Personal Access Token) e ir renovándolo cuando caduque.

Login en GitHub con mi cuenta PERSONAL (LuisPalacios)
Generate New Token (Classic) desde Settings/Developer Settings.
- El token necesita los permisos de ‘repo’, ‘read:org’, ‘admin:public_key’.

gh auth status Verifico estado (no debería estar autenticado con ningún usuario)

🍏 luis@asterix:~ % gh auth status
You are not logged into any GitHub hosts. To log in, run: gh auth login

gh auth login con mi cuenta personal, usando SSH y el token PAT del paso anterior

gh auth login con cuenta personal, SSH y PAT

Terminaste, si solo tienes una única cuenta en GitHub has terminado, puedes trabajar con gh, por ejemplo para, desde GitHub, hacer la importación de un repositorio local existente.

Configurar `gh` cuenta Profesional

Este es un caso también habitual entre los desarrolladores. Tienes un par de cuentas, una privada para tus repos y otra que usas trabajando para Organizaciones (empresas). Te recomiendo este apunte sobre gh trabajando con múltiples cuentas. Se añadió soporte a esta modalidad a partir de la v2.40.0. Ah!, aunque lo mencioné antes, te recomiendo tener bien configurado SSH en este tipo de entorno multicuenta, échale un ojo al apunte Git y SSH multicuenta.

De nuevo, necesito dar de alta mi PAT (Personal Access Token) en mi cuenta profesional, e ir renovándolo cuando caduque. Lo creo y me lo guardo.

Login en GitHub con mi cuenta PROFESIONAL (EMPRESA-Luis-Palacios)
Generate New Token (Classic) desde Settings/Developer Settings.
- El token necesita los permisos de ‘repo’, ‘read:org’, ‘admin:public_key’.

Verifico que efectivametne solo tengo dada de alta y autenticada una una única cuenta, la que configuré en el paso anterior.

🍏 luis@asterix:~ % gh auth switch
✓ Switched active account for github.com to LuisPalacios
🍏 luis@asterix:~ % gh auth status
github.com
  ✓ Logged in to github.com account LuisPalacios (keyring)
  - Active account: true
  - Git operations protocol: ssh
  - Token: ghp_************************************
  - Token scopes: 'admin:public_key', 'read:org', 'repo'

gh auth login con mi cuenta Profesional, usando SSH y el token PAT del paso anterior

🍏 luis@asterix:~ % gh auth login
? What account do you want to log into? GitHub.com
? What is your preferred protocol for Git operations on this host? SSH
? Upload your SSH public key to your GitHub account? /Users/luis/.ssh/id_ed25519_git_EMPRESA-luis-palacios.pub
? Title for your SSH key: Clave SSH EMPRESA-Luis-Palacios para GitHub CLI
? How would you like to authenticate GitHub CLI? Paste an authentication token
? Paste your authentication token: ****************************************
- gh config set -h github.com git_protocol ssh
✓ Configured git protocol
✓ SSH key already existed on your GitHub account: /Users/luis/.ssh/id_ed25519_git_EMPRESA-luis-palacios.pub
✓ Logged in as EMPRESA-Luis-Palacios

Podemos comprobar a partir de ahora en qué cuenta estamos y cambiar entre ellas

🍏 luis@asterix:~ % gh auth status
github.com
  ✓ Logged in to github.com account EMPRESA-Luis-Palacios (keyring)
  - Active account: true
  - Git operations protocol: ssh
  - Token: ghp_************************************
  - Token scopes: 'admin:public_key', 'read:org', 'repo'

  ✓ Logged in to github.com account LuisPalacios (keyring)
  - Active account: false
  - Git operations protocol: ssh
  - Token: ghp_************************************
  - Token scopes: 'admin:public_key', 'read:org', 'repo'

🍏 luis@asterix:~ % gh auth switch
✓ Switched active account for github.com to LuisPalacios
🍏 luis@asterix:~ % gh auth switch
✓ Switched active account for github.com to EMPRESA-Luis-Palacios
🍏 luis@asterix:~ % gh auth switch
✓ Switched active account for github.com to LuisPalacios

GitHub hacer importación de repositorio local

Si ya tenemos un repositorio en local, inicializado con GIT y queremos crear lo mismo en GitHub, pues solo tenemos que seguir la documentación oficial. Básicamente hay dos formas de hacerlo:

“Adding a local repository to GitHub with GitHub CLI” - Lo puedes hacer todo desde tu ordenador, previa instalación del comando gh
“Adding a local repository to GitHub using Git” - Necesitas trabajar en tu ordenador y en GitHub.

En este apunte describo la primera, con el GitHub CLI, que es la más cómoda. Tienes que instalar gh como puse arriba, Preparar GitHub CLI, y tenerlo bien configurado para tu cuenta (o cuentas) en GitHub.

Creo un repositorio local mirepo con git init

mkdir -p /Users/luis/00.git/02.github-luispa/zsh-zshrc
cd /Users/luis/00.git/02.github-luispa/zsh-zshrc
git init
e README.md
git add .
git commit -m "primer commit"

A continuación uso gh para “subir” mi repositorio local a GitHub, prefiero hacerlo de golpe en un solo comando.

cd /Users/luis/00.git/02.github-luispa/zsh-zshrc

gh repo create --description "Mi .zshrc" --remote "gh-LuisPalacios:LuisPalacios/zsh-zshrc.git" --source=. --public --push
✓ Created repository LuisPalacios/zsh-zshrc on GitHub
✓ Added remote git@github.com:LuisPalacios/zsh-zshrc.git
git@github.com: Permission denied (publickey).

La buena noticia es que el repositorio remoto se ha creado, pero no parece reconocer bien mi nombre de Host en ~/.ssh/config y se quedó a medias, no configuró bien el “remote” bajo .git/config. Termino de hacerlo manualmente

git config user.name "Luis Palacios"
git config user.email "micorreopersonal@personal.com"
git branch -M main
git remote add origin gh-LuisPalacios:LuisPalacios/zsh-zshrc.git
git push -u origin main

Github y Visual Studio Code basado en Web*

Si quieres trabajar con VSCode desde tu navegador, directamente conectado culaquier repositorio alojado en GitHub, solo tienes que reemplazar .com por .dev. Si el repositorio es tuyo (has hecho login en GitHub) entonces tendrás derechos de edición y podrás hacer commits directamente. Un par de ejemplos:

Agrupar commits en ORIGIN/main

Esto es PELIGROSO, DESACONSEJADO y solo recomendado SI TIENES MUY CLARO LO QUE ESTÁS HACIENDO. De hecho solo lo aconsejo en repo’s tuyos donde no estás colaborando, para limpiarlos (de muchos commits). A veces nos puede interesar.

El caso de uso es cuando tengo una única rama main en GitHub y solo estoy yo como desarrollador, he hecho muchos, pero que muchos commits con pequeñas modificaciones, mal documentados y quiero “limpiar” porque me encuentro con una rama main bastante sucia.

Voy a coger como ejemplo mi rama main de un proyecto llamado refrescar. Mi situación original es que mi repo tiene 48 commits y quiero hacer un squash de los últimos 45 commits (fusionar los últimos 45 commits en uno solo).
Lo curioso del tema es que esos commits están ya en ORIGIN (es decir en GitHub).
El primer paso es hacer un clone o asegurarme de que mi copia local está a la última, completamente sincronizada y sobre todo que NO HAYA NADIE (ningún otro desarrollador haciendo push a origin/main).

🍏 luis@asterix:refrescar (main) % git pull
🍏 luis@asterix:refrescar (main) % git rev-parse --short HEAD
28f5b2d
🍏 luis@asterix:refrescar (main) % git ls-remote --quiet | grep HEAD | cut -c 1-7
28f5b2d

Estos son los hash de los 48 commits...

28f5b2d  oop                 48  <== último commit
:
483583a  update gitignore    4
86dc978  update readme       3
ddea7e7  Update README.md    2
326d415  Initial commit      1er commit

Preparo el editor que usa git. Lo vamos a necesitar a continuación, durante la operación de rebase.

git config --global core.editor code
IMPORTANTE. Una vez que inicias el rebase, si ves problemas, aborta con: git rebase --abort
Empieza la fiesta, hago un rebase de los últimos 45 commits

🍏 luis@asterix:refrescar (main) % git rebase -i origin/main~45 main

Se abrirá el editor automáticamente y mostrará todos los commits, desde el tercero #86dc978 (48-45=3) hasta el último #28f5b2d.

pick   86dc978 update readme     <== 3er commit (48-45)    \
squash 483583a update gitignore                            |
:                                                           > Fusionar
squash fe1dd07 oop                                         |
squash 28f5b2d oop               <== ÚLTIMO COMMIT         /

En el editor aparecen todos los commits con la palabra pick. Ahora tengo que decidir, entre estas opciones:
- pick: Mantiene el commit tal como está.
- reword: Permite cambiar el mensaje del commit.
- edit: Permite editar el contenido del commit.
- squash: Combina este commit con el anterior, conservando ambos mensajes de commit.
- fixup: Similar a squash, pero solo guarda el mensaje del commit anterior.
- drop: Elimina el commit de la lista.
Dejo la primera línea (3er commit histórico) con pick 86dc978 y cambio todos los otros pick’s a squash. Salvo el fichero y salgo del editor. Automáticamente intenta hacer lo que le hemos pedido, pero en mi caso detecta un conflicto (esto es normal y viene bien para que veas cómo resolverlo):

🍏 luis@asterix:refrescar (main) % git rebase -i origin/main~45 main
Auto-fusionando 29-oop-rpg/src/programa.cpp
CONFLICTO (contenido): Conflicto de fusión en 29-oop-rpg/src/programa.cpp
error: no se pudo aplicar 357d14f... oop
hint: Resolve all conflicts manually, mark them as resolved with
hint: "git add/rm <conflicted_files>", then run "git rebase --continue".
hint: You can instead skip this commit: run "git rebase --skip".
hint: To abort and get back to the state before "git rebase", run "git rebase --abort".
hint: Disable this message with "git config advice.mergeConflict false"
No se pudo aplicar 357d14f... oop

Edito el fichero con el conflicto en cuestión, resuelvo los conflictos y lo salvo.

🍏 luis@asterix:refrescarA ● ●(main) rebase-i +?) % e 29-oop-rpg/src/programa.cpp

Los marco como resueltos añadiendolos y continúo con el rebase

🍏 luis@asterix:refrescarA ● ●(main) rebase-i +?) % git add .
🍏 luis@asterix:refrescarA ● ●(main) rebase-i +?) % git rebase --continue

Podriá volver a ocurrir que hay conflictos, repito los pasos…

🍏 luis@asterix:refrescar (main) % e fichero-con-conflicto...
🍏 luis@asterix:refrescar (main) % git add .
🍏 luis@asterix:refrescar (main) % git rebase --continue

Irá mostrando el editor y este proceso puede tardar un rato, depende de cuantos conflictos tengas...

Llegará un momento donde dejas de tener conflictos, verás el mensaje Rebase aplicado satisfactoriamente y actualizado refs/heads/main.

Rebase aplicado satisfactoriamente y actualizado refs/heads/main.
🍏 luis@asterix:refrescar (● main ↕) % git status
En la rama main
Tu rama y 'origin/main' han divergido,
y tienen 1 y 46 commits diferentes cada una respectivamente.
  (use "git pull" if you want to integrate the remote branch with yours)

nada para hacer commit, el árbol de trabajo está limpio

Ahora llegamos al punto crítico. Vamos a mandar a ORIGIN/main nuestra copia haciendo un FORCE PUSH

🍏 luis@asterix:refrescar (● main ↕) % git push origin +main
Enumerando objetos: 117, listo.
Contando objetos: 100% (117/117), listo.
Compresión delta usando hasta 12 hilos
Comprimiendo objetos: 100% (105/105), listo.
Escribiendo objetos: 100% (114/114), 30.13 KiB | 10.04 MiB/s, listo.
Total 114 (delta 19), reused 82 (delta 8), pack-reused 0 (from 0)
remote: Resolving deltas: 100% (19/19), completed with 1 local object.
To github.com-LuisPalacios:LuisPalacios/refrescar.git
 + 5a42ca6...96b4c8d main -> main (forced update)

Muestro el log de mis commits

🍏 luis@asterix:refrescar (main) % git log --all --decorate --oneline --graph
* 96b4c8d (HEAD -> main, origin/main, origin/HEAD) Commit agregado de 45 commits final
* ddea7e7 Update README.md
* 326d415 Initial commit

El repo queda ya con solo 3 commits !!

Los commits que han quedado son:

96b4c8d  Commit agregado de 45 commits     3er  <== COMMIT que agrega todo
ddea7e7  Update README.md                  2o
326d415  Initial commit                    1er commit


Nota: ATENCIÓN !!!! Es muy importante que el resto de desarrolladores borren su copia local o hagan un reset de su clone actual

Si otro desarrollador hace un push (–force) desde una rama local (antigua) volverán a aparecer todos los commits. La recomendación es volver a hacer una de las opciones siguientes:

Borrar el repositorio local y volver a hacer un clone
Reset del respositorio local y pull. A continuación muestro un ejemplo, tenía el repositorio ANTIGUO copiado en “refrescar.old”

🍏 luis@asterix:refrescar.old (● main ↕) % git reset --hard origin/main
HEAD está ahora en 96b4c8d Commit agregado de 45 commits final
🍏 luis@asterix:refrescar.old (main) % git clean -xdf
🍏 luis@asterix:refrescar.old (main) % git pull
Ya está actualizado.

🍏 luis@asterix:refrescar.old (main) % git log --all --decorate --oneline --graph
* 96b4c8d (HEAD -> main, origin/main, origin/HEAD) Commit agregado de 45 commits final
* ddea7e7 Update README.md
* 326d415 Initial commit

Cambiar Autor de commits

Esto es PELIGROSO, DESACONSEJADO y solo recomendado SI TIENES MUY CLARO LO QUE ESTÁS HACIENDO. El caso de uso es cuando tenemos muy claro que el nombre (y/o email) del autor de commits es erroneo.

Usaremos el comando git filter-branch que reescribe el historial del repositorio, por lo que debes tener cuidado y hacer un respaldo del repositorio antes de realizar estos cambios.

Repasar commit

Para averiguar el mail con el que se hizo un determinado commit:

git show -s --format='%ae' <HASH corto del commit>

Para repasar quién hizo los commits:

git log --pretty=format:"%h %ce %ae"| grep -i <nombre o email>

Renombrar autor/email de los commit

Navega a tu repositorio y asegúrate que lo tienes actualizado

cd /ruta/al/repositorio/mirepo
git pull

Te recomiendo que hagas una copia de seguridad

cp -r /ruta/al/repositorio/mirepo /ruta/al/respaldo/mirepo.bak

Utiliza git filter-branch para cambiar el nombre + email del autor en todos los commits:

git filter-branch --env-filter '
OLD_EMAIL="email_incorrecto@ejemplo.com"
CORRECT_NAME="Nombre Correcto"
CORRECT_EMAIL="email_correcto@ejemplo.com"

if [ "$GIT_COMMITTER_EMAIL" = "$OLD_EMAIL" ]
then
    export GIT_COMMITTER_NAME="$CORRECT_NAME"
    export GIT_COMMITTER_EMAIL="$CORRECT_EMAIL"
fi
if [ "$GIT_AUTHOR_EMAIL" = "$OLD_EMAIL" ]
then
    export GIT_AUTHOR_NAME="$CORRECT_NAME"
    export GIT_AUTHOR_EMAIL="$CORRECT_EMAIL"
fi
' --tag-name-filter cat -- --branches --tags

El comando anterior crea una copia de seguridad bajo .git/refs/original/*. Es muy buena idea tenerla para el caso de que hayas hecho algo mal. Recomiendo inspeccionar que todo ha ido bien, con el comando siguiente:

git log

Una vez revisado, haz push de los cambios al repositorio remoto

git push --force --tags origin 'refs/heads/*'

Cuando terminas y estas seguro de que todo está bien puedes eliminar la copia de seguridad de la referencia (en mi caso, en este ejemplo el nombre de la rama es main)

git update-ref -d refs/original/refs/heads/main