Código

Mejores prácticas para configuración y versionamiento de código

Virgílio Borges

15 de feb. de 2024 • 9 min read

En el desarrollo de software, la gestión de la configuración y el control de versiones del código son esenciales para garantizar la integridad, la colaboración y la eficiencia del proyecto. El uso de prácticas adecuadas en estos aspectos permite a los desarrolladores tener control sobre los cambios, realizar un seguimiento de los problemas, trabajar en colaboración y ofrecer software de calidad.

En este artículo, exploraremos algunas de las mejores prácticas para la gestión de la configuración y el control de versiones del código, presentando comandos y herramientas de ejemplo que ayudarán a los desarrolladores a aplicarlos de manera efectiva.

1. Utiliza un Sistema de Control de Versión

Un sistema de control de versiones es la base para una gestión eficiente del código fuente. Le permite realizar un seguimiento de los cambios realizados en el código a lo largo del tiempo, proporcionando un historial completo y la capacidad de restaurar versiones anteriores si es necesario.

Git es un sistema de control de versiones ampliamente utilizado debido a su flexibilidad y eficiencia. Además, ofrece funciones potentes como fusión de sucursales y trabajo sin conexión. Sin embargo, existen otras opciones, como Subversion (SVN) o Mercurial, que se pueden considerar dependiendo de las necesidades del proyecto.

Git es uno de los más populares en la actualidad, debido a su flexibilidad, velocidad y amplia adopción por parte de la comunidad de desarrolladores. Está distribuido, lo que significa que cada desarrollador tiene una copia local completa del repositorio, lo que les permite trabajar sin conexión y realizar confirmaciones locales antes de enviar cambios al repositorio central.

Subversion, por otro lado, es un sistema de control de versiones centralizado donde todos los desarrolladores se conectan a un servidor central para realizar e impulsar cambios. Ambas opciones tienen sus ventajas y desventajas, así que elige la que mejor se adapte a las necesidades de tu proyecto.

Para iniciar un repositorio Git, usa el siguiente comando:

```
git init
```

Luego puedes agregar archivos al repositorio usando el comando `git add` y hacer commits con el comando `git commit`. Es recomendable crear branches para trabajar en funcionalidades o correcciones separadas, evitando conflictos y facilitando la revisión de código. Las branches se puede fusionar usando el comando `git merge`. Para enviar sus cambios a un repositorio remoto, use el comando `git push`.

Además de Git, Subversion (SVN) es una alternativa popular. Tiene un enfoque centralizado, en el que todos los archivos e historiales se almacenan en un servidor central. Mercurial es otro sistema de control de versiones distribuido que ofrece una experiencia similar a Git. Ambos tienen sus particularidades y elegir el más adecuado depende de las necesidades del proyecto y del equipo.

2. Utiliza un Flujo de Trabajo Eficiente

Un flujo de trabajo adecuado es fundamental para una gestión eficiente de la configuración y el control de versiones del código. GitFlow es un modelo popular que define un marco para colaborar y organizar código en un proyecto. Él usa las branches master y develop como base y cría branches específicas para funcionalidades y correcciones de bugs.

El flujo de trabajo de GitFlow se puede resumir de la siguiente manera:

- La branch master es la principal y contiene código estable y listo para producción.

- La branch develop es de integración continua, donde las características se fusionan a medida que se desarrollan y prueban.

- Para cada funcionalidad, se crea una nueva branch a partir de develop.

- Después de completar la función, la rama de la función se fusiona en develop.

- Cuando esté listo para ser liberado, el develop se mezcla en el master y se crea un nuevo tag para la versión lanzada.

GitFlow es un modelo de flujo de trabajo ramificado que define diferentes branches para diferentes etapas de desarrollo. Él usa las branches master y develop como principales, donde master representa la versión estable de software y develop se utiliza para integrar las funciones en desarrollo.

Además, GitFlow incentiva el uso de branches de feature, release y hotfix para desarrollar nuevas funciones, preparar lanzamientos y corregir bugs, respectivamente. Este flujo de trabajo permite un control más granular y un proceso más estructurado para gestionar el ciclo de vida del software.

Por otro lado, GitHub Flow es un flujo de trabajo más simple y liviano que fomenta el desarrollo continuo y el lanzamiento rápido. Está basado en dos branches principales: master, que representa el código en producción, y feature, donde se desenvuelven nuevas funcionalidades.

GitHub Flow enfatiza la integración continua y la implementación continua, lo que permite a los desarrolladores trabajar en cambios pequeños e incrementales e implementarlos rápidamente en el entorno de producción. Este flujo de trabajo es particularmente adecuado para proyectos más pequeños y equipos ágiles.

