Managing encrypted secrets for Dependabot

You can store sensitive information, like passwords and access tokens, as encrypted secrets and then reference these in the Dependabot configuration file.

About encrypted secrets for Dependabot

Dependabot secrets are encrypted credentials that you create at either the organization level or the repository level. When you add a secret at the organization level, you can specify which repositories can access the secret. You can use secrets to allow Dependabot to update dependencies located in private package registries. When you add a secret it's encrypted before it reaches GitHub and it remains encrypted until it's used by Dependabot to access a private package registry.

After you add a Dependabot secret, you can reference it in the dependabot.yml configuration file like this: ${{secrets.NAME}}, where "NAME" is the name you chose for the secret. Ein Beispiel:

password: ${{secrets.MY_ARTIFACTORY_PASSWORD}}

For more information, see "Configuration options for dependency updates."

Benennen Ihrer Geheimnisse

The name of a Dependabot secret:

  • Can only contain alphanumeric characters ([A-Z], [0-9]) or underscores (_). Leerzeichen sind nicht zulässig. If you enter lowercase letters these are changed to uppercase.
  • Must not start with the GITHUB_ prefix.
  • Must not start with a number.

Adding a repository secret for Dependabot

Um Geheimnisse für ein Benutzerkonto-Repository zu erstellen, musst Du der Repository-Inhaber sein. Um Geheimnisse für ein Organisations-Repository zu erstellen, musst Du admin-Zugriff haben.

  1. Navigiere in GitHub zur Hauptseite des Repository.

  2. Klicke unter Deinem Repository-Namen auf Settings (Einstellungen). Schaltfläche „Repository settings" (Repository-Einstellungen)

  3. Klicken Sie auf der linken Seitenleiste auf Secrets (Geheimnisse).

  4. In the sidebar, click Dependabot. Dependabot secrets sidebar option

  5. Click New repository secret.

  6. Geben Sie einen Namen für Ihr Geheimnis in das Eingabefeld Name ein.

  7. Geben Sie den Wert für Ihr Geheimnis ein.

  8. Klicken Sie auf Add secret (Geheimnis hinzufügen).

    The name of the secret is listed on the Dependabot secrets page. You can click Update to change the secret value. You can click Remove to delete the secret.

    Update or remove a repository secret

Adding an organization secret for Dependabot

Beim Erstellen eines geheimen Schlüssels in einer Organisation können Sie eine Richtlinie verwenden, um einzuschränken, welche Repositorys auf diesen geheimen Schlüssel zugreifen können. Sie können z. B. Zugriff auf alle Repositorys gewähren oder den Zugriff auf nur private Repositorys oder eine angegebene Liste von Repositorys beschränken.

Um Geheimnisse auf Organisationsebene zu erstellen, musst Du admin-Zugriff haben.

  1. Navigiere auf GitHub zur Hauptseite der Organisation.

  2. Klicke unter Deinem Organisationsnamen auf Settings (Einstellungen). Schaltfläche „Organization settings" (Organsationseinstellungen)

  3. Klicken Sie auf der linken Seitenleiste auf Secrets (Geheimnisse).

  4. In the sidebar, click Dependabot. Dependabot secrets sidebar option

  5. Click New organization secret.

  6. Geben Sie einen Namen für Ihr Geheimnis in das Eingabefeld Name ein.

  7. Geben Sie den Value für Ihr Geheimnis ein.

  8. Wählen Sie im Repository-Zugriff Dropdownliste eine Zugriffsrichtlinie aus.

  9. If you chose Selected repositories:

    • Click .
    • Choose the repositories that can access this secret. Select repositories for this secret
    • Click Update selection.
  10. Klicken Sie auf Add secret (Geheimnis hinzufügen).

    The name of the secret is listed on the Dependabot secrets page. You can click Update to change the secret value or its access policy. You can click Remove to delete the secret.

    Update or remove an organization secret

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Oder, learn how to contribute.