GitHub 同期

Velxioプロジェクトを保存するたびに、GitHub Sync はスケッチ、キャンバス状態、生成されたREADMEを、あなたが所有するGitHubリポジトリにコミットしてプッシュします。あなたのコードは、自分自身のバージョン管理の中で生き続けます。Velxioは、その上に重なるエディタにすぎません。

GitHub SyncはProティアの一部です。プランを参照してください。

同期されるもの

保存が成功するたびに、Velxioはリポジトリのルートに以下を書き込みます。

• sketch.ino — アクティブなボードのファイルグループにある、追加の .ino / .h / .c / .py ファイルも含みます。
• velxio.json — 完全なキャンバス状態: ボードタイプ、配置されたコンポーネント、配線、ボードごとのレイアウト。リポジトリをクローンした人は誰でも、Velxioでプロジェクトを開き、まったく同じ回路を見ることができます。
• README.md — プロジェクト名、説明、および「Open in Velxio」ディープリンクを含む自動生成ファイル。よりリッチなREADMEが必要になったら、自由に上書きできます。

Velxioは、これらのパス以外のファイルには一切触れません。CI設定、ドキュメント、写真など、リポジトリ内の他のものはそのまま残ります。

有効にする方法

1. 保存済みのプロジェクトを開きます。エディタのツールバーにある**…**オーバーフローメニューをクリックし、Sync to GitHub を選択します。
2. 初回のみ: Connect GitHub をクリックします。GitHubは、Velxioに書き込みを許可するリポジトリを尋ねます。Velxioは、選択したリポジトリのみへのインストールスコープのアクセス権を取得します。「すべてのリポジトリ」への包括的な権限は付与されません。
3. ドロップダウンからターゲットリポジトリを選択し、Link & sync now を押します。Velxioは最初のコミットをプッシュし、SHAとリンクを表示します。
4. これで完了です。以降、保存のたびに別のコミットがプッシュされます。Syncモーダルには、最後の同期時刻とコミットへの直接リンクが表示されます。

セキュリティモデル

Velxioは、個人用のOAuthトークンではなく、GitHub App を使用します。

• リポジトリごとのオプトイン — インストール時に、Velxioが書き込みできるリポジトリを選択します。github.com/settings/installations からいつでもリポジトリを削除または追加できます。
• 長期有効なトークンはなし — 同期のたびに、約1時間有効な新しいインストールトークンが生成されます。ユーザーOAuthトークンは(接続時にGitHubプロフィールを取得するために)一度だけ使用され、破棄されます。
• 分離されたレート制限 — Appには、個人用ツールとは別の独自のクォータがあります。
• クリーンな切断 — GitHub設定からVelxio Appを削除すると、アクセスは即座に失効します。VelxioはWebhookを検出して、古い状態を残さずに切断します。

競合と手動編集

同期は現在一方向プッシュです: Velxio → GitHub。Velxioの保存と保存の間にGitHub上で行われた手動編集は、次の保存時に上書きされます。同期されたファイルの情報源はVelxioです。

しばらくVS Codeでローカル開発をしたいですか? プロジェクトのリンクを解除し(Syncモーダル → Unlink)、ローカルクローンで作業して、再びVelxioから操作する準備ができたら再リンクしてください。双方向同期はロードマップに含まれています。

FAQ

同期に失敗した場合はどうなりますか? 失敗はSyncモーダルに回復アクション(Reconnect GitHub、別のリポジトリの選択、後で再試行)とともに表示されます。保存自体がブロックされることはありません。プロジェクトは常にVelxio内に保存されます。

自分が所有していないリポジトリに同期できますか? はい。GitHub Appが組織にインストールされ、そこに書き込みアクセス権があれば可能です。

プライベートリポジトリはどうですか? 完全にサポートされています。インストール時に承認したものは、公開・非公開を問わず書き込み可能になります。

READMEをカスタマイズできますか? 現在、Velxioは同期のたびに README.md を上書きします。ロードマップには、ファイルの所有権を取得した後の上書きスキップが含まれています。