Настройка GitHub
Пошаговая инструкция подключения SXL Studio к GitHub: создание токена, настройка репозитория и первая синхронизация.
Пошаговая настройка GitHub
Шаг 1 — Создайте Personal Access Token
- Перейдите в GitHub Settings → Developer Settings → Personal Access Tokens
- Выберите Fine-grained tokens (рекомендуется) или Tokens (classic) (legacy-вариант)
SXL Studio работает через GitHub REST API (ветки, git refs, trees, commits, contents), поэтому токен должен разрешать чтение и запись содержимого репозитория.
Fine-grained token (рекомендуется)
- Нажмите Generate new token
- Задайте имя:
SXL Studio - Укажите Resource owner (ваш пользователь или организация)
- В Repository access выберите:
- Рекомендуется: Only select repositories и отметьте нужный репозиторий
- Либо All repositories, если это требуется вашим процессом
- В Repository permissions установите:
- Contents:
Read and write - Metadata:
Read-only
- Contents:
- Опционально: если в scope синка попадают
.github/workflows, добавьте Workflows:Read and write - Нажмите Generate token
- Скопируйте токен — он показывается только один раз
- Если в организации включён approval, дождитесь, пока статус токена перестанет быть
pending
Classic token (legacy)
- Нажмите Generate new token (classic)
- Задайте имя:
SXL Studio - Выберите scope:
repo(полный доступ к репозиторию) - Нажмите Generate token
- Скопируйте токен
GitHub рекомендует fine-grained токены. В некоторых организациях classic-токены полностью запрещены политикой.
Шаг 2 — Подготовьте репозиторий
Убедитесь, что в репозитории есть папки для данных и токенов (или они будут созданы при первом Push):
your-repo/
├── data/ ← Data Path
│ ├── users.json
│ └── products.csv
├── tokens/ ← Tokens Path
│ ├── colors.json
│ ├── spacing.json
│ └── config.json
└── README.md
Шаг 3 — Создайте подключение в плагине
- Откройте SXL Studio → панель Sync
- Нажмите New Sync
- Заполните форму:
| Поле | Значение |
|---|---|
| Provider | GitHub |
| Name | My Design System |
| Repository | your-org/your-repo |
| Branch | main |
| Access Token | Вставьте токен из шага 1 |
| Data Path | data |
| Tokens Path | tokens |
- Нажмите Save
Шаг 4 — Первая синхронизация
- Нажмите Pull — плагин загрузит файлы из репозитория
- Проверьте, что данные и токены появились в плагине
- Попробуйте Push — убедитесь, что запись работает
- (Опционально) Проверьте работу веток:
- Create Branch (от текущей ветки)
- Create Branch From... (от другой ветки), затем Pull
GitHub Enterprise Server
Для self-hosted GitHub Enterprise:
- В поле Enterprise URL укажите базовый URL вашего сервера:
https://github.company.com - Плагин автоматически добавит
/api/v3для REST API - Токен создаётся на вашем Enterprise-сервере аналогично
- Если в enterprise используется SAML SSO, авторизуйте токен для вашей организации до Pull/Push
Устранение проблем
«Not Found» при Pull/Push
- Проверьте правильность
owner/repo(регистр важен) - Убедитесь, что токен имеет доступ к этому репозиторию
«Unauthorized»
- Токен истёк или не имеет нужных permissions
- Для fine-grained: проверьте Contents: Read and write
- Для classic-токена в SSO-организации: выполните SSO-авторизацию токена
«Conflict» при Push
- Кто-то уже обновил файл на remote
- Сделайте Pull → затем Push
Токен валиден, но ветка не создаётся
- Проверьте права fine-grained токена для нужного репозитория
- Убедитесь, что вам разрешено создавать ветки (правила branch protection могут блокировать)
Связанные разделы
- Git — интеграция — общий обзор
- Настройка GitLab — альтернативный провайдер