アカウントの GitHub Codespaces をパーソナライズする

Codespaces のパーソナライズについて

開発環境を使用する場合、設定とツールを好みやワークフローに合わせてカスタマイズすることが重要です。 GitHub Codespaces では、Codespaces をパーソナライズするときに使用できる方法は主に 2 つあります。

• 設定の同期 - デスクトップ アプリケーションと VS Code Web クライアントの間で Visual Studio Code 設定を同期できます。
• ドットファイル - dotfiles リポジトリを使用して、スクリプト、シェル設定、およびその他の構成を指定できます。

GitHub Codespaces で行ったパーソナル化は、作成するすべての codespace に適用されます。

プロジェクトのメンテナは、ユーザが作成したリポジトリのすべての codespace に適用されるデフォルト設定を定義することもできます。 詳しくは、「開発コンテナーの概要」を参照してください。

Settings Sync

"設定の同期" を使用すると、設定、キーボードショートカット、スニペット、機能拡張、UI の状態などの設定をマシンと VS Code のインスタンスとの間で同期できます。 詳しい情報については、VS Code ドキュメントの「Settings Sync」を参照してください。

ノート PC の VS Code デスクトップ アプリケーションなど、VS Code のインスタンスで [設定の同期] を有効にすると、そのインスタンスの設定がクラウドに格納されます。 クラウドから、設定は作成時にすべての新しい codespace にプルされ、[設定の同期] が有効になっている既存の codespace に継続的に同期されます。

codespace で [設定の同期] が既定で有効になっているかどうかは、既存の設定と、ブラウザーで codespace を開くか、VS Code デスクトップ アプリケーションで開くかによって異なります。

• ブラウザーで codespace を開くと、Settings Sync は最初は常に無効になります。 つまり、設定の転送は一方向に行われ、一度にのみ行われます。GitHub Codespaces は、作成時にクラウドに格納されている設定を codespace にプルしますが、codespace 内の設定に対して行った更新はクラウドに反映されないため、他の codespace には反映されません。 同様に、他の場所の設定に対して行った更新は codespace に反映されません。
• VS Code デスクトップ アプリケーションで codespace を開くと、以前にアプリケーションで有効にしていた場合、Settings Sync は codespace で有効なままになります。 設定に対して行った更新はクラウドにプッシュされるため、新しい codespace と Settings Sync が有効になっている既存の codespace に反映されます。 Settings Sync が有効になっている他の VS Code インスタンスで設定を更新すると、これらの更新が codespace に反映されます。

Settings Sync が無効になっている codespace で作業している場合は、Settings Sync を有効にして、設定に加えた変更をクラウドにプッシュしたり、他の場所で行った設定に対する最新の変更をプルしたりできます。

Settings Sync の有効化

1. アクティビティ バーの下部にある VS Code で、 を選び、 [Settings Sync をオンにする...] をクリックします。

2. ドロップダウンで、同期する設定を選びます。

   

3. [サインインして有効化] をクリックし、設定を同期するアカウントを選択します。

サインインすると、作業中の VS Code インスタンスが直ちに更新され、同期された最新の設定が表示されます。

Settings Sync の無効化

[設定の同期] を無効にすると、VS Code のインスタンスとの間で設定の同期を停止できます。

既定では、[設定の同期] を無効にすると、新しい codespace では、前回クラウドにプッシュされたときにキャッシュされた設定が引き続き使用されます。 codespace がまだキャッシュされた設定で作成されていて、codespace の既定の VS Code 設定を使用するように戻したい場合は、[設定の同期] を無効にすると、クラウドのキャッシュをクリアできます。

1. VS Code のインスタンスで [設定の同期] が現在無効になっている場合は、まず有効にする必要があります。 手順については、「アカウントの GitHub Codespaces をパーソナライズする」を参照してください。

2. アクティビティ バーの下部にある を選び、 [設定の同期がオン] をクリックします。

3. ドロップダウンで、 [設定の同期: オフにする] をクリックします。

   

4. キャッシュされた設定をクリアするには、ダイアログで [すべてのデバイスで同期を無効にして、クラウドからデータをクリアする] を選びます。

   

5. [オフにする] をクリックします。

Dotfiles

ドットファイルは、. で始まる Unix ライクなシステム上のファイルとフォルダーであり、システム上のアプリケーションとシェルの設定を制御します。 ドットファイルは、GitHub のリポジトリに保存して管理できます。 ドットファイル リポジトリに含める内容に関するアドバイスとチュートリアルについては、GitHub does dotfiles を参照してください。

ドットファイル リポジトリには、シェルのエイリアスと設定、インストールするツール、またはその他の codespace のパーソナル化を含めることができます。

個人の GitHub Codespaces 設定でそのリポジトリを選ぶことで、所有している任意のリポジトリのドットファイルを使用するように GitHub Codespaces を構成できます。

新しい codespace を作成すると、GitHub は選択したドットファイルのリポジトリを codespace 環境にクローンし、次のいずれかのファイルを探して環境を設定します。

• install.sh
• install
• bootstrap.sh
• bootstrap
• script/bootstrap
• setup.sh
• setup
• script/setup

これらのファイルが見つからない場合は、. で始まる選択したドットファイル リポジトリ内のすべてのファイルまたはフォルダーが codespace の ~ または $HOME ディレクトリにシンボリック リンクされます。

選択したドットファイル リポジトリへの変更は、新しい codespace にのみそれぞれ適用され、既存の codespace には影響しません。

Codespaces のドットファイル リポジトリを有効にする

選んだドットファイル リポジトリを使用して、GitHub Codespaces 環境をパーソナライズできます。 ドットファイル リポジトリを選択したら、スクリプト、基本設定、構成を追加できます。 その後、個人の GitHub Codespaces 設定ページからドットファイルを有効にする必要があります。

1. 任意のページで、右上隅にあるプロファイルの画像をクリックし、次に[設定]をクリックします。

   1. サイドバーの [Code, planning, and automation](コード、計画、および自動化) セクションで、 [ Codespaces] をクリックします。

2. "ドットファイル" の下で [ドットファイルを自動的にインストールする] を選ぶと、GitHub Codespaces によって、作成したすべての新しい codespace にドットファイルが自動的にインストールされます。

   

3. ドロップダウンを使用して、ドットファイルのインストール元のリポジトリを選びます。

   

ドットファイル リポジトリにスクリプト、基本設定、構成ファイルをさらに追加したり、必要に応じて既存のファイルを編集したりできます。 設定の変更は、新しい codespace によってのみ取得されます。

codespace によるドットファイルからの構成設定の取得が失敗する場合は、「GitHub Codespaces の個人用設定オプションのトラブルシューティング」をご覧ください。

その他の使用可能な設定

個人用設定の追加オプションを使用して、GitHub Codespaces をカスタマイズすることもできます。

• GPG の検証を有効にするには、「GitHub Codespaces の GPG 検証を管理する」をご覧ください。
• エディターを設定するには、「GitHub Codespaces の既定のエディターを設定する」をご覧ください。
• 使われていない codespace が自動的に停止されるまでの期間を設定する方法については、「GitHub Codespaces のタイムアウト期間を設定する」をご覧ください。
• 使われていない codespace を保持する期間を設定する方法については、「codespace の自動削除を構成する」をご覧ください。
• 既定のリージョンを設定する方法については、「GitHub Codespaces の既定のリージョンを設定する」をご覧ください。

参考資料

• 新しいリポジトリの作成
• GitHub Codespaces の詳細