NugetServer
Sumario
Manual de uso de NugetServer
Descripción
Servicio de administración y entrega de paquetes Nuget exclusivos para la plataforma Telstock
Ubicación del repositorio de paquetes Nuget para Telstock
Se encuentra ubicado en la dirección http://192.168.9.60:8080/scm/git/NugetServer
Ubicación del servidor de paquetes Nuget para Telstock
Se encuentra ubicado en la dirección http://192.168.9.60/NugetServer
Creación de paquete Nuget
Este manual supone que el desarrollador tiene el conocimiento para la creación de un paquete Nuget; sin embargo, se enlistan las propiedades oblogatorias sobre su diseño.
Propiedades del paquete Nuget
- Nombre
- Deberá crearse con la estructura de nombre Telstock.<nombrepaquete>, donde dicho nombre deberá ser único en el repositorio de paquetes y deberá ser en inglés sin espacios y sin caracteres especiales; ejemplo: Telstock.TestNamePackage
- Versionamimento
- Se deberá llevar bien el control de versión con la siguiente estructura [cambio mayor].[Cambio menor].[Revisión], ejemplo: 1.0.1
- Icono
- La imagen correspondiente a la propiedad de telstock, dicha imagen se podrá tomar de cualquier paquete ya creado en el repositorio de paquetes o solicitarla al departamento de diseño
- Readme: Archivo que contendrá todas referencias, descripciones y documentación necesaria para utilizar el paquete
- Se deberá crear con ayuda de la página readme.so, las secciones que deberá contener serán:
- Title and Description
- Documentation
- Usage/Examples
- User by
Publicación de paquete en el servidor
El paquete deberá cubrir los siguientes lineamientos para ser aprobado a publicación
Reglas de publicación
- El código deberá agregarse como proyecto adicional a la solución del repositorio NugetServer en la rama Develop
- El código deberá contar con las mejores prácticas de codificación implementadas en la empresa Telstock
- Todo paquete antes de ser publicado deberá tener sus pruebas unitarias; dichas pruebas, también estarán contenidas dentro de la solución como un proyecto dentro de la carpeta UnitTest
- Solo los coordinadores serán autorizados y responsables de publicar en el servidor de paquetes Nuget
- Solo Gerencia está autorizado a realizar un Merge en la rama master del repositorio
Proceso de publicación
Cualquier coordinador podrá realizar una publicación o actualización de cualquier paquete SIEMPRE Y CUANDO se hayan cumplido las reglas de publicación previamente descritas en el apartado Reglas de publicación El proceso se describe a continuación:
- Descargar de la página oficial Nuget o tomar de otro paquete el ejecutable de nombre nuget.exe y colocarlo dentro de la raíz del proyecto del paquete
- Cuando se haya compilado un paquete, como resultado se crea un archivo <nombre del paquete>.<versión>.nupkg; generalmente, en la carpeta Release del proyecto
- Abrir una línea de comando (CMD) y ubicarse en el directorio del proyecto del paquete donde se encuentra el ejecutable Nuget.exe. Puede ayudarse del siguiente comando cd <path del directorio>
- Una vez dentro de la ruta ejecutar la siguiente instrucción <path> del directorio raíz>/nuget.exe push <path del archivo nupkg>/<nombre y extensión del archivo nupkg> <llave de publicación> -Source http://192.168.9.69/nugerserver/nuget EJEMPLO: C:\Telstock.ReadWriteExcel/nuget.exe push C:\Release/Telstock.ReadWriteExcel.6.0.0.nupkg llave -Source http://192.168.9.69/nugetserver/nuget
NOTA
La llave de publicación se le solicita a Gerencia
Implementación de un paquete Nuget
En este manual se entiende que el desarrollador tiene los conocimientos para la instalación de un paquete Nuget; sin embargo, solo se describen las partes más importantes para descargar un paquete Nuget del servidor Telstock
- Abrir la consola del administrador de paquetes Nuget y en el apartado de origen del paquete dar click en el engrane de configuración, como se muestra a continuación:
- Se abrirá una ventana de configuración donde se deberá agregar un nuevo origen tal cual se muestra en la imagen a continuación:
- Por último en la consola de administración de paquetes, cuidar que esté seleccionado este nuevo origen para poder obtener la lista de paquetes disponibles