Inicio rápido para la APi de REST GitHub

on:
  workflow_dispatch:
jobs:
  use_api:
    runs-on: ubuntu-latest
    permissions:
      issues: read
    steps:
      - env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh api repos/octocat/Spoon-Knife/issues

Introducción al uso de JavaScript

Puedes usar Octokit.js para interactuar con la API de REST de GitHub en los scripts de JavaScript. Para obtener más información, consulta "Scripting con la API de REST y JavaScript".

Uso de Octokit.js

1. Creación de un token de acceso. Por ejemplo, crea un personal access token o un token de acceso de usuario a servidor GitHub App. Para más información, consulta "Creación de un personal access token" o "Identificación y autorización de usuarios para aplicaciones de GitHub".

   Advertencia: trata el token de acceso igual que una contraseña.

   Para proteger el token, puedes almacenar el token como secreto y ejecutar el script a través de GitHub Actions. Para obtener más información, consulta la sección "Uso de Octokit.js en GitHub Actions".

   Si estas opciones no son posibles, considera la posibilidad de usar otro servicio como la CLI de 1Password para almacenar el token de forma segura.

2. Instalar octokit. Por ejemplo, npm install octokit. Para ver otras formas de instalar o cargar octokit, consulta el archivo README de Octokit.js.

3. Importaroctokit en tu script. Por ejemplo, import { Octokit } from "octokit";. Para obtener otras formas de importar octokit, consulta el archivo README de Octokit.js.

4. Crea una instancia de Octokit con tu token. Reemplace YOUR-TOKEN por su token.

   const octokit = new Octokit({
     auth: 'YOUR-TOKEN'
   });
   

5. Usa octokit.request para ejecutar la solicitud. Envía el método HTTP y la ruta de acceso como primer argumento. Especifica cualquier parámetro de ruta de acceso, consulta y cuerpo en un objeto como segundo argumento. Por ejemplo, en la siguiente solicitud, el método HTTP es GET, la ruta de acceso es /repos/{owner}/{repo}/issues y los parámetros son owner: "octocat" y repo: "Spoon-Knife".

   await octokit.request("GET /repos/{owner}/{repo}/issues", {
     owner: "octocat",
     repo: "Spoon-Knife",
   });
   

Uso de Octokit.js en GitHub Actions

También puedes ejecutar los scripts de JavaScript en los flujos de trabajo de GitHub Actions. Para obtener más información, vea «Sintaxis del flujo de trabajo para Acciones de GitHub».

GitHub recomienda autenticarse con el GITHUB_TOKEN integrado en lugar de crear un token. Si esto no es posible, almacena el token como secreto y reemplaza GITHUB_TOKEN en el ejemplo siguiente por el nombre del secreto. Para obtener más información sobre GITHUB_TOKEN, consulta "Automatic token authentication". Para obtener más información sobre secretos, consulte "Secretos cifrados".

Observa el siguiente flujo de trabajo de ejemplo:

1. Comprueba el contenido del repositorio
2. Configura Node.js
3. Instala octokit
4. Almacena el valor de GITHUB_TOKEN como una variable de entorno denominada TOKEN y ejecuta .github/actions-scripts/use-the-api.mjs, que puede tener acceso a esa variable de entorno como process.env.TOKEN

Ejemplo de flujo de trabajo:

on:
  workflow_dispatch:
jobs:
  use_api_via_script:
    runs-on: ubuntu-latest
    permissions:
      issues: read
    steps:
      - name: Check out repo content
        uses: actions/checkout@v3

      - name: Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: '16.17.0'
          cache: npm

      - name: Install dependencies
        run: npm install octokit

      - name: Run script
        run: |
          node .github/actions-scripts/use-the-api.mjs
        env:
          TOKEN: ${{ secrets.GITHUB_TOKEN }}

Script de JavaScript de ejemplo, con la ruta de acceso del archivo .github/actions-scripts/use-the-api.mjs:

import { Octokit } from "octokit"

const octokit = new Octokit({
  auth: process.env.TOKEN
});

try {
  const result = await octokit.request("GET /repos/{owner}/{repo}/issues", {
      owner: "octocat",
      repo: "Spoon-Knife",
    });

  const titleAndAuthor = result.data.map(issue => {title: issue.title, authorID: issue.user.id})

  console.log(titleAndAuthor)

} catch (error) {
  console.log(`Error! Status: ${error.status}. Message: ${error.response.data.message}`)
}

Si está autenticando con un GitHub App, puedes crear un token de acceso de instalación en el flujo de trabajo:

1. Almacena la ID de tu GitHub App como un secreto. En el flujo de trabajo siguiente, reemplaza APP_ID por el nombre del secreto. Puedes encontrar tu ID de app en la página de ajustes de tu app o mediante la API de la misma. Para obtener más información, vea «Aplicaciones de GitHub». Para obtener más información sobre secretos, consulte "Secretos cifrados".

2. Generar una llave privada para tu app. Almacena el contenido del archivo resultante como un secreto. (Almacena todo el contenido del archivo, incluido el contenido de -----BEGIN RSA PRIVATE KEY----- y -----END RSA PRIVATE KEY-----). En el siguiente ejemplo, reemplaza APP_PEM por el nombre del secreto. Para obtener más información, vea «Sobre claves privadas para GitHub Apps».

3. Agrega un paso para generar un token y use ese token en lugar de GITHUB_TOKEN. Ten en cuenta que este token expirará después de 60 minutos. Por ejemplo:

   # Este flujo de trabajo usa acciones que no GitHub no certifica.
   # Estas las proporcionan entidades terceras y las gobiernan
   # condiciones de servicio, políticas de privacidad y documentación de soporte
   # en línea.
   
   on:
     workflow_dispatch:
   jobs:
     use_api_via_script:
       runs-on: ubuntu-latest
       steps:
         - name: Check out repo content
           uses: actions/checkout@v3
   
         - name: Setup Node
           uses: actions/setup-node@v3
           with:
             node-version: '16.17.0'
             cache: npm
   
         - name: Install dependencies
           run: npm install octokit
   
         - name: Generate token
           id: generate_token
           uses: tibdex/github-app-token@36464acb844fc53b9b8b2401da68844f6b05ebb0
           with:
             app_id: ${{ secrets.APP_ID }}
             private_key: ${{ secrets.APP_PEM }}
   
         - name: Run script
           run: |
             node .github/actions-scripts/use-the-api.mjs
           env:
             TOKEN: ${{ steps.generate_token.outputs.token }}
   

on:
  workflow_dispatch:
jobs:
  use_api:
    runs-on: ubuntu-latest
    permissions:
      issues: read
    steps:
      - env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          curl --request GET \
          --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \
          --header "Accept: application/vnd.github+json" \
          --header "Authorization: Bearer $GH_TOKEN"