GitHub Sync

Каждый раз, когда вы сохраняете проект Velxio, GitHub Sync фиксирует и отправляет скетч, состояние холста и сгенерированный README в репозиторий GitHub, которым вы владеете. Ваш код продолжает жить в вашей собственной системе контроля версий — Velxio — это просто редактор поверх нее.

GitHub Sync входит в тариф Pro — см. планы.

Что синхронизируется

При каждом успешном сохранении Velxio записывает в корень вашего репозитория:

• sketch.ino — а также любые дополнительные файлы .ino / .h / .c / .py в файловой группе активной платы.
• velxio.json — полное состояние холста: тип платы, размещенные компоненты, провода и раскладка для каждой платы. Тот, кто клонирует ваш репозиторий, может открыть проект в Velxio и увидеть точно такую же схему.
• README.md — автоматически сгенерированный, с названием проекта, описанием и глубокой ссылкой «Открыть в Velxio». Вы можете свободно перезаписывать его, когда захотите более подробный README.

Velxio никогда не трогает файлы за пределами этих путей — конфигурацию CI, документацию, фотографии и все остальное в репозитории он не изменяет.

Как включить

1. Откройте любой сохраненный проект. Нажмите на меню переполнения … на панели инструментов редактора и выберите Sync to GitHub (Синхронизировать с GitHub).
2. Только в первый раз: нажмите Connect GitHub (Подключить GitHub). GitHub спросит, в какие репозитории вы хотите разрешить Velxio записывать — Velxio получает доступ с областью действия установки только к этим репозиториям, без общего разрешения «все ваши репозитории».
3. Выберите целевой репозиторий из раскрывающегося списка и нажмите Link & sync now (Связать и синхронизировать сейчас). Velxio отправляет начальный коммит и показывает SHA + ссылку.
4. Вот и все. Каждое последующее сохранение отправляет еще один коммит; модальное окно Sync показывает время последней синхронизации и прямую ссылку на коммит.

Модель безопасности

Velxio использует GitHub App, а не личный OAuth-токен:

• Выбор по репозиториям — вы выбираете при установке, в какие репозитории Velxio может записывать, и можете отозвать или добавить репозитории в любое время на github.com/settings/installations.
• Нет долгоживущих токенов — каждая синхронизация создает новый токен установки сроком ~1 час; пользовательские OAuth-токены используются ровно один раз (для получения вашего профиля GitHub при подключении) и затем удаляются.
• Изолированный лимит запросов — у приложения своя квота, отдельная от ваших личных инструментов.
• Чистое отключение — удаление приложения Velxio из ваших настроек GitHub немедленно отзывает доступ; Velxio получает вебхук и отключается без устаревшего состояния.

Конфликты и ручные правки

Синхронизация в настоящее время является односторонней отправкой: Velxio → GitHub. Ручные правки, сделанные на GitHub между сохранениями Velxio, будут перезаписаны при следующем сохранении — Velxio является источником истины для синхронизируемых файлов.

Хотите некоторое время разрабатывать локально в VS Code? Отвяжите проект (модальное окно Sync → Unlink (Отвязать)), работайте в локальном клоне, затем снова привяжите, когда будете готовы снова управлять из Velxio. Двусторонняя синхронизация находится в дорожной карте.

Часто задаваемые вопросы

Что если синхронизация не удалась? Сбои отображаются в модальном окне Sync с действием по восстановлению (Reconnect GitHub (Переподключить GitHub), выбрать другой репозиторий, повторить позже). Само сохранение никогда не блокируется — ваш проект всегда сохраняется внутри Velxio.

Могу ли я синхронизироваться с репозиторием, которым не владею? Да, если GitHub App установлен в организации и у вас есть права на запись там.

А как насчет приватных репозиториев? Полностью поддерживаются — все, что вы авторизуете при установке, становится доступным для записи, публичным или приватным.

Могу ли я настроить README? Сегодня Velxio перезаписывает README.md при каждой синхронизации. В дорожной карте: пропуск перезаписи, когда вы взяли на себя управление файлом.