Publicaci贸n de Paquetes

Publicaci贸n de Paquetes#

La modularizaci贸n en el contexto del software es importante para la separaci贸n de c贸digo y archivos que tengan relevancia entre s铆, as铆 como tambi茅n facilitar el consumo de m贸dulos que son comunes entre 2 o m谩s proyectos. Aunque existen distintos tipos de paquetes y formas de publicarlos, este tutorial se basa en la publicaci贸n de paquetes de NPM.

Generaci贸n del Personal Access Token#

Para poder publicar paquetes, es necesario generar un Personal Access Token o Token de Acceso Personal. Este token puede ser generado al seguir los siguientes pasos:

  1. Dir铆jase a la opci贸n de Ajustes o Settings

  2. Una vez se se encuentra en el panel de configuraciones, presione el bot贸n Developer Settings o Configuraciones de Desarrollador

  3. Ahora, presione la opci贸n Tokens de Acceso Personal o Personal Access Tokens

  4. Una vez presionada la anterior opci贸n, presione el bot贸n Generar nuevo token o Generate new token

  5. Ahora seleccioone el scope o 谩mbito adecuado para el token, como se muestra en la siguiente imagen

  6. Finalmente, presione el bot贸n mostrado en la siguiente imagen (ubicado al final de la p谩gina) para obtener el token
    <p style={{ align: "center" }}>
    <img src={ useBaseUrl( '/img/publicacion-de-paquetes/GenerateTokenButton.png' )} width="100%" />
    </p>
    El token se muestra una vez este es generado; proceda a copiarlo en un lugar seguro, ya que no se vuelve a mostrar.

Registro de Paquetes de Github#

Github Package Registry es un registro de paquetes que entre sus ventajas ofrece:

  • Manejo de las mismas credenciales que se utilizan en Github.
  • Posibilidad de integraci贸n con Github Actions y Webhooks.
  • Paquetes privados que se mantienen dentro del mismo 谩mbito o scope de la organizaci贸n.

Autenticaci贸n Utilizando npm login#

Para autenticarse en el Github Registry es necesario utilizar el comando npm login de la siguiente manera:

$ npm login --scope=@OWNER --registry=https://npm.pkg.github.com
> Username: USERNAME
> Password: TOKEN
> Email: PUBLIC-EMAIL-ADDRESS

Recuerda reemplazar USERNAME con el usuario de Github respectivo (el que cre贸 el Personal Access Token), TOKEN con el Personal Access Token generado y el PUBLIC-EMAIL-ADDRESS con la direcci贸n de correo electr贸nico que corresponde al usuario.

Si desea autenticarse a帽adiendo su Personal Access Token al archivo ~/.npmrc, puede dirigirse a la documentaci贸n de github para mayor extensi贸n en este asunto.

Publicar un Paquete#

En el archivo package.json es necesario agregar un elemento m谩s llamado publishConfig, que hace referencia al registro donde se desea publicar el paquete.

  1. Edite el archivo package.json e incluya la entrada publishConfig

    "publishConfig": {
    "registry":"https://npm.pkg.github.com"
    }
  2. Verifique si la entrada repository en el archivo package.json corresponde a la URL de repositorio. Por ejemplo si la URL del repositorio es github.com/my-org/test, entonces la entrada repository debe ser git://github.com/my-org/test.git

  3. Ahora ejecute el siguiente comando en la terminal para publicar el paquete

    $ npm publish

Desplegar una Nueva Versi贸n del Paquete#

A la hora publicar una nueva versi贸n, es necesario cambiar la entrada version en el archivo package.json. Para esto se est谩 siguiendo el est谩ndar Semantic Versioning de npm.

Instalar el Paquete Publicado#

Para instalar el paquete, es necesario ejecutar el siguiente c贸digo:

yarn add @scope/package-name

Ten en cuenta que @scope se refiere al propietario (nombre de usuario o nombre de org) bajo el cual est谩 publicado el paquete. Si deseas instalar una versi贸n espec铆fica del paquete, es necesario ejecutar el comando: yarn add @scope/[email protected]

Referencias#

Last updated on by JustinCast