Managing access to other repositories within your codespace

概要

By default, your codespace is assigned a token scoped to the repository from which it was created. For more information, see "Security in Codespaces." If your project needs additional permissions for other repositories, you can configure this in the devcontainer.json file and ensure other collaborators have the right set of permissions.

When permissions are listed in the devcontainer.json file, you will be prompted to review and authorize the additional permissions as part of codespace creation for that repository. Once you've authorized the listed permissions, GitHub Codespaces will remember your choice and will not prompt you for authorization unless the permissions in the devcontainer.json file change.

必要な環境

To create codespaces with custom permissions defined, you must use one of the following:

• The GitHub web UI
• GitHub CLI 2.5.2 or later
• GitHub Codespaces Visual Studio Code extension 1.5.3 or later

Setting additional repository permissions

1. You configure repository permissions for GitHub Codespaces in the devcontainer.json file. If your repository does not already contain a devcontainer.json file, add one now. For more information, "Add a dev container to your project."

2. Edit the devcontainer.json file, adding the repository name and permissions needed to the repositories object:

   JSON

   {
     "customizations": {
       "codespaces": {
         "repositories": {
           "my_org/my_repo": {
             "permissions": {
               "issues": "write"
             }
           }
         }
       }
     }
   }

   Note: You can only reference repositories that belong to the same personal account or organization as the repository you are currently working in.

   You can grant as many or as few of the following permissions for each repository listed:

   • actions - read / write
   • checks - read / write
   • contents - read / write
   • deployments - read / write
   • discussions - read / write
   • issues - read / write
   • packages - read
   • pages - read / write
   • pull_requests - read / write
   • repository_projects - read / write
   • statuses - read / write
   • workflows - write

   To set a permission for all repositories in an organization, use the * wildcard following your organization name in the repositories object.

   {
     "customizations": {
       "codespaces": {
         "repositories": {
           "my_org/*": {
             "permissions": {
               "issues": "write"
             }
           }
         }
       }
     }
   }
   

   To set all permissions for a given repository, use "permissions": "read-all" or "permissions": "write-all" in the repository object.

   {
     "customizations": {
       "codespaces": {
         "repositories": {
           "my_org/my_repo": {
             "permissions": "write-all"
           }
         }
       }
     }
   }
   

Authorizing requested permissions

If additional repository permissions are defined in the devcontainer.json file, you will be prompted to review and optionally authorize the permissions when you create a codespace for this repository. When you authorize permissions for a repository, GitHub Codespaces will not re-prompt you unless the set of requested permissions has changed for the repository.

You should only authorize permissions for repositories you know and trust. If you don't trust the set of requested permissions, click Continue without authorizing to create the codespace with the base set of permissions. Rejecting additional permissions may impact the functionality of your project within the codespace as the codespace will only have access to the repository from which it was created.

You can only authorize permissions that your personal account already possesses. If a codespace requests permissions for repositories that you don't currently have access to, contact an owner or admin of the repository to obtain sufficient access and then try to create a codespace again.

Access and security

When you enable access and security for a repository owned by your personal account, any codespaces that are created for that repository will have read permissions to all other repositories you own. Codespace がアクセスできるリポジトリを制限する場合は、Codespace がオープンされたリポジトリまたは特定のリポジトリのいずれかに制限できます。 信頼するリポジトリに対してのみ、アクセスとセキュリティを有効にしてください。

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

   

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

3. Under "Access and security", select the setting you want for your personal account.

   

4. [Selected repositories] を選択した場合、ドロップダウンメニューを選択してから、あなたの所有するその他のリポジトリにアクセスを許可する、リポジトリのコードスペースをクリックします。 所有するその他のリポジトリにコードスペースによるアクセスを許可したい、すべてのリポジトリについて同じ手順を繰り返します。

   

参考リンク

• "Managing repository access for your organization's codespaces"