Быстрый старт для GitHub REST API

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

Использование Octokit.js

Вы можете использовать Octokit.js для взаимодействия с GitHub REST API в ваших JavaScript-скриптах. Дополнительные сведения см. в разделе "Скрипты" с помощью REST API и JavaScript.

1. Создание маркера доступа Например, создать personal access token или GitHub App пользовательский токен доступа. Этот маркер будет использоваться для проверки подлинности запроса, поэтому вы должны предоставить ему любые области или разрешения, необходимые для доступа к этой конечной точке. Для получения дополнительной информации см. Проверка подлинности в REST API или Идентификация и авторизация пользователей для GitHub приложений.

   Предупреждение

   Обратитесь к маркеру доступа как к паролю.

   Чтобы сохранить свой токен в безопасности, вы можете хранить его в секрете и запускать скрипт через GitHub Actions. Для получения дополнительной информации смотрите раздел «Использование Octokit.js».GitHub Actions

   Если эти параметры недоступны, попробуйте использовать другую службу CLI для безопасного хранения маркера.

2. Установите octokit. Например: npm install octokit. Другие способы установки или загрузки octokit см. в Octokit.js README.

3. Импортируйте octokit в скрипт. Например: import { Octokit } from "octokit";. Другие способы импорта octokit см. в Octokit.js README.

4. Создайте экземпляр Octokit с помощью вашего токена. Замените HOSTNAME на имя ваш экземпляр GitHub Enterprise Server. Замените YOUR-TOKEN маркером.

   JavaScript

   const octokit = new Octokit({ 
     baseUrl: "http(s)://HOSTNAME/api/v3",
     auth: 'YOUR-TOKEN'
   });
   

5. Используйте octokit.request для выполнения запроса. Отправьте метод HTTP и путь в качестве первого аргумента. Укажите любой путь, запрос и параметры текста в объекте в качестве второго аргумента. Дополнительные сведения о параметрах см. в разделе Начало работы с REST API.

   Например, в следующем запросе HTTP-метод — , GETпуть — /repos/{owner}/{repo}/issues, а параметры —owner: "REPO-OWNER"и Замените REPO-OWNER на название аккаунта, владеющего репозиторием, и REPO-NAME на название репозитория.

   JavaScript

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

Использование Octokit.js в GitHub Actions

Вы также можете запускать скрипты JavaScript в рабочих GitHub Actions процессах. Дополнительные сведения см. в разделе Синтаксис рабочего процесса для GitHub Actions.

Проверка подлинности с помощью маркера доступа

GitHub Рекомендует использовать встроенный GITHUB_TOKEN токен, а не создавать токен. Если это невозможно, сохраните маркер в качестве секрета и замените GITHUB_TOKEN в приведенном ниже примере именем секрета. Дополнительные сведения см. в GITHUB_TOKENразделе Использование GITHUB_TOKEN для проверки подлинности в рабочих процессах. Дополнительные сведения о секретах см. в разделе Использование секретов в GitHub Actions.

См. следующий пример рабочего процесса:

1. Извлекает содержимое репозитория.
2. Настраивает Node.js.
3. Устанавливает octokit.
4. Сохраняет значение GITHUB_TOKEN как переменную среды TOKEN и выполняет .github/actions-scripts/use-the-api.mjs, которые могут получить доступ к этой переменной среды в качестве 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 }}

Ниже приведён пример JavaScript-скрипта с путь .github/actions-scripts/use-the-api.mjsк файлу . Замените HOSTNAME на имя ваш экземпляр GitHub Enterprise Server. Замените REPO-OWNER именем учетной записи, владеющей репозиторием. Замените REPO-NAME на название репозитория.

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

Аутентификация с помощью GitHub App

Если вы аутентифицируете с GitHub Appпомощью , вы можете создать токен доступа для установки в вашем рабочем процессе:

1. Сохраняйте GitHub Appидентификатор клиента как конфигурационную переменную. В следующем примере замените APP_CLIENT_ID имя переменной конфигурации. Вы можете найти идентификатор клиента на странице настроек вашего приложения или через API приложения. Дополнительные сведения см. в разделе Конечные точки REST API для GitHub Apps. Дополнительные сведения о переменных конфигурации см. в разделе Хранение сведений в переменных.

2. Создайте закрытый ключ для приложения. Храните содержимое получившегося файла как секрет. (Сохраните все содержимое файла, включая -----BEGIN RSA PRIVATE KEY----- и -----END RSA PRIVATE KEY-----.) В следующем примере замените APP_PRIVATE_KEY именем секрета. Дополнительные сведения см. в разделе Управление приватными ключами для приложений GitHub. Дополнительные сведения о секретах см. в разделе Использование секретов в GitHub Actions.

3. Добавьте шаг для создания маркера и используйте его вместо GITHUB_TOKEN. Обратите внимание, что срок действия этого маркера истекает через 60 минут. Например:

   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"