Cómo utilizar .gitignore: Una introducción práctica con ejemplos

Sintaxis de .gitignore

Como ya hemos dicho, los archivos .gitignore contienen patrones que se comparan con los nombres de archivo de tu repositorio para determinar si deben ser ignorados o no.

Sintaxis básica

En esencia, el archivo .gitignore consta de líneas, cada una de las cuales representa un patrón que debe ignorarse. Los patrones pueden coincidir:

• Ficheros específicos
• Tipos de archivos
• Directorios 

El archivo también admite comentarios, que pueden añadirse iniciando una línea con #, y líneas en blanco para mejorar la legibilidad.

Aquí tienes un resumen de la estructura básica:

• Ignorar un archivo concreto: Puedes listar directamente el nombre del archivo para ignorarlo.

secrets.txt

• Ignora un directorio entero: Añadiendo un / al final del nombre del directorio, puedes ignorar todo lo que haya dentro de ese directorio.

logs/

• Ignora todos los archivos de un tipo específico: Se pueden utilizar comodines (*) para ignorar todos los archivos con una extensión determinada.

*.py

• Negación: Puedes utilizar ! para negar un patrón y rastrear explícitamente determinados archivos o directorios que, de otro modo, se ignorarían.

*.txt  # Ignores all .txt files
!readme.txt  # Except for readme.txt

Cómo crear y utilizar un archivo .gitignore

Crear y utilizar .gitignore es bastante sencillo. En esta sección, recorreré los pasos.

Crear un archivo .gitignore

Paso 1: Navega hasta la raíz de tu repositorio. El archivo .gitignore suele colocarse en el directorio raíz de un proyecto Git. Abre tu terminal o línea de comandos y navega hasta el directorio raíz de tu repositorio Git:

cd /path/to/your/repo

Paso 2: Crea el archivo .gitignore. Una vez en el directorio raíz, crea el archivo .gitignore utilizando cualquier editor de texto o ejecutando un comando en el terminal, como por ejemplo

touch .gitignore

Paso 3: Añade patrones al archivo. Abre el archivo .gitignore en un editor de texto y añade los patrones necesarios para ignorar archivos o directorios. Cada línea representa un patrón diferente.

Aquí tienes un ejemplo de archivo .gitignore utilizado habitualmente en un proyecto básico:

# Ignore node_modules and dependency directories
node_modules/
vendor/

# Ignore build artifacts
dist/
build/
*.log

# Ignore system-generated files
.DS_Store
Thumbs.db

# Ignore environment and secret files
.env
config.json

Cuando hayas añadido los patrones necesarios, guarda el archivo. Ahora Git ignorará automáticamente estos archivos al preparar o confirmar cambios.

Paso 4: Consigna el archivo en el repositorio. Es importante enviar el archivo .gitignore al repositorio para que todos los colaboradores utilicen las mismas reglas de ignorar. Esto garantiza la coherencia en todo el proyecto para todos los implicados.

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

Una vez confirmado el archivo .gitignore, establece reglas de ignorar compartidas para todo el equipo.

¿Quieres dominar el push y el pull en Git? Aprende a sincronizar tu trabajo con repositorios remotose en este tutorial Git push and pull.

Buenas prácticas para utilizar .gitignore

Aunque crear un archivo .gitignore es una parte sencilla del mantenimiento de un repositorio Git limpio, deben seguirse varias buenas prácticas para garantizar que el archivo se gestiona eficazmente a lo largo del tiempo.

Utiliza un .gitignore global

Para los desarrolladores que trabajan en varios proyectos, hay archivos específicos que tal vez quieras excluir de cada repositorio, independientemente del tipo de proyecto.

En lugar de añadirlos al archivo .gitignore de cada proyecto, puedes configurar un .gitignore global que se aplique a todos los repositorios de tu sistema.

Para configurar un archivo global .gitignore:

• Crea un archivo .gitignore_global:

touch ~/.gitignore_global

• Añade patrones para los archivos que quieras ignorar globalmente, como por ejemplo

.DS_Store
*.log
/.vscode/
/.idea/

• Configura Git para que utilice la dirección global .gitignore:

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

Aprovecha las plantillas existentes

En lugar de crear un archivo .gitignore desde cero para cada nuevo proyecto, puedes aprovechar las plantillas preconfiguradas de .gitignore para lenguajes, frameworks o entornos específicos.

Uno de los mejores recursos para estas plantillases el repositorio oficial .gitignore de GitHub, donde puedes encontrar archivos .gitignore adaptados a cientos de lenguajes de programación y frameworks.

Revisa .gitignore regularmente

