5 tipos de archivos para incluir en su .gitignore

El control de versiones es una herramienta vital para realizar un seguimiento de los cambios en su base de código, pero no siempre desea realizar un seguimiento de todos los archivos.

Para evitar el desorden y reducir el riesgo de distribuir información confidencial, puede usar un archivo llamado .gitignore. Este archivo especifica qué archivos y directorios Git no debe indexar.

Determinar qué archivos incluir en .gitignore puede ser un desafío, especialmente si es nuevo en el desarrollo. Descubra qué archivos debe agregar a su .gitignore para un flujo de trabajo de Git más fluido.

Crear un archivo .gitignore

Para que su archivo .gitignore tenga algún efecto, debe tener Git inicializado en su proyecto.

Puede inicializar Git ejecutando el siguiente comando en su terminal:

iniciar git

Este comando crea un nuevo repositorio Git para su proyecto, en un subdirectorio oculto ".git" que contiene todos los archivos y directorios que necesita para controlar la versión de su proyecto.

Para ejecutar este comando, debe tener Git instalado en tu sistema.

A continuación, cree su archivo .gitignore ejecutando el siguiente comando:

tocar.gitignore

Ejecutar el comando anterior crea un nuevo archivo, ".gitignore" en su directorio actual. Puede excluir un archivo de Git agregando el nombre del archivo o la ruta del archivo (si el archivo está en un directorio diferente del .gitignore archivo).

Git no necesita realizar un seguimiento de todos los archivos de su proyecto, y el seguimiento de algunos archivos puede generar problemas imprevistos. Estos son algunos de los archivos que debe agregar a su .gitignore.

1. Archivos de configuración

Los archivos de configuración almacenan configuraciones y otros parámetros que sus aplicaciones usan para definir y personalizar su comportamiento. Estos archivos suelen almacenar cadenas de conexión de bases de datos, claves de API y otra información confidencial que no debe exponer en su repositorio de Git.

Si incluye archivos de configuración en su repositorio, cualquiera que pueda acceder a él puede ver su contenido. Eso puede incluir información confidencial, lo que puede conducir a violaciones de seguridad y otros problemas.

Para excluir archivos de configuración de su repositorio de Git, agregue nombres de archivos o nombres de carpetas específicos a su .gitignore archivo.

Por ejemplo, puede agregar la siguiente línea a su .gitignore archivo para ignorar un .env archivo.

.env

2. Construir artefactos

Los artefactos de compilación son los archivos compilados o generados que se producen cuando compila su proyecto. Estos archivos normalmente viven en un "objetivo" o "construir" directorio.

Los artefactos de compilación pueden incluir clases Java compiladas, archivos JAR, archivos WAR, archivos binarios, paquetes de distribución, informes, archivos de registro y otros generados durante el proceso de compilación.

Por lo general, es una buena práctica excluir los artefactos de compilación de su repositorio de Git porque pueden ser muy grandes. También pueden ser menos portátiles que sus archivos de origen, solo relevantes para un entorno específico. Incluirlos en su repositorio puede aumentar el tamaño de su repositorio y hacerlo más lento para clonar y trabajar con ellos.

Para excluir artefactos de compilación de su repositorio de Git, agregue el "objetivo/" o "construir/" directorio a su .gitignore archivo.

Por ejemplo:

# .gitignore
objetivo/
construir/

3. Archivos del entorno de desarrollo integrado

Los archivos del entorno de desarrollo integrado (IDE) son archivos de configuración, metadatos del proyecto y otros archivos generados por su IDE cuando crea o abre un proyecto. Estos archivos son específicos para cada IDE. Su IDE utiliza estos archivos para configurar los ajustes del proyecto.

Estos archivos no son necesarios para compilar o ejecutar su aplicación y, a menudo, pueden causar problemas si se envían a un repositorio Git compartido. Por ejemplo, diferentes personas en su equipo pueden usar diferentes IDE o versiones, y enviar archivos específicos de IDE podría causar conflictos de combinación y dificultar la colaboración en el proyecto.

Dado que estos archivos son específicos de IDE, los archivos a incluir en su .gitignore archivo dependerá de su IDE. Aquí están Recomendaciones de .gitignore de GitHub para algunos IDE populares. Puede buscar el IDE de su elección y agregar los archivos descritos a su .gitignore archivo.

4. Archivos de paquetes y dependencias

Los archivos de dependencias y paquetes son archivos que contienen información sobre las dependencias y los paquetes utilizados por su aplicación. Varias herramientas de construcción, como el administrador de paquetes de nodos (npm), genere estos archivos.

Por ejemplo, si usa npm para administrar dependencias para un proyecto de JavaScript, creará un "node_modules" carpeta en el directorio raíz de su proyecto. El directorio contiene todas las dependencias instaladas para su proyecto.

Este directorio puede volverse muy grande, especialmente si su proyecto tiene muchas dependencias o algunas dependencias tienen archivos de gran tamaño. Al excluir el "node_modules" de su repositorio de Git, puede mantenerlo limpio y reducir su tamaño.

Para evitar agregar el "node_modules" a su repositorio de Git, agregue su nombre a su archivo .gitignore:

#.gitignore
node_modules/

5. Archivos del sistema operativo

Su sistema operativo y otras herramientas del sistema pueden generar archivos a través del uso normal. Estos pueden incluir archivos de registro, archivos temporales y archivos de configuración del sistema. Un ejemplo es el Pulgares.db archivo en Windows y su equivalente macOS, el .DS_Tienda archivo.

Por lo general, es una buena práctica excluir los archivos del sistema operativo de su repositorio de Git, ya que son específicos de su entorno local y pueden diferir entre diferentes computadoras y sistemas operativos. sistemas

GitHub ha recomendado las pautas de .gitignore para ventanas, Mac OS, y linux.

La importancia del control de versiones

El uso del control de versiones puede mejorar significativamente su flujo de trabajo y reducir los errores y conflictos que pueden surgir al trabajar en una base de código. Con el control de versiones, puede rastrear fácilmente los cambios de código, revisarlos y colaborar con los miembros del equipo sin problemas.

Sin embargo, siempre debe excluir ciertos archivos, como los archivos de configuración, los archivos IDE y los archivos del sistema operativo. Esto mantendrá bajo el tamaño de su repositorio y garantizará que no filtre información confidencial.