リポジトリまたは Organization の開発環境シークレットの管理

シークレットについて

開発環境シークレットは暗号化された環境変数で、組織、リポジトリ、または個人アカウントの GitHub Codespaces 設定で作成します。この記事では、Organization シークレットとリポジトリシークレットを管理する方法について説明します。ユーザー固有シークレットの作成について詳しくは、「GitHub Codespaces のアカウント固有のシークレットの管理」を参照してください。

作成した開発環境シークレットは、GitHub Codespaces で使用できます。 GitHub は、libsodium のシールドボックスを使って、GitHub に到達する前に秘密を暗号化し、コード空間で使うときだけ復号化します。

Organization シークレットを使用すると、複数のリポジトリ間でシークレットを共有できるため、重複するシークレットを作成する必要が軽減されます。アクセスポリシーを使用して、Organization のシークレットを使用できるリポジトリを制御できます。

シークレットを作成すると、新しいcodespaceを作成したり、codespaceを再起動したりすれば、利用できるようになります。 GitHub でシークレットを作成しており、現在実行している codespace でそれを使う場合、codespace を停止し、再起動します。 codespace の停止については、「GitHub Codespaces で Visual Studio Code のコマンドパレットを使う」を参照してください。

シークレットに名前を付ける

シークレットの名前には次のルールが適用されます。

シークレット名には、英数字 ([a-z]、[A-Z]、[0-9]) またはアンダースコア (_) のみを含めることができます。スペースは使用できません。
シークレット名の最初を GITHUB_ プレフィックスにすることはできません。
シークレット名の最初を数字にすることはできません。
シークレット名は大文字と小文字を区別しません。
シークレット名は、作成されたレベルで一意である必要があります。たとえば、リポジトリレベルで作成されたシークレットは、そのリポジトリ内で一意の名前である必要があり、Organization レベルで作成されたシークレットは、そのレベルで一意の名前である必要があります。

複数のレベルで同じ名前のシークレットが存在する場合、最も低いレベルのシークレットが優先されます。たとえば、Organization レベルのシークレット名がリポジトリレベルのシークレット名と同じ場合、リポジトリレベルのシークレット名が優先されます。

シークレットの制限

Organization ごとに最大 100 個のシークレット、リポジトリごとに最大 100 個のシークレットを保存できます。

シークレットのサイズは最大 48 KB です。

リポジトリの推奨シークレット

プロジェクトには、特定のユーザーシークレットが必要になることがあります。たとえば、codespace でアプリケーションを実行するとき、場合によっては、個人の API キーを入力する必要があります。その場合、開発コンテナー構成で推奨シークレットを指定できます。その後、詳細オプションのページで codespace を作成するとき、個人のシークレットをまだ作成していないなら、シークレットの値を入力するように求められます。 codespace で使うシークレット値を入力すると、そのシークレットは Codespaces の個人設定に追加されます。今後、このリポジトリで codespace を作成するとき、このシークレットの値を入力する必要がありません。詳しくは、「リポジトリに推奨シークレットを指定する」を参照してください。

リポジトリにシークレットを追加する

Organization リポジトリの開発環境シークレットを作成するには、管理者アクセス権が必要です。

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
サイドバーの [セキュリティ] セクションで、[ シークレットと変数] を選択してから、[Codespaces] をクリックします。
ページの上部にある [新しいリポジトリシークレット] をクリックします。
[名前] 入力ボックスにシークレットの名前を入力します。
シークレットの値を入力します。
[シークレットの追加] をクリックします。

Organization にシークレットを追加する

Organization で開発環境シークレットを作成する場合、ポリシーを使用して、そのシークレットにアクセスできるリポジトリを制限できます。たとえば、すべてのリポジトリにアクセスを許可したり、プライベートリポジトリまたは指定したリポジトリのリストのみにアクセスを制限したりできます。

組織レベルでシークレットを作成するには、admin アクセス権が必要です。

GitHub で、organization のメインページに移動します。
組織名の下で、 [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
サイドバーの [セキュリティ] セクションで、[ シークレットと変数] を選択してから、[Codespaces] をクリックします。
ページの上部にある [新しいシークレット] をクリックします。
[名前] 入力ボックスにシークレットの名前を入力します。
シークレットの [値] を入力します。
[リポジトリアクセス] ドロップダウンリストから、アクセスポリシーを選びます。
[シークレットの追加] をクリックします。

Organization レベルのシークレットへのアクセスの確認

Organization 内の開発環境シークレットに適用されているアクセスポリシーを確認できます。

GitHub で、organization のメインページに移動します。
組織名の下で、 [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
サイドバーの [セキュリティ] セクションで、[ シークレットと変数] を選択してから、[Codespaces] をクリックします。
必要に応じて、シークレットごとに構成されたアクセス許可を表示または編集するには、シークレットの右側にあるをクリックします。

参考資料

「GitHub Codespaces のアカウント固有のシークレットの管理」