GitHub Codespaces

Prerequisites

• You have created a project in Doppler.
• You have a GitHub account with repository permissions for configuring GitHub Secrets, Actions and Codespaces (and optionally organization permissions for configuring GitHub Organization Secrets).

GitHub Environment

As GitHub doesn't fit into either Development, Staging, or Production, we'll create a dedicated GitHub environment.

Head to the Project page and click Options > Create Environment, then name it GitHub and optionally change the order to have it placed after Development.

Authorization

The next step is authorizing the Doppler GitHub Application to provide access for syncing secrets from Doppler to a chosen repository.

To authorize, click Integrations from the Projects menu, then select GitHub:

Choose the GitHub account or organization to authorize:

Select which repositories Doppler will have secrets access to:

You'll then be redirected back to Doppler. You can now set up your integration using the provided dropdowns.

• For the 'Feature' you can select Actions or Codespaces. In this case, we'll be selecting Codespaces.
• For the 'Sync Target' you would select Repository or Organization.
• Depending on your choice above, you'll be given a new dropdown to further specify your sync target.
  • For the 'Repository' sync target you will now select one of the repositories the Doppler app can access.
  • For the 'Organization' sync target, you can select either Private Repositories or All Repositories for the scope of the sync.
• Finally, select the Config you wish to sync with your GitHub environment.

Click Set Up Integration, and once complete, Doppler will have synced all secrets in the chosen config, as well as creating three DOPPLER specific secrets:

Now every time you add, update or remove a secret in Doppler, that change will be instantly reflected in the GitHub Codespaces secrets for the chosen repository.

📘

Doppler cannot import existing secrets or sync changes to secrets made in GitHub as the secret values are hidden. All secret changes should be made in Doppler to avoid possible confusion.

Organization Secrets

If you connected Doppler to a GitHub Organization, then you'll have the option to sync your secrets to your GitHub Organization Secrets. When setting up the sync, you'll find a Sync Target option that lets you choose between a Repository and the Organization. Choose Organization and then select the Secret Scope you'd like to use.

All Repositories will make any secrets you sync here accessible to both public and private repos in your organization. Private Repositories will only make the secrets accessible to private repos in your organization. After selecting a scope, choose which config you want to have synced over and then click Set Up Integration.

Importing Secrets from GitHub Codespaces

GitHub's API doesn't provide a way to fetch the actual secret values for GitHub Codespaces secrets, so our integration syncs don't provide an import option. If you have existing secrets in GitHub that you would like to import into Doppler, the only way to do that would be installing the CLI within the codespace, and uploading secrets following our CLI documentation.

👍

Amazing Work!

The Doppler GitHub integration will now instantly sync your secret changes to GitHub.