Nota: Los ejecutores hospedados en GitHub no son compatibles con GitHub Enterprise Server actualmente. Puedes encontrar más información sobre el soporte que se tiene planeado en el futuro en el Itinerario público de GitHub.
Introducción
En esta guía, crearás un flujo de trabajo de GitHub Actions para probar tu código y luego lo publicarás en el Registro del paquete de GitHub.
Publicar tu paquete
-
Crea un repositorio nuevo en GitHub, agregando el
.gitignore
para Node. Crea un repositorio privado si te gustaría borrar este paquete más adelante, los paquetes públicos no pueden borrarse. Para obtener más información, consulta la sección "Crear un repositorio nuevo ". -
Clona el repositorio en tu máquina local.
$ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git $ cd YOUR-REPOSITORY
-
Crea un archivo
index.js
y agrega una alerta básica que diga "Hello world!"JavaScript alert("Hello, World!");
-
Inicializa un paquete de npm con
npm init
. En el asistente de inicialización de paquetes, ingresa tu paquete con el nombre:@YOUR-USERNAME/YOUR-REPOSITORY
, y configura el script de pruebas enexit 0
. Esto generará un archivopackage.json
con información sobre tu paquete.$ npm init ... package name: @YOUR-USERNAME/YOUR-REPOSITORY ... test command: exit 0 ...
-
Ejecuta
npm install
para generar el archivopackage-lock.json
y luego confirma y sube tus cambios a GitHub.$ npm install $ git add index.js package.json package-lock.json $ git commit -m "initialize npm package" $ git push
-
Crea un directorio de
.github/workflows
. En este directorio, crea un archivo que se llamerelease-package.yml
. -
Copia el siguiente contenido de YAML en el archivo
release-package.yml
.YAML name: Node.js Package on: release: types: [created] jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: node-version: 12 - run: npm ci - run: npm test publish-gpr: needs: build runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: node-version: 12 registry-url: https://npm.pkg.github.com/ - run: npm ci - run: npm publish env: NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
-
Dile a NPM en qué alcance y registro publicar paquetes para utilizar uno de los siguientes métodos:
- Agrega un archivo de configuración NPM para el repositorio creando un archivo
.npmrc
en el directorio raíz con el siguiente contenido:@YOUR-USERNAME:registry=https://npm.pkg.github.com
- Edita el archivo
package.json
y especifica la clavepublishConfig
:"publishConfig": { "@YOUR-USERNAME:registry": "https://npm.pkg.github.com" }
- Agrega un archivo de configuración NPM para el repositorio creando un archivo
-
Confirma y sube tus cambios a GitHub.
$ git add .github/workflows/release-package.yml # Also add the file you created or edited in the previous step. $ git add .npmrc or package.json $ git commit -m "workflow to publish package" $ git push
-
El flujo de trabajo que creaste se ejecutará cuando sea que se cree un lanzamiento nuevo en tu repositorio. Si las pruebas pasan, entonces el paquete se publicará en Registro del paquete de GitHub.
Para probar esto, navega a la pestaña de Código en tu repositorio y crea un lanzamiento nuevo. Para obtener más información, consulta la sección "Gestionar los lanzamientos en un repositorio".
Visualizar tu paquete publicado
Puedes ver todos los paquetes que has publicado.
-
En GitHub Enterprise Server, visita la página principal del repositorio.
-
A la derecha de la lista de archivos, da clic en Paquetes.
-
Da clic en el nombre del paquete que quieres ver.
Instalar un paquete publicado
Ahora que publicaste el paquete, querrás utilizarlo como una dependencia en tus proyectos. Para obtener más información, consulta la sección "Trabajar con el registro de npm".
Pasos siguientes
El flujo básico que acabas de agregar se ejecuta en cualquier momento que se cree un lanzamiento nuevo en tu repositorio. Pero esto es solo el inicio de lo que puedes hacer con el Registro del paquete de GitHub. Puedes publicar tu paquete en varios registros con un solo flujo de trabajo, activar el flujo de trabajo para que se ejecute en eventos diferentes tales como una solicitud de cambios fusionada, administrar contenedores, y más.
El combinar el Registro del paquete de GitHub y las GitHub Actions puede ayudarte a automatizar casi cualquier aspecto de tu proceso de desarrollo de aplicaciones. ¿Listo para comenzar? Aquí hay algunos recursos útiles para llevar a cabo los siguientes pasos con el Registro del paquete de GitHub y las GitHub Actions:
- "Aprende sobre el Registro del paquete de GitHub" para un tutorial más a fondo de GitHub Packages
- "Aprende sobre las GitHub Actions" para un tutorial más a fondo de GitHub Actions
- "Trabajar con un registro de Registro del paquete de GitHub registry" para casos de uso y ejemplos específicos