A medida que los proyectos evolucionan, puede ser necesario incluir nuevos archivos y directorios en el archivo .gitignore. Es importante que revises y actualices periódicamente tu archivo para reflejar el estado actual de tus proyectos.

Algunas situaciones en las que podrías necesitar actualizar el archivo .gitignore son:

• Adoptar nuevas herramientas o bibliotecas que generen archivos adicionales (por ejemplo, cambiar a un nuevo sistema de compilación).
• Refactorizar o reorganizar directorios, lo que puede dar lugar a nuevos archivos que deben excluirse.
• Eliminar archivos o directorios obsoletos que ya no forman parte del proyecto.

Solución de problemas de .gitignore

Incluso después de configurar un archivo .gitignore, puedes encontrarte con situaciones en las que se rastrean archivos específicos, o los patrones no parecen funcionar como se esperaba. Esta sección cubrirá dos áreas comunes de solución de problemas y cómo resolverlas.

Seguimiento de archivos ya comprometidos 

El archivo .gitignore no se aplica retroactivamente a los archivos ya confirmados. 

Si añades un patrón a .gitignore después de que ciertos archivos ya hayan sido confirmados, Git seguirá rastreándolos aunque coincidan con el patrón del archivo .gitignore.

Para dejar de rastrear archivos que ya han sido confirmados, sigue estos pasos:

• Elimina los archivos del seguimiento de Git: Utiliza el comando git rm para eliminarlos del repositorio mientras los mantienes en tu directorio de trabajo.

git rm --cached <file_or_directory_name>

• Confirma los cambios: Tras eliminar los archivos del seguimiento de Git, confirma los cambios para asegurarte de que los archivos ya no forman parte del historial del control de versiones.

git commit -m "Stop tracking ignored files"

• Empuja los cambios al repositorio remoto: Por último, empuja los cambios al repositorio remoto para asegurarte de que los archivos dejan de ser rastreados.

git push

Tras realizar estos pasos, Git dejará de rastrear los archivos. El archivo confirmado seguirá estando en tu directorio de trabajo, pero será ignorado por futuras confirmaciones basadas en tus patrones de .gitignore.

Asegúrate de que los patrones funcionan 

A veces, puedes notar que determinados archivos que esperabas que se ignoraran siguen apareciendo en el estado de Git o están siendo rastreados. 

Sigue estos pasos para asegurarte de que tus patrones .gitignore funcionan correctamente:

• Comprueba el estado de tus archivos: Utiliza el comando git status para ver qué archivos están siendo rastreados por Git. Esto te ayudará a verificar si tus archivos ignorados siguen apareciendo en la lista.

git status

• Asegúrate de que el patrón es correcto: Comprueba dos veces la sintaxis de tus patrones .gitignore para asegurarte de que están formateados correctamente. Por ejemplo:
• Asegúrate de que utilizas la ruta de directorio correcta (relativa a la raíz del repositorio).
• Añade un / para dirigirte a directorios específicos y evitar rastrear todos los archivos con nombres similares.

• Actualiza la caché: Si has actualizado recientemente tu archivo .gitignore y los cambios no se aplican, puede que Git se esté aferrando a su caché anterior. Para refrescar la caché, ejecuta el siguiente comando:

git rm -r --cached .
git add .
git commit -m "Refresh .gitignore"

• Comprueba si hay excepciones: A veces, un patrón específico en .gitignore puede ser anulado por un patrón más específico en otra parte del archivo. Revisa tus reglas para asegurarte de que no hay patrones conflictivos.

¿Buscas una referencia Git rápida? Mantén los comandos esenciales al alcance de tu dedoertips with this Git cheat sheet.

Conclusión

Un archivo .gitignore puede parecer pequeño, pero desempeña un papel enorme a la hora de mantener tu repositorio Git limpio y manejable. Al ignorar los archivos innecesarios -como dependencias, artefactos de compilación y archivos generados por el sistema- te aseguras de que tu proyecto permanece organizado y libre de desorden.

En este tutorial, has aprendido a crear un archivo .gitignore, añadir patrones y aplicar las mejores prácticas para mantener la eficiencia de tu repositorio. Con estas habilidades, evitarás los quebraderos de cabeza del control de versiones y harás que la colaboración sea más fluida para todos los miembros de tu equipo.

Si quieres profundizar en tus conocimientos de Git, consulta Fundamentos de Git para seguir una ruta de aprendizaje estructurada. También puedes explorar cursos prácticos como Fundamentos de Git e Introducción a los Conceptos de GitHub para construir una sólida comprensión del control de versiones y los flujos de trabajo de colaboración.