Para iniciar un nuevo flujo de trabajo de GitFlow en un repositorio existente, use los siguientes comandos:

```
git checkout -b develop
git checkout -b feature/nova-funcionalidade develop
```

Después de finalizar el desarrollo de la funcionalidad, utilice los siguientes comandos para fusionar la branch de la funcionalidad en develop:

```
git checkout develop
git merge --no-ff feature/nova-funcionalidade
```

Es importante tener en cuenta que el flujo de trabajo de GitFlow es solo un ejemplo, y diferentes equipos pueden adoptar variaciones o incluso crear sus propios flujos de trabajo personalizados según las necesidades y preferencias del proyecto.

Otro flujo de trabajo comúnmente utilizado es GitHub Flow, que simplifica GitFlow usando solo las branches master y feature. GitHub Flow fomenta el desarrollo iterativo y el lanzamiento continuo, donde cada característica se desenvuelve en su propia branch y, al finalizar, se mezcla directamente en master.

Herramientas Alternativas

Además de GitFlow y GitHub Flow, existen otras herramientas y enfoques que se pueden explorar. GitLab Flow es una variación de GitHub Flow que agrega la branch develop como una de estabilización antes de mezclarse en master. Bitbucket utiliza un flujo similar a GitFlow, pero con un mayor énfasis en la integración con otras herramientas del ecosistema Atlassian, como Jira.

3. Utiliza un Sistema de Integración Continua

La Integración Continua (CI) es una práctica de integrar el código fuente en un repositorio compartido con regularidad, detectando y solucionando problemas lo antes posible. Esto se logra mediante la ejecución automatizada de pruebas y la construcción de software. Existen varias herramientas populares para implementar la integración continua, como Jenkins o GitHub Actions.

Jenkins es una herramienta de automatización de código abierto que permite crear pipelines personalizados para construir, probar e implementar tu código. Con él, puedes configurar pasos específicos como compilar, ejecutar pruebas, análisis de código estático e implementar en servidores de producción.

Existen varias herramientas populares para implementar CI, como Jenkins o GitHub Actions. Jenkins es una herramienta de automatización de código abierto que ofrece una amplia gama de funciones para configurar y personalizar el proceso de CI. Te permite crear pipelines de CI flexibles y automatizados donde cada paso se puede configurar para ejecutar pruebas, revisiones de código, compilaciones de paquetes y más.

GitHub Actions, en cambio, es un servicio nativo de GitHub que permite automatizar los flujos de trabajo de compilación, prueba e implementación de su código directamente en GitHub. Ofrece una sintaxis fácil de usar, integración perfecta con GitHub y una amplia gama de acciones listas para usar.

A continuación se muestra un ejemplo de un archivo Jenkins que define una canalización básica para un proyecto Java.:

```
pipeline {
agent any

stages {
stage('Build') {
steps {
sh 'mvn clean package'
}
}
stage('Test') {
steps {
sh 'mvn test'
}
}
stage('Deploy') {
steps {
sh 'mvn deploy'
}
}
}
}
```

En este ejemplo, tenemos tres elementos: Build, Test y Deploy. Cada uno posee uno o más pasos, que se ejecutan en secuencia. Jenkins permite configurar notificaciones por correo electrónico, integrarse con herramientas de gestión de problemas y más.

Otra opción es GitHub Actions. Permite crear workflows personalizados que automatizan la creación, prueba e implementación de tu código directamente en GitHub. A continuación, se muestra un ejemplo de un archivo de flujo de trabajo en GitHub Actions para un proyecto Node.js:

```yaml
name: Build and Test

on:
push:
branches:
- develop
pull_request:
branches:
- develop

jobs:
build-and-test:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: 14

- name: Install dependencies
run: npm install

- name: Run tests
run: npm test
```

En este ejemplo, definimos que el flujo de trabajo se activará con cada push en la branch develop o con los pull requests dirigidos a develop. Luego configuramos los pasos necesarios, como verificar el código, instalar dependencias, ejecutar pruebas y más. GitHub Actions ofrece una amplia gama de acciones listas para usar, además de permitirte crear acciones personalizadas para satisfacer las necesidades específicas de tu proyecto.

4. Documenta la configuración de entorno

Documentar las configuraciones del entorno de desarrollo es fundamental para garantizar que todos los miembros del equipo tengan una comprensión clara del entorno necesario para ejecutar el proyecto. Esto incluye versiones de biblioteca específicas, frameworks, base de datos, construir herramientas y otras dependencias.

