Pruebas locales y publicación de nueva versión

Se explica el flujo para probar localmente la librería y publicar una nueva version.

Prerequisitos

Acciones previas antes de probar una feature por un desarrollo nuevo o el mantenimiento de uno existente.

• Clonar el repositorio de Inlaze-ui-react perteneciente a la organización de github sport-enlace-sas

• Instalar dependencias con npm

• Ejecutar el comando npm run libs:storybook para ir visualizando y documentando el componente a agregar.

• Ejecutar el otro proyecto desde el cual se desea probar la librería instalada.

Casos de uso

• Probar el comportamiento de algún elemento de la librería al ser usado desde otro proyecto.

Paso a paso para probar y publicar una versión de la libreria, manualmente.

Paso 1: Probar localmente el cambio hecho a la librería

SupUna vez hecho el desarrollo o mantenimiento requerido, hacer lo siguiente:

1. Ejecutar npm run libs:build, si el build falla hacer la corrección necesaria, algunos de estos se han detectado y documentado en frecuentes / errores de build.

2. Se debe crear un dist en la raíz del proyecto, si se muestra en la termina un build hecho pero no se crea la carpeta dist, revisar posibles soluciones en preguntas frecuentes / errores de build

3. Navegar en dist\libs y ejecutar el comando npm pack, y se creara un fichero llamado inlaze_techlead-inlaze-ui-react-18.0.{version}.tgz.

4. Abrir el proyecto en el que se desea probar el cambio hecho en la librería, digitar el comando de instalación del gestor de paquetes usado en el proyecto, por ejemplo pnpm i y antes de dar enter, arrastrar encima de la terminal el paquete local .tgz para obtener la ruta, y ejecutar la instalación.

5. Probar el efecto de los cambios realizados en el proyecto, probar las importaciones, si hay breaking changes, que compile el servidor local y durante el build, de haber errores de compilación que nates no existían, revisar en preguntas frecuentes / Errores de compilación en otros proyectos y que pueden llegar a ser causados por la librería

Step 2: Publicar la nueva versión una vez probada

El proceso de versionamiento y publicación puede ser automatizado, sin embargo, se expone la forma de hacerlo manualmente

• Abrir el fichero package.json ubicado en libs\package.json y cambiar el numero de la versión al que se halla indicado, el cual debe ser mayor a la última versión publicada.

• Estar autorizado para autenticarse en la cuenta npm de la empresa y autenticarse con npm login o pedir actualización a un integrante autorizado.

• Navegar en dist\libs y ejecutar el comando npm publish.

Conclusión

Una vez se conoce el flujo de desarrollo y mantenimiento en la librería, es importante ayudar a desarrolladores que sigan contribuyendo a este proyecto que cuenten con una documentación que aborte todos los casos que sean posibles, si hay problemas y soluciones a problemas que no se han documentado, hacer ese aporte en la siguiente sección.