¿Qué es un archivo GITIGNORE y cómo se usa?

Cuando se trabaja con un repositorio de git, existe el peligro de que aparezcan datos no deseados. Afortunadamente, puede crear un archivo con una extensión GITIGNORE y definir qué archivos y carpetas deben ignorarse en el proyecto. Puede formar datos GITIGNORE globales para usar con cada repositorio de Git.

¿Qué es un archivo GITIGNORE y cómo se usa?

Cómo crear archivos GITIGNORE

Los archivos GITIGNORE son archivos de texto sin formato, por lo que puede abrirlos usando el Bloc de notas o cualquier editor de texto. A continuación se explica cómo crear un archivo GITIGNORE:

  1. Abra cualquier editor de texto y presione guardar. Cambie el nombre a .gitignore.
  2. Al editar el archivo, cada línea se reserva para una sola carpeta o un archivo que un git debe ignorar.

Utilice "#" para agregar comentarios a un archivo .gitignore

Utilice "*" para una coincidencia de comodines

Utilice # / ”para ignorar las rutas relativas al archivo GITIGNORE.

Como ejemplo, su GITIGNORE puede verse así:

# Ignore la carpeta node_modules

módulos_nodo

# Ignorar archivos relacionados con claves API

.env

# Ignorar los archivos del sistema Mac

.DS_store

# Ignore los archivos de configuración de SASS

.sass-cache

# Ignorar todos los archivos de texto

*.TXT

Como sabrá, los comentarios son opcionales.

Ignore los directorios incluyendo sus rutas y usando “/” al final de cada línea.

Por ejemplo:

pruebas/

registros /

cargas /

Si bien el símbolo comodín "*" se puede utilizar para ignorar todos los archivos con una extensión específica, puede combinarlo con el símbolo de negación "!". Aquí hay un ejemplo:

*.TXT

! readme.txt

! main.txt

Lo anterior informaría al git que ignore todos los archivos con una extensión .txt excepto readme.txt y main.txt.

Se pueden utilizar comodines para directorios. Solo tenga cuidado al usarlos, como se muestra en este ejemplo:

prueba/

! prueba / ejemplo.txt

Podría pensar que el git ahora ignorará todos los archivos dentro del directorio "test" excepto "example.txt". Sin embargo, este no es el caso. Seguirá ignorando example.txt por motivos de rendimiento, ya que hemos definido que se ignora todo el directorio de "prueba".

Tiene la opción de usar doble asterisco (**) para hacer coincidir cualquier número de directorios y archivos. Por ejemplo, Test / ** / *. Txt le dirá a git que ignore solo los archivos que terminen con .txt en el directorio de prueba y sus subdirectorios.

Archivo GITIGNORE Cómo utilizar uno

Tres formas de implementar archivos GITIGNORE

Utilice un GITIGNORE global con todos sus proyectos, ya sea con sus colegas o solo. Sin embargo, puede crear un GITIGNORE local o incluso especificar reglas de exclusión.

Crear un archivo GITIGNORE local

Hay dos formas de definir archivos GITIGNORE. Puede tener un archivo GITIGNORE a nivel de directorio o crear un archivo en la raíz. En la mayoría de los casos, GITIGNORE incluye archivos de propiedades y archivos de configuración. Cuando sus compañeros de equipo también estén extrayendo el mismo archivo GITIGNORE, asegúrese de usar "#" para agregar comentarios para mayor claridad.

Crear un archivo GITIGNORE global

Si trabaja con varios repositorios de git, puede ahorrar mucho tiempo definiendo reglas globales para sus repositorios locales.

  1. Cree el archivo GITIGNORE y defina las reglas universales que se aplicarán.
  2. Utilice la propiedad core.excludesFiles para transformar su archivo GITIGNORE local en global. Utilice la siguiente línea:

git config –global core.excludesFile

Crear reglas personales de GITIGNORE

Si tiene un repositorio específico, reglas, puede modificar los archivos GITIGNORE globales o locales. Estas reglas no se pueden compartir ni controlar con otros miembros de su grupo de trabajo. Puede usar reglas personales de GITIGNORE para sus directorios de trabajo locales o configuraciones de registrador.

Uso de archivos GITIGNORE para archivos confirmados

Ignorar archivos confirmados

Los archivos comprometidos se integran en el repositorio ya que se almacenan en caché. Si ignora estos datos, primero debe eliminarlos. El método sugerido para hacer esto es eliminar estos archivos y luego confirmar y aplicar los cambios. Una vez que haga eso, finalmente puede usar GITIGNORE definiendo una regla en la que el archivo se ignorará localmente. Agrega esta línea:

git rm –cached

De esta manera, el archivo se eliminará del repositorio aunque permanecerá en el directorio de trabajo. Un archivo GITIGNORE con esta regla debe estar en el directorio de trabajo.

Confirmar archivo anteriormente ignorado

Si desea enviar un archivo que ha sido ignorado, puede hacerlo usando la línea "git add" y la opción "force". Por ejemplo, si desea eliminar example.txt del archivo GITIGNORE mientras mantiene el repositorio comprometido t, inserte las líneas:

git add -f ejemplo.txt

git commit -m "Forzar la adición de example.txt".

Ahora ha agregado un archivo ignorado al repositorio. El paso final es modificar el archivo GITIGNORE eliminando el patrón de ignorar o la regla.

¿Qué es el archivo GITIGNORE? Cómo utilizar uno

Utilice GITIGNORE a su favor

Como los archivos GITIGNORE están presentes en casi todos los proyectos, deberá aprender a usarlos. Si bien los comandos son simples, es esencial definir sus reglas e ignorar los archivos correctos. Con el uso adecuado de GITIGNORE, ahorrará tiempo y optimizará su proyecto.

¿Con qué frecuencia necesita archivos GITIGNORE en el repositorio de git? ¿Utiliza principalmente reglas globales o locales? Comparta sus experiencias en la sección de comentarios.