リポジトリの codespace を作成する

リポジトリのブランチの codespace を作成して、オンラインで開発できます。

この記事の内容

メモ

GitHub Codespaces は、octocorp.ghe.com など、GHE.com のサブドメインでは利用できません。

リポジトリの codespace の作成について

codespace は、GitHub、Visual Studio Code、または GitHub CLI を使用して作成できます。 この記事のタブを使用して、codespace を作成するこれらの各方法の手順を表示します。

個人の GitHub アカウントで GitHub Codespaces を使用できます。無料プランとプロ プランのアカウントには毎月無料使用のクォータが含まれています。 毎月含まれているストレージとコンピューティングの使用量を超えて GitHub Codespaces を使い続けるには、支払い情報を入力して、利用限度を設定します。 「GitHub Codespaces の請求について」をご覧ください。

組織は、メンバーと外部コラボレーターが組織の費用で codespace を作成して使用できるようにすることができます。 詳しくは、「組織内の codespace を誰が所有し、支払うかの選択」をご覧ください。

組織所有のリポジトリから codespace を作成できるかどうかは、リポジトリの可視性、組織またはその親企業の設定など、いくつかの要因によって異なります。 詳しくは、「codespace の作成と削除のトラブルシューティング」をご覧ください。

メモ

マネージド ユーザー アカウント がある場合、リポジトリが組織所有のリポジトリのフォークであり、GitHub Codespaces を組織の費用で使用できる場合を除き、個人用リポジトリの codespace を作成することはできません。 詳しくは、「Enterprise Managed Users について」をご覧ください。

新しいプロジェクトを始める場合は、テンプレートから codespace を作成して、後で GitHub でリポジトリを公開できます。詳しくは、「テンプレートから codespace を作成する」をご覧ください。

リポジトリから codespace を作成すると、codespace は特定のブランチに関連付けられます。空にすることはできません。 リポジトリごと、さらにはブランチごとに1つ以上のcodespaceを作成できます。

[コードスペース] ページで、作成したすべての使用可能なすべてのコードスペースを確認できます。 このページを表示するには、GitHub の左上隅にある を選択し、コードスペースをクリックします。 これにより、github.com/codespaces に移動します。

codespace の作成プロセス

codespace を作成すると、開発環境を作成して開発環境に接続するためのいくつかの手順が発生します。

  • 手順 1: VM とストレージが codespace に割り当てられます。
  • 手順 2: コンテナーが作成され、リポジトリが複製されます。
  • 手順 3: codespace に接続できます。
  • 手順 4: codespace では、作成後のセットアップが続行されます。

codespace を作成するときに行われることについて詳しくは、「GitHub Codespaces の詳細」をご覧ください。

codespace のライフサイクルについて詳しくは、「codespace ライフサイクルについて」をご覧ください。

codespace に Git フックを使用する場合は、devcontainer.json ライフサイクル スクリプト (例: postCreateCommand) を使用してフックを設定する必要があります。 これらは、上記の手順 4 で実行されます。 ライフサイクル スクリプトについて詳しくは、開発コンテナーの Web サイト上にある「開発コンテナー仕様」をご覧ください。 リポジトリの複製後に codespace の開発者コンテナーが作成されるため、開発者コンテナー イメージで構成された Git テンプレート ディレクトリ は codespace には適用されません。 代わりに、codespace の作成後にフックをインストールする必要があります。

VS Code の codespace で開発をする際に、コードを編集し、デバッグし、Gti のコマンドを使うことができます。 詳しい情報については、VS Code のドキュメントを参照してください。

コードスペースの作成を高速化するために、リポジトリ管理者はリポジトリの GitHub Codespaces プレビルドを有効にすることができます。 詳しくは、「GitHub Codespaces のプレビルドについて」をご覧ください。

リポジトリの codespace を作成する

メモ

GitHub CLI の詳細については、「GitHub CLI について」を参照してください。

新しい codespace を作成するには、gh codespace create サブコマンドを使用します。

gh codespace create

リポジトリの選択を求められます。 codespace の料金を支払うユーザーを示すメッセージが表示されます。 その場合、ブランチ、開発コンテナー構成ファイル (複数ある場合)、コンピューターの種類 (複数ある場合) を選ぶように求められます。

または、フラグを使用して、次に示すオプションの一部またはすべてを特定することもできます。

gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE

この例の owner/repo をリポジトリ識別子に置き換えます。 branch を codespace で最初にチェックアウトするブランチの名前、またはコミットの完全な SHA ハッシュに置き換えます。 b フラグなしで -r フラグを使用する場合、codespace は既定のブランチから作成されます。

新しいコードスペースで使用する開発コンテナー構成ファイルへのパスに path を置き換えます。 このフラグを省略し、複数の開発コンテナー ファイルを使用できる場合は、リストから 1 つを選ぶダイアログが表示されます。 開発コンテナーの構成ファイルについて詳しくは、「開発コンテナーの概要」をご覧ください。

machine-type を使用可能なマシンの種類の有効な識別子に置き換えます。 識別子は、basicLinux32gb や standardLinux32gb のような文字列です。 使用可能なマシンの種類は、リポジトリ、個人用アカウント、場所によって異なります。 無効または使用できないマシンの種類を入力すると、使用可能な種類がエラー メッセージに表示されます。 このフラグを省略し、複数のマシンの種類を使用できる場合は、リストから 1 つを選択するダイアログが表示されます。

このコマンドのオプションについて詳しくは、GitHub CLI マニュアルを参照してください。

参考資料