Skip to main content

Managing encrypted secrets for your repository and organization for GitHub Codespaces

Encrypted secrets allow you to store sensitive information in your organization, repository, or GitHub Codespaces.

Who can use this feature

To manage secrets for GitHub Codespaces for an organization, you must be an organization owner.

Os GitHub Codespaces estão disponíveis para organizações que usam o GitHub Team ou o GitHub Enterprise Cloud. GitHub Codespaces também está disponível como uma versão beta limitado para usuários individuais nos planos GitHub Free e GitHub Pro. Para obter mais informações, confira "produtos de GitHub".

About secrets

Secrets are encrypted environment variables that you create in an organization or repository. The secrets that you create are available to use in GitHub Codespaces. GitHub uses a libsodium sealed box to encrypt secrets before they reach GitHub and only decrypts them when you use them in a codespace.

Organization-level secrets let you share secrets between multiple repositories, which reduces the need to create duplicate secrets. You can use access policies to control which repositories can use organization secrets.

Once you have created a secret, it will be available when you create a new codespace or restart the codespace. To use a secret that you've just created in a current codespace, you will need to stop the codespace and resume it. For information about stopping the codespace, see "Using the Visual Studio Code Command Palette in GitHub Codespaces."

Naming secrets

As regras a seguir aplicam-se aos nomes dos segredos:

  • Os nomes secretos só podem conter caracteres alfanuméricos ([a-z], [A-Z], [0-9]) ou sublinhados (_). Espaços não são permitidos.

  • Os nomes secretos não devem começar com o prefixo GITHUB_.

  • Os nomes dos segredos não devem começar com um número.

  • Nomes dos segredos não diferenciam maiúsculas de minúsculas.

  • Os nomes dos segredos devem ser únicos no nível em que são criados. For example, a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level.

    Se houver um segredo com o mesmo nome em vários níveis, o segredo no nível mais baixo terá precedência. Por exemplo, se um segredo a nível de organização tiver o mesmo nome que um segredo a nível de repositório, o segredo a nível de repositório terá prioridade.

Limits for secrets

You can store up to 100 secrets per organization and 100 secrets per repository.

Secrets are limited to 64 KB in size.

Adding secrets for a repository

To create secrets for an organization repository, you must have administrator access.

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Abaixo do nome do repositório, clique em Configurações. Botão Configurações do repositório

  3. In the "Security" section of the sidebar, select Secrets, then click Codespaces.

  4. At the top of the page, click New repository secret.

  5. Type a name for your secret in the Name input box.

  6. Enter the value for your secret.

  7. Click Add secret.

Adding secrets for an organization

When creating a secret in an organization, you can use a policy to limit which repositories can access that secret. For example, you can grant access to all repositories, or limit access to only private repositories or a specified list of repositories.

Para criar segredos no nível da organização, você precisa ter acesso de admin.

  1. No GitHub.com, navegue até a página principal da organização.

  2. No nome da sua organização, clique em Configurações. Botão Configurações da organização

  3. In the "Security" section of the sidebar, select Secrets, then click Codespaces.

  4. At the top of the page, click New organization secret.

  5. Type a name for your secret in the Name input box.

  6. Enter the Value for your secret.

  7. From the Repository access dropdown list, choose an access policy. Repository Access list with private repositories selected

  8. Click Add secret.

Reviewing access to organization-level secrets

You can check which access policies are applied to a secret in your organization.

  1. No GitHub.com, navegue até a página principal da organização.

  2. No nome da sua organização, clique em Configurações. Botão Configurações da organização

  3. In the "Security" section of the sidebar, select Secrets, then click Codespaces.

  4. The list of secrets includes any configured permissions and policies. For example: Secrets list

  5. For more details on the configured permissions for each secret, click Update.

Further reading