GitHub Classroom で GitHub codespace を使用する

GitHub Codespaces を割り当てで優先エディターとして使用し、ワン クリックで設定できるブラウザーベースの Visual Studio Code 環境に学生がアクセスできるようにできます。

この機能を使用できるユーザーについて

Organization owners who are admins for a classroom can enable GitHub Codespaces for their organization and integrate GitHub Codespaces as the supported editor for an assignment. クラスルーム管理者の詳細については、「クラスルームの管理」を参照してください。

GitHub Codespaces は、GitHub Team を使用する Organization の GitHub Classroom で使用できます。 GitHub Team への無料アップグレードの対象かどうかを確認するには、「教師として GitHub Education に応募する」を参照してください。

この記事の内容

GitHub Codespaces について

GitHub Codespaces は、クラウドベースのインスタント開発環境であり、コンテナーを使用して開発用の共通言語、ツール、ユーティリティを提供します。 また、GitHub Codespaces も構成可能で、プロジェクトのすべてのユーザーに共通のカスタマイズされた開発環境を作成できます。 「GitHub Codespaces の概要」を参照してください。

Organization または Enterprise で GitHub Codespaces を有効にすると、ユーザーは、任意のブランチから codespace を作成するか、Organization または Enterprise リポジトリでコミットし、クラウドベースのコンピューティング リソースを使用して開発を始めることができます。 codespace には、ブラウザーから、または Visual Studio Code を使用してローカルに、接続できます。

GitHub Codespaces の使用を開始するには、「GitHub Codespaces のクイックスタート」を参照してください。 codespace の作成の詳細については、「リポジトリの codespace を作成する」か「テンプレートから codespace を作成する」を参照してください。 既に作成した codespace に戻る場合は、「既存の codespace を開く」を参照してください。 GitHub Codespaces のしくみの詳細については、「GitHub Codespaces の詳細」を参照してください。

GitHub Codespaces を、GitHub Classroom の課題で課題用の優先エディターとして設定すると、学生と教師の両方にとって役立ちます。 GitHub Codespaces は、各 codespace がクラウドベースであり、ローカルでの設定が必要ないため、貸し出されているデバイスを使っている学生、またはローカル IDE 設定にアクセスできない学生に適したオプションです。 学生は、ブラウザーで直接 Visual Studio Code 内の課題リポジトリの codespace を起動し、すぐに開発を開始できます。追加の構成は必要ありません。

複雑な設定環境を使用する課題の場合、教師はリポジトリの codespace 向け開発コンテナーの構成をカスタマイズできます。 これにより、学生が codespace を作成する際、教師が構成した開発環境で codespace が自動的に開くようになります。 開発コンテナーの詳細については、「開発コンテナーの概要」を参照してください。

Note

個々の codespace は、停止されて長期間未使用のままになっている場合は、自動的に削除されます。 「codespace の自動削除を構成する」を参照してください。

検証済みの学生は、個人アカウントに対して GitHub Codespaces を無料で使用できます (1 か月あたり最大 180 コア時間)。 学生が使用できるストレージとコア時間の月間使用量は、GitHub Pro アカウントに含まれる量と同じです。 詳しくは、「GitHub Codespaces の請求について」を参照してください。

Note

学生が GitHub Classroom の課題リポジトリで GitHub Codespaces を使用している場合、その使用量は教室を所有する組織に課金され、学生の個人アカウントの使用量には影響しません。

認証済み教師に対する Codespaces Education 特典について

Codespaces Education 特典を利用すると、認証済みの教師には、GitHub Classroom での GitHub Codespaces の利用時間について、毎月無料の使用枠が与えられます。 この無料利用枠は、学生ごとに 1 つの codespace が保存されている 2 コアのマシンで、毎月 5 つの課題がある 50 人のクラスを目安としています。

Note

Codespaces Education ベネフィットは現在 パブリック プレビュー 段階であり、変更される可能性があります。 パブリック プレビュー リリース期間中は、無料利用枠を超えた場合でも、組織には課金されません。

認証済み教師になるには、教育者特典または教師特典の承認を受ける必要があります。 「教師として GitHub Education に応募する」を参照してください。

認証済み教師であるという確認を受け取ったら、GitHub Education for Teachers にアクセスして、Organization を GitHub Team にアップグレードします。 「GitHub の製品」を参照してください。

Codespaces Education 特典の対象者の場合、Organization の GitHub Classroom で GitHub Codespaces を有効にすると、GitHub では、Codespace ポリシーが自動的に追加され、Organization 内のすべての codespace のマシンの種類が 2 コア マシンに制限されます。 これは、GitHub Codespaces の無料使用量を最大限に活用するのに役立ちます。 ただし、これらのポリシーは、Organization の設定で変更または削除できます。 「コンピューターの種類へのアクセスを制限する」を参照してください。

