Skip to content

QUICKSTART.md

Latest commit

 

History

History
170 lines (127 loc) · 7.4 KB

QUICKSTART.md

File metadata and controls

170 lines (127 loc) · 7.4 KB

Быстрый старт

1. Установка зависимостей

pip install -r requirements.txt

2. Настройка переменных окружения

Скопируйте .env.example в .env и заполните:

cp .env.example .env

Минимально необходимые переменные:

  • SECRET_KEY - любой случайный секретный ключ
  • GITHUB_CLIENT_ID и GITHUB_CLIENT_SECRET - из OAuth App
  • GITHUB_APP_ID и GITHUB_APP_INSTALLATION_ID - из GitHub App
  • GITHUB_APP_PRIVATE_KEY_PATH - путь к файлу с приватным ключом

3. Создание GitHub App Private Key

Скачайте приватный ключ из настроек GitHub App и сохраните как github-app-private-key.pem:

# Файл должен быть в формате:
# -----BEGIN RSA PRIVATE KEY-----
# ...
# -----END RSA PRIVATE KEY-----

4. Запуск приложения

python app.py

Или с hot-reload:

uvicorn app:app --host 0.0.0.0 --port 8000 --reload

5. Откройте в браузере

http://localhost:8000

Тестирование

  1. Нажмите "Войти через GitHub"
  2. Авторизуйтесь
  3. Заполните форму с репозиторием и workflow
  4. Выберите тесты
  5. Запустите workflow

Пример workflow для тестирования

Создайте файл .github/workflows/test.yml в вашем репозитории:

name: Test Workflow

on:
  workflow_dispatch:
    inputs:
      tests:
        description: 'Tests to run (comma-separated)'
        required: false
        type: string
        default: 'unit'

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      
      - name: Run tests
        run: |
          echo "Running tests: ${{ inputs.tests }}"
          # Ваши команды для запуска тестов

Troubleshooting

Ошибка "Not authenticated"

  • Убедитесь, что вы авторизовались через GitHub OAuth
  • Проверьте, что GITHUB_CLIENT_ID и GITHUB_CLIENT_SECRET правильные

Ошибка "Failed to trigger workflow"

  • Проверьте, что GitHub App установлен в репозиторий
  • Убедитесь, что у App есть права на Actions (Read and write)
  • Проверьте, что workflow_id соответствует имени файла workflow

Ошибка "User is not a collaborator"

  • Убедитесь, что вы действительно коллаборатор репозитория (имеете доступ к репозиторию)
  • Проверьте, что OAuth токен имеет права на чтение репозитория

Ошибка 403 "Resource not accessible by integration"

Если вы видите ошибку в GitHub Actions workflow:

HttpError: Resource not accessible by integration
status: 403

Это означает, что GitHub App не имеет необходимых прав для выполнения операции (например, создание комментариев в issues или PR).

Решение:

  1. Если ошибка связана с созданием комментариев в issues/PR:

    • Перейдите в настройки GitHub App: https://github.com/settings/apps
    • Откройте ваше приложение
    • Перейдите в раздел Permissions & events
    • В разделе Repository permissions найдите Issues
    • Установите права Read and write (или Write)
    • Нажмите Save changes

  2. После изменения прав ОБЯЗАТЕЛЬНО обновите установку:

    Для репозитория:

    • Перейдите: https://github.com/YOUR_USERNAME/YOUR_REPO/settings/installations
    • Или: Settings → Integrations → GitHub Apps → найдите ваше приложение
    • Нажмите Configure рядом с вашим GitHub App
    • На странице установки нажмите Update installation (или Save)

    Для организации:

    • Перейдите: https://github.com/organizations/YOUR_ORG/settings/installations
    • Или: Organization Settings → GitHub Apps → найдите ваше приложение
    • Нажмите Configure → Update installation

    Важно: Без обновления установки новые права не применятся!

  3. Проверьте другие необходимые права:

    • Если workflow использует другие операции (например, создание PR), убедитесь что у App есть соответствующие права
    • Actions: Read and write (для запуска workflows)
    • Contents: Read-only или Read and write (в зависимости от нужд)
    • Issues: Write (для создания комментариев)
    • Pull requests: Write (для создания комментариев в PR)
    • Workflows: Write (для изменения workflow файлов при backport)

Примечание: После изменения прав GitHub App, все установки приложения нужно обновить вручную. Без обновления установки новые права не будут работать!

Ошибка "OAuth App access restrictions"

Если вы видите ошибку:

Although you appear to have the correct authorization credentials, 
the `organization-name` organization has enabled OAuth App access restrictions

Это означает, что организация включила ограничения доступа для OAuth приложений. Чтобы решить проблему:

  1. Если вы владелец организации или имеете права администратора:

    • Перейдите в настройки организации: https://github.com/organizations/ORGANIZATION_NAME/settings/oauth_application_policy
    • Найдите ваше OAuth App в списке "Third-party access"
    • Нажмите "Grant" или "Approve" для вашего приложения
    • Подробнее: https://docs.github.com/articles/restricting-access-to-your-organization-s-data/

  2. Если вы не администратор организации:

    • Обратитесь к администратору организации
    • Попросите его одобрить OAuth App в настройках организации
    • Администратор должен перейти в: Settings → Third-party access → OAuth Apps
    • И одобрить ваше приложение

  3. Альтернативное решение:

    • Если у вас нет доступа к настройкам организации, можно использовать GitHub App вместо OAuth App
    • GitHub Apps не требуют одобрения организации (если установлены в репозиторий)