Настройка GitHub

Плагин работает с GitHub через REST API по Personal Access Token: ставить git на компьютер не нужно. Настройка занимает пять минут: создать токен, заполнить форму подключения, проверить, нажать Pull.

#Шаг 1. Создайте Personal Access Token

Откройте GitHub → Settings → Developer settings → Personal access tokens. Подойдёт любой из двух видов токена.

Fine-grained token (рекомендуется GitHub)

1. Нажмите Generate new token.
2. Задайте имя, например SXL Studio, и срок действия.
3. В Resource owner выберите себя или организацию, которой принадлежит репозиторий.
4. В Repository access выберите Only select repositories и отметьте репозиторий с токенами.
5. В Repository permissions установите Contents: Read and write. Право Metadata: Read-only GitHub добавит сам.
6. Нажмите Generate token и скопируйте токен: он показывается один раз.

Если организация требует одобрения токенов, дождитесь, пока администратор его одобрит. До этого подключение будет получать ошибку 404.

Classic token

1. Нажмите Generate new token (classic).
2. Задайте имя и отметьте scope repo.
3. Нажмите Generate token и скопируйте токен.

Плагин распознаёт форматы github_pat_… (fine-grained) и ghp_… (classic). Если вставить токен другого вида или обрезанный, проверка подключения предупредит об этом.

Токен нужен даже для публичного репозитория: без него плагин сможет только читать, а Push будет недоступен.

#Шаг 2. Подготовьте репозиторий

В репозитории должен быть хотя бы один коммит: пустой репозиторий GitHub возвращает ошибку 409, создайте в нём README.

Структура папок, которую ожидает плагин:

your-repo/
├── tokens/          ← Tokens Path: JSON токенов и config.json
└── data/            ← Data Path: файлы Database (необязательно)

Если папки с токенами ещё нет, плагин создаст её при первом Push.

#Шаг 3. Создайте подключение в плагине

1. В футере плагина нажмите шестерёнку Sync settings, затем New Sync.
2. Заполните форму:

3. Нажмите Test connection. Отчёт должен показать Connection OK. Если плагин нашёл, что ветка или папки названы иначе, нажмите Fix, он подставит правильные значения.
4. Нажмите Save, затем Use Git, чтобы сделать подключение активным.

Все поля формы и проверки описаны на странице Подключение к репозиторию.

#Шаг 4. Первая синхронизация

1. Нажмите Pull в футере. Плагин загрузит токены и данные из репозитория, в дереве файлов появятся папки.
2. Измените любой токен и нажмите Push: откроется окно с изменёнными файлами и полем сообщения коммита. После Push коммит появится в репозитории.

Дальше: Pull, Push и ветки.

#GitHub Enterprise Server

1. В поле Enterprise URL укажите адрес сервера, например https://github.company.com. Путь к API плагин добавит сам.
2. Токен создаётся на вашем сервере так же, как на github.com.
3. Если в организации включён SAML SSO, авторизуйте токен для организации: иначе GitHub ответит 403, и плагин покажет GitHub SSO authorization required.

#Если что-то не работает

Полный список проверок и ошибок: Подключение к репозиторию. Если причина не ясна, откройте вкладку Diagnostics и выполните test.

#См. также

• Источники токенов и синхронизация
• Настройка GitLab