Diferencia entre revisiones de «NugetServer»

De Telstock Wiki
Saltar a: navegación, buscar
(Página creada con «Manual de uso de NugetServer»)
 
(Proceso de publicación)
 
(No se muestran 15 ediciones intermedias del mismo usuario)
Línea 1: Línea 1:
Manual de uso de NugetServer
+
==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 [http://192.168.9.60/NugetServer 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 [https://www.nuget.org/downloads 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:
 +
[[Archivo:Origen.png|miniaturadeimagen|Origen del paquete]]
 +
 
 +
#Se abrirá una ventana de configuración donde se deberá agregar un nuevo origen tal cual se muestra en la imagen a continuación:
 +
[[Archivo:NuevoOrigen.png|miniaturadeimagen]]
 +
 
 +
#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

Revisión actual del 18:10 14 abr 2023

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
  1. 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
  1. Se deberá llevar bien el control de versión con la siguiente estructura [cambio mayor].[Cambio menor].[Revisión], ejemplo: 1.0.1
  • Icono
  1. 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
  1. Se deberá crear con ayuda de la página readme.so, las secciones que deberá contener serán:
  2. Title and Description
  3. Documentation
  4. Usage/Examples
  5. 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:

  1. 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
  2. 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
  3. 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>
  4. 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

  1. 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:
Error al crear miniatura: El sistema no puede encontrar la ruta especificada. Error code: 1
Origen del paquete
  1. Se abrirá una ventana de configuración donde se deberá agregar un nuevo origen tal cual se muestra en la imagen a continuación:
Error al crear miniatura: El sistema no puede encontrar la ruta especificada. Error code: 1
  1. 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