Inicio rápido para GitHub API REST

on:
  workflow_dispatch:
jobs:
  use_api:
    runs-on: ubuntu-latest
    permissions:
      issues: read
    steps:
      - env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh api http(s)://HOSTNAME/api/v3/repos/REPO-OWNER/REPO-NAME/issues

on:
  workflow_dispatch:
jobs:
  use_api:
    runs-on: ubuntu-latest
    permissions:
      issues: read
    steps:
      - env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh api http(s)://HOSTNAME/api/v3/repos/REPO-OWNER/REPO-NAME/issues

Uso de Octokit.js

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

1. Creación de un token de acceso. Por ejemplo, cree un personal access token o un GitHub App token de acceso de usuario. Usarás este token para autenticar la solicitud, por lo que deberías concederle los ámbitos o permisos necesarios para acceder a ese punto de conexión. Para obtener más información, consulte Autenticación en la API REST o Identificar y autorizar usuarios para aplicaciones de GitHub.

   Advertencia

   Trate el token de acceso igual que una contraseña.

   Para mantener el token seguro, puede almacenar el token como un secreto y ejecutar el script a través de GitHub Actions. Para obtener más información, consulte la sección Uso de Octokit.js en GitHub Actions .

   Si estas opciones no son posibles, considere el uso de otro servicio de CLI 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. Cree una instancia de Octokit con tu token. Reemplace por HOSTNAME el nombre de tu instancia de GitHub Enterprise Server. Reemplace YOUR-TOKEN por su token.

   JavaScript

   const octokit = new Octokit({ 
     baseUrl: "http(s)://HOSTNAME/api/v3",
     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, consulta y cuerpo en un objeto como segundo argumento. Para más información sobre los parámetros de consulta, consulta Introducción a la API REST.

   Por ejemplo, en la siguiente solicitud, el método HTTP es , la ruta de acceso es GETy los parámetros son /repos/{owner}/{repo}/issues y owner: "REPO-OWNER"``repo: "REPO-NAME" Reemplace REPO-OWNER por el nombre de la cuenta propietaria del repositorio y REPO-NAME por el nombre del repositorio.

   JavaScript

   await octokit.request("GET /repos/{owner}/{repo}/issues", {
     owner: "REPO-OWNER",
     repo: "REPO-NAME",
   });
   

Uso de Octokit.js en GitHub Actions

También puede ejecutar sus scripts JavaScript en los flujos de trabajo GitHub Actions. Para más información, consulta Sintaxis del flujo de trabajo para Acciones de GitHub.

Autenticación con token de acceso

GitHub recomienda usar 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 Uso de GITHUB_TOKEN para la autenticación en flujos de trabajo. Para obtener más información sobre secretos, consulta Uso de secretos en Acciones de GitHub.

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

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

      - name: Setup Node
        uses: actions/setup-node@v4
        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 }}

El siguiente es un script de ejemplo en JavaScript con la ruta del archivo .github/actions-scripts/use-the-api.mjs. Reemplace por HOSTNAME el nombre de tu instancia de GitHub Enterprise Server. Reemplaza REPO-OWNER por el nombre de la cuenta propietaria del repositorio. Reemplace REPO-NAME por el nombre del repositorio.

import { Octokit } from "octokit"

const octokit = new Octokit({ 
  baseUrl: "http(s)://HOSTNAME/api/v3",
  auth: process.env.TOKEN
});

try {
  const result = await octokit.request("GET /repos/{owner}/{repo}/issues", {
      owner: "REPO-OWNER",
      repo: "REPO-NAME",
    });

  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}`)
}

Autenticación con GitHub App

Si se está autenticando con un GitHub App, puede crear un token de acceso a la instalación dentro de su flujo de trabajo:

1. Guarde el ID de cliente de su GitHub App como una variable de configuración. En el ejemplo siguiente, reemplaza APP_CLIENT_ID por el nombre de la variable de configuración. Puede encontrar el identificador de cliente en la página de configuración de la aplicación o a través de la API de aplicaciones. Para más información, consulta Puntos de conexión de la API de REST para GitHub Apps. Para obtener más información sobre las variables de configuración, consulta Almacenamiento de información en variables.

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_PRIVATE_KEY por el nombre del secreto. Para más información, consulta Administración de claves privadas para aplicaciones de GitHub. Para obtener más información sobre secretos, consulta Uso de secretos en Acciones de GitHub.

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:

   on:
     workflow_dispatch:
   jobs:
     use_api_via_script:
       runs-on: ubuntu-latest
       steps:
         - name: Check out repo content
           uses: actions/checkout@v6
   
         - name: Setup Node
           uses: actions/setup-node@v4
           with:
             node-version: '16.17.0'
             cache: npm
   
         - name: Install dependencies
           run: npm install octokit
   
         - name: Generate token
           id: generate-token
           uses: actions/create-github-app-token@v3
           with:
             client-id: ${{ vars.APP_CLIENT_ID }}
             private-key: ${{ secrets.APP_PRIVATE_KEY }}
   
         - 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 "http(s)://HOSTNAME/api/v3/repos/REPO-OWNER/REPO-NAME/issues" \
          --header "Accept: application/vnd.github+json" \
          --header "Authorization: Bearer $GH_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 "http(s)://HOSTNAME/api/v3/repos/REPO-OWNER/REPO-NAME/issues" \
          --header "Accept: application/vnd.github+json" \
          --header "Authorization: Bearer $GH_TOKEN"