Codespaces Education 特典が パブリック プレビュー から移行されると、Organization での GitHub Codespaces の使用量が無料利用枠を超えた場合、追加の使用量に対して請求が行われます。 「GitHub Codespaces の請求について」を参照してください。

Organization での Codespaces の有効化

GitHub Codespaces は、GitHub Team を使用する Organization の GitHub Classroom で使用できます。 Codespaces Education 特典の対象である場合、GitHub Codespaces は、Organization の設定で直接有効にするのではなく、GitHub Classroom を介して有効にする必要があります。 そうしないと、Organization での GitHub Codespaces のすべての使用量に対して直接請求されることになります。

新しいクラスルームの作成時に Organization の codespace を有効にする

  1. GitHub Classroomにサインインしてください。
  2. ページの右側にある [新しいクラスルーム] をクリックします。
  3. Organizationのリスト中で、クラスルームに使いたいOrganizationをクリックしてください。 GitHub Codespaces の対象となる Organization には、対象であることを示すメモが表示されます。 あるいは、新しいOrganizationを作成することもできます。 「新しい Organization をゼロから作成」を参照してください。
  4. [クラスルームに名前を付ける] ページの [Classroom の Codespaces] で、 [有効] をクリックします。 これにより、Organization 内のすべてのリポジトリとユーザーに対して GitHub Codespaces が有効になることにご注意ください。
  5. 新しいクラスルームを作成する準備ができたら、 [クラスルームの作成] をクリックします。

既存のクラスルームを使用して Organization の codespace を有効にする

  1. GitHub Classroomにサインインしてください。

  2. クラスルームのリストで、表示したいクラスルームをクリックしてください。

  3. クラスルーム名の下にある [設定] をクリックします。

    クラスルームのタブのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で囲まれています。

  4. GitHub Codespaces で、有効 をクリックします。 これにより、Organization 内のすべてのリポジトリとユーザーに対して GitHub Codespaces が有効になります。 新しい Codespace ポリシーも追加され、Organization 内のすべて codespace のマシンの種類が 2 コア マシンに制限されます。

上記と同じ方法を使用して、Organization の GitHub Codespaces を無効にすることもできます。 これにより、Organization 内のすべてのユーザーとリポジトリに対して GitHub Codespaces が無効になることにご注意ください。

Codespaces を使用するように課題を構成する

学生が GitHub Codespaces を課題に使用できるようにするには、課題向けのサポートされるエディターとして GitHub Codespaces を選ぶことができます。 新しい課題を作成するときに、[スタート コードを追加してオプションのオンライン IDE を選択する] ページの [サポートされるエディターの追加] で、ドロップダウン メニューから [GitHub Codespaces] を選択します。

課題のテンプレート リポジトリを使用する場合、リポジトリ内の開発コンテナーを定義して、学生が codespace を起動して課題に取り組むときに使用できるツールとランタイムをカスタマイズできます。 開発コンテナーを定義しない場合、GitHub Codespaces では、既定の構成が使用されます。これには、学生が開発に必要とする可能性のある一般的なツールが多く含まれています。 開発コンテナーの定義の詳細については、「開発コンテナー構成のリポジトリへの追加」を参照してください。

GitHub Codespaces を使用して課題を起動する

学生が課題を開くと、リポジトリの README ファイルに、学生が作業に使用する必要がある IDE に関する教師の推奨事項が含まれます。

学生は、README の [GitHub Codespace で開く] ボタンをクリックするか、課題リポジトリのメイン ページにある [ コード] ボタンをクリックして、 [Codespaces] タブを選ぶと、新規または既存の codespace を起動できます。 [Codespaces] タブでは、既存の codespace を選ぶか、新しい codespace を作成できます。 「リポジトリの codespace を作成する」を参照してください。

課題のリポジトリのスクリーンショット。 新しい codespace を起動するための [コード] ドロップダウン メニューが展開されています。

教師は、[課題の概要] ページで各学生の課題の codespace を表示できます。 各学生行の右側にある [codespace] アイコンをクリックして codespace を起動できます。

課題の概要のスクリーンショット。 Codespaces アイコンが濃いオレンジ色の枠線で囲まれています。

ブラウザーを使用して codespace に接続する場合は、自動保存が自動的に有効になります。 リポジトリに対する変更を保存する場合、変更をコミットしてリモート ブランチにプッシュする必要があります。 既定では、30 分間操作することなく codespace を実行したままにした場合、codespace はタイムアウトになり、実行が停止されます。 データは、最後に変更した時点の状態で保持されます。 codespace のライフサイクルの詳細については、「codespace ライフサイクルについて」を参照してください。