El fichero .gitignore de un proyecto nos permite determinar qué ficheros deben incluirse en el repositorio de un proyecto y cuales deben ser ignorados.
Aprende qué ficheros y directorios deben incluirse en el repositorio de un proyecto Magento y cómo crear un fichero .gitignore óptimo.
Beneficios de un fichero .gitignore óptimo
Al comienzo de cada proyecto, es importante diseñar un fichero .gitignore óptimo que especifique que ficheros deben incluirse en el repositorio de código y que ficheros deben excluirse.
Construir un fichero .gitignore óptimo ofrece múltiples beneficios:
- Evita que se incluyan archivos innecesarios en el repositorio, lo que reduce su tamaño y facilita la gestión de versiones.
- Evita que se incluyan archivos sensibles que puedan incluir contraseñas, credenciales, etc.
- Mejora la claridad y organización del código del proyecto, facilitando el mantenimiento y actualización en el futuro.
Qué se debe incluir en un repositorio Magento
Qué se debe incluir
- Módulos personalizados:
- /app/code
- Temas personalizados:
- /app/design
- Ficheros de configuración:
- /app/etc/config.php
- Ficheros de dependencias:
- /composer.json
- /composer.lock
- /package.json
- Ficheros de documentación:
- /README.md
Qué se debe excluir
- Ficheros generados por Composer:
- /bin
- /dev
- /lib
- /phpserver
- /setup
- /vendor
- Ficheros generados por Magento:
- /generated
- /pub
- /var
- Ficheros con información sensible:
- /app/etc/env.php
- /auth.json
Fichero .gitignore para Magento
A continuación se incluye una plantilla de fichero .gitignore para proyectos Magento que sigue las pautas explicadas anteriormente, aunque siempre conviene realizar las adaptaciones necesarias para las particularidades de cada proyecto:
/*
!/app
/app/*
!/app/code
!/app/design
!/app/etc
/app/etc/*
!/app/etc/config.php
/bin/*
/dev/*
/generated/*
/lib/*
/phpserver/*
/pub/*
/setup/*
/var/*
/node_modules/*
/vendor/*
!/.gitignore
!/README.md
!/composer.json
!/composer.lock
!/package.json
