Cómo usar .gitignore: una guía paso a paso

En Git, el archivo .gitignore es una herramienta esencial que te ayuda a gestionar qué archivos y directorios se incluyen en tu repositorio de control de versiones. Al usar .gitignore, los desarrolladores pueden evitar que se rastreen archivos innecesarios, como archivos de registro, dependencias o archivos específicos del sistema. Esta guía explica cómo crear y utilizar un archivo .gitignore de forma eficiente.

El archivo .gitignore le indica a Git qué archivos o directorios debe ignorar en un proyecto. Permite a los desarrolladores excluir archivos que no son necesarios para el proyecto, ayudando a mantener un historial de versiones más limpio y eficiente.

Por qué usar .gitignore

Copiar enlace

• Evitar desorden: evita que archivos grandes o innecesarios saturen tu repositorio.

• Privacidad: mantiene fuera del control de versiones información sensible como claves API, credenciales o archivos de configuración.

• Eficiencia: agiliza la colaboración asegurando que solo se rastreen y compartan los archivos esenciales.

Crear un archivo .gitignore

Copiar enlace

Crear un archivo .gitignore es sencillo.

1. Navega a tu repositorio Git.

Abre tu terminal y navega al directorio raíz de tu proyecto Git.

cd /path/to/your/git/project

2. Crea el archivo .gitignore.

Puedes crear el archivo con el siguiente comando:

touch .gitignore

3. Abre y edita el archivo .gitignore.

Abre el archivo .gitignore en tu editor de texto y añade los archivos o directorios que deseas que Git ignore. Por ejemplo:

# Ignorar la carpeta node_modules
node_modules/

# Ignorar archivos de registro
*.log

# Ignorar archivos .env
.env

4. Guarda y confirma los cambios.

Después de editar, guarda el archivo .gitignore y confirma los cambios en Git.

git add .gitignore
git commit -m "Add .gitignore"

Patrones comunes en .gitignore

Copiar enlace

Existen varios patrones comunes utilizados en los archivos .gitignore para especificar archivos o directorios que deben excluirse. A continuación, se muestran algunos ejemplos de patrones frecuentemente utilizados.

Ignorar archivos por extensión:

*.log   # Ignorar todos los archivos de registro
*.tmp  # Ignorar todos los archivos temporales
*.swp  # Ignorar archivos swap creados por editores de texto

Ignorar directorios específicos:

/logs/   # Ignorar el directorio logs
/temp/   # Ignorar el directorio temp

Ignorar archivos ocultos:

.*   # Ignorar todos los archivos ocultos que empiezan con un punto (p. ej., .DS_Store)

Ignorar archivos en una carpeta específica:

/docs/*.pdf   # Ignorar todos los archivos PDF dentro de la carpeta docs

Negar un patrón (incluir archivos que previamente habían sido excluidos):

*.pdf    # Ignorar todos los archivos PDF
!resume.pdf # No ignorar resume.pdf

Ignorar archivos globalmente vs. localmente

Copiar enlace

Aunque .gitignore normalmente se crea en la raíz de tu repositorio, también puedes configurar Git para ignorar archivos globalmente, lo que se aplica a todos los repositorios en tu máquina.

Ignorar archivos localmente

Copiar enlace

Si deseas excluir archivos solo en tu repositorio actual, simplemente edita el archivo .gitignore dentro de ese proyecto. Esto asegura que la exclusión se aplique únicamente a ese repositorio.

Ignorar archivos globalmente

Copiar enlace

Para crear un archivo .gitignore global, que se aplique en todos tus repositorios, sigue estos pasos:

1. Crea un archivo .gitignore global:

touch ~/.gitignore_global

2. Añade patrones al archivo .gitignore global:

Edita el archivo e incluye patrones para los archivos que deseas ignorar globalmente. Por ejemplo:

*.log
*.tmp
.DS_Store

3. Configura Git para usar el archivo .gitignore global:

git config --global core.excludesfile ~/.gitignore_global

Mejores prácticas para usar .gitignore

Copiar enlace

Para aprovechar al máximo .gitignore, sigue estas buenas prácticas:

• Añade .gitignore desde el inicio

Crea un archivo .gitignore tan pronto como inicies un proyecto para evitar que se rastreen archivos innecesarios.

• Mantén el archivo organizado

Organiza tu .gitignore agrupando patrones relacionados y añadiendo comentarios. Por ejemplo:

# Archivos generados por el sistema operativo
.DS_Store
Thumbs.db

# Dependencias de Node.js
node_modules/

• No confirmes información sensible

Usa .gitignore para asegurarte de que archivos privados como claves API y configuraciones sensibles no se confirmen accidentalmente en el control de versiones.

• Prueba tu .gitignore

Utiliza git status para verificar si tu archivo .gitignore está excluyendo archivos correctamente. Si un archivo aún se rastrea, es posible que haya sido añadido al repositorio antes de ser ignorado.

Solución de problemas con .gitignore

Copiar enlace

A veces, archivos que deberían ser ignorados siguen siendo rastreados. A continuación, se presentan algunas causas comunes y sus soluciones.

Archivos ya rastreados

Copiar enlace

Si un archivo fue añadido al repositorio antes de incluirlo en .gitignore, Git continuará rastreándolo. Para dejar de rastrear el archivo:

1. Elimina el archivo de Git sin borrarlo localmente:

git rm --cached filename

2. Añade el archivo a .gitignore.

3. Confirma el .gitignore actualizado y la eliminación del archivo en caché:

git commit -m "Update .gitignore and remove cached files"

Problemas de mayúsculas y minúsculas

Copiar enlace

Git distingue entre mayúsculas y minúsculas, así que asegúrate de que los patrones en tu archivo .gitignore coincidan exactamente con el nombre del archivo.

Por ejemplo:

file.txt # Ignora file.txt pero no File.txt

Probar con git check-ignore

Para verificar si un archivo está siendo ignorado correctamente, puedes usar el comando git check-ignore:

git check-ignore -v filename

Este comando muestra la regla responsable de ignorar un archivo determinado.

Conclusión

Copiar enlace

Usar .gitignore de manera efectiva te permite gestionar qué archivos se incluyen en tu repositorio Git y garantiza que solo se rastreen los archivos esenciales. Sigue los pasos de esta guía para crear, personalizar y solucionar problemas de tu archivo .gitignore y así mantener una gestión de versiones eficiente.