Codespaces の暗号化されたシークレットを管理する

GitHub Codespaces の暗号化されたシークレットについて

You can add encrypted secrets to your personal account that you want to use in your codespaces. たとえば、次のような機密情報を暗号化されたシークレットとして保存しアクセスするとよいでしょう。

• クラウドサービスへの個人アクセストークン
• サービスプリンシパル
• プラン識別子
• Credentials for a private image registry

各シークレットにアクセスできるリポジトリを選択できます。 そして、シークレットへのアクセス権があるリポジトリ用に作成した任意のコードスペースでそのシークレットを使用できます。

シークレットを作成すると、新しいcodespaceを作成したり、codespaceを再起動したりすれば、利用できるようになります。 作成したばかりのシークレットを現在のcodespaceで使うには、codespaceを停止して再開しなければなりません。 codespaveの停止に関する情報については「Codespacesでのコマンドパレットの利用」を参照してください。

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

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

• シークレット名には、英数字（[a-z]、[A-Z]、[0-9]）または下線（_）のみを含めることができます。 スペースは使用できません。

• シークレット名の最初を GITHUB_ プレフィックスにすることはできません。

• シークレット名の最初を数字にすることはできません。

• シークレット名は大文字と小文字を区別しません。

• シークレット名は、作成されたレベルで一意である必要があります。 たとえば、リポジトリレベルで作成されたシークレットは、そのリポジトリ内で一意の名前である必要があります。

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

シークレットの制限

GitHub Codespaces には最大 100 個のシークレットを保存できます。

シークレットの容量は最大64 KBです。

シークレットを追加する

1. 任意のページの右上で、プロフィール画像をクリックし、続いてSettings（設定）をクリックしてください。

   

2. In the "Code, planning, and automation" section of the sidebar, click Codespaces.

3. [Codespaces secrets] の右にある [New secret] をクリックします。

4. [Name] で、シークレットの名前を入力します。

5. "Value（値）"の下で、シークレットの値を入力してください。

6. "Repository access（リポジトリアクセス）"ドロップダウンメニューを選択し、続いてシークレットへアクセスしたいリポジトリをクリックしてください。 シークレットにアクセスしたいすべてのリポジトリに対して繰り返してください。

7. [Add secret（シークレットの追加）] をクリックします。

シークレットを編集する

既存のシークレットの値を更新したり、シークレットがアクセスできるリポジトリを変更したりすることができます。

1. 任意のページの右上で、プロフィール画像をクリックし、続いてSettings（設定）をクリックしてください。

   

2. In the "Code, planning, and automation" section of the sidebar, click Codespaces.

3. [Codespaces secrets] で、編集するシークレットの右にある [Update] をクリックします。

4. [Value] にある [enter a new value] をクリックします。

5. "Value（値）"の下で、シークレットの値を入力してください。

6. "Repository access（リポジトリアクセス）"ドロップダウンメニューを選択し、続いてシークレットへアクセスしたいリポジトリをクリックしてください。 シークレットにアクセスしたいすべてのリポジトリに対して繰り返してください。

7. リポジトリへのシークレットのアクセス権を削除する場合は、リポジトリを選択解除します。

8. [Save changes] をクリックします。

シークレットを削除する

1. 任意のページの右上で、プロフィール画像をクリックし、続いてSettings（設定）をクリックしてください。

   

2. In the "Code, planning, and automation" section of the sidebar, click Codespaces.

3. [Codespaces secrets] で、削除するシークレットの右にある [Delete] をクリックします。

4. 警告を読んで、OKをクリックしてください。

シークレットを使用する

A secret is exported as an environment variable into the user's terminal session.

You can use secrets in a codespace after the codespace is built and is running. For example, a secret can be used:

• When launching an application from the integrated terminal or ssh session.
• Within a dev container lifecycle script that is run after the codespace is running. For more information about dev container lifecycle scripts, see the documentation on containers.dev: Specification.

Codespace secrets cannot be used during:

• Codespace build time (that is, within a Dockerfile or custom entry point).
• Within a dev container feature. For more information, see the features attribute in the documentation on containers.dev: Specification.

参考リンク

• "Managing encrypted secrets for your repository and organization for GitHub Codespaces"