Una forma común de documentar la configuración del entorno es utilizar un archivo de manifiesto, como requirements.txt para proyectos Python o package.json para proyectos Node.js. Estos archivos enumeran todas las dependencias requeridas por el proyecto, junto con sus versiones correspondientes. De esta manera, cualquier miembro del equipo puede crear un entorno de desarrollo consistente simplemente instalando las dependencias enumeradas en el archivo.

Además, es importante documentar otras configuraciones relevantes, como las variables de entorno requeridas, las claves API y los detalles de configuración de la base de datos. Esto se puede hacer a través de archivos de configuración específicos o documentación adicional. La idea es brindar una guía clara y completa sobre cómo configurar el entorno de desarrollo, reduciendo la posibilidad de errores y facilitando la integración de nuevos miembros del equipo.

Herramientas Alternativas

Existen herramientas que pueden ayudar a automatizar la documentación de la configuración del entorno, como Docker y Vagrant. Docker permite crear y compartir imágenes de contenedores que contienen todas las dependencias necesarias para el proyecto. De esta manera, cualquier miembro del equipo puede iniciar un entorno de desarrollo coherente utilizando la misma imagen de Docker.

Vagrant, por otro lado, crea ambientes de desarrollo completas y aprovisionadas automáticamente, asegurando que todos los miembros del equipo tengan el mismo entorno configurado.

Proyecto de ejemplo

Ahora, apliquemos las prácticas discutidas anteriormente a un proyecto de ejemplo. Consideremos un proyecto de aplicación web simple usando el framework Django. Aquí están los pasos:

1. Iniciar un repositorio Git para el proyecto:

```
git init
```

2. Crear la estructura básica del proyecto Django:

```
django-admin startproject myproject
```

3. Crear una branch develop para el desarrollo continuo:

```
git checkout -b develop
```

4. Implementar una funcionalidad en una nueva branch:

```
git checkout -b feature/nova-funcionalidade develop
```

5. Hacer commits y mezclar la funcionalidad en la branch develop:

```
git add .
git commit -m "Implementar nova funcionalidade"
git checkout develop
git merge --no-ff feature/nova-funcionalidade
```

6. Configura un flujo de trabajo en GitHub Actions para construir y probar tu proyecto Django.

7. Documentar la configuración del entorno en un archivo requirements.txt con las dependencias necesarias para el proyecto Django.

8. Implantar el proyecto en un servidor de producción usando una herramienta de implantación automatizada, como Ansible o Fabric.

Este es solo un ejemplo simplificado, pero muestra cómo las prácticas de gestión de configuración y control de versiones de código se pueden aplicar a un proyecto real.

Conclusión

La gestión de la configuración y el control de versiones del código son elementos cruciales para el éxito de un proyecto de desarrollo de software. El uso de prácticas adecuadas en estos aspectos puede mejorar la colaboración, la integridad del código y la eficiencia del proceso de desarrollo. En este artículo, exploramos algunas de las mejores prácticas, incluido el uso de un sistema de control de versiones, un flujo de trabajo eficiente, un sistema de integración continua y la documentación de la configuración del entorno.

Recuerda que hay varias herramientas disponibles para cada práctica, y es importante elegir las que mejor se adapten a las necesidades de tu proyecto y tu equipo. Esté abierto a explorar y probar diferentes opciones para encontrar su pareja ideal.

Al aplicar estas prácticas a sus proyectos, estará en camino hacia un desarrollo de software más eficiente, colaborativo y de alta calidad.

Si tiene alguna pregunta o sugerencia adicional, no dude en ponerse en contacto conmigo en LinkedIn o por e-mail. ¡Saludos!

Referencias bibliográficas

Chacon, S., & Straub, B. (2014). Pro Git. Apress.
Wilson, J. (2017). Software Carpentry: Version Control with Git. Software Carpentry.
Fowler, M. (2018). Continuous Integration. Martin Fowler.
Brown, A. (2020). Mastering Software Development in R. O'Reilly Media.
GitHub Actions Documentation. Retrieved from https://docs.github.com/en/actions

💡

Las opiniones y comentarios emitidos en este artículo son propiedad única de su autor y no necesariamente representan el punto de vista de Listopro.

Listopro Community da la bienvenida a todas las razas, etnias, nacionalidades, credos, géneros, orientaciones, puntos de vista e ideologías, siempre y cuando promuevan la diversidad, la equidad, la inclusión y el crecimiento profesional de los profesionales en tecnología.