Skip to main content

Enabling Dependabot for your enterprise

You can allow users of sua instância do GitHub Enterprise Server to find and fix vulnerabilities in code dependencies by setting up Dependabot alerts and Dependabot updates.

Quem pode usar esse recurso?

Enterprise owners can set up Dependabot.

About Dependabot for GitHub Enterprise Server

Dependabot helps users of sua instância do GitHub Enterprise Server find and fix vulnerabilities in their dependencies. You must first set up Dependabot for your enterprise, and then you can enable Dependabot alerts to notify users about vulnerable dependencies and Dependabot updates to fix the vulnerabilities and keep dependencies updated to the latest version.

Dependabot is just one of many features available to harden supply chain security for sua instância do GitHub Enterprise Server. For more information about the other features, see "About supply chain security for your enterprise."

About Dependabot alerts

With Dependabot alerts, GitHub identifies insecure dependencies in repositories and creates alerts on sua instância do GitHub Enterprise Server, using data from the GitHub Advisory Database and the dependency graph service.

Adicionamos comunicados ao GitHub Advisory Database das seguintes fontes:

Se você conhecer outro banco de dados do qual devemos importar os avisos, conte-nos sobre ele abrindo um problema em https://github.com/github/advisory-database.

After you set up Dependabot for your enterprise, vulnerability data is synced from the GitHub Advisory Database to your instance once every hour. Only GitHub-reviewed advisories are synchronized. Para obter mais informações, confira "Como procurar avisos de segurança no GitHub Advisory Database".

You can also choose to manually sync vulnerability data at any time. For more information, see "Viewing the vulnerability data for your enterprise."

Note: When you enable Dependabot alerts, no code or information about code from sua instância do GitHub Enterprise Server is uploaded to GitHub.com.

When sua instância do GitHub Enterprise Server receives information about a vulnerability, it identifies repositories in sua instância do GitHub Enterprise Server that use the affected version of the dependency and generates Dependabot alerts. You can choose whether or not to notify users automatically about new Dependabot alerts.

For repositories with Dependabot alerts enabled, scanning is triggered on any push to the default branch that contains a manifest file or lock file. Additionally, when a new vulnerability record is added to sua instância do GitHub Enterprise Server, GitHub Enterprise Server scans all existing repositories on sua instância do GitHub Enterprise Server and generates alerts for any repository that is vulnerable. For more information, see "Sobre alertas do Dependabot."

About Dependabot updates

After you enable Dependabot alerts, you can choose to enable Dependabot updates. When Dependabot updates are enabled for sua instância do GitHub Enterprise Server, users can configure repositories so that their dependencies are updated and kept secure automatically.

Note: Dependabot updates on GitHub Enterprise Server requires GitHub Actions with self-hosted runners.

By default, GitHub Actions runners used by Dependabot need access to the internet, to download updated packages from upstream package managers. For Dependabot updates powered by GitHub Connect, internet access provides your runners with a token that allows access to dependencies and advisories hosted on GitHub.com.

You can enable Dependabot updates for specific private registries on GitHub Enterprise Server instances with limited, or no, internet access. For more information, see "Configuring Dependabot to work with limited internet access."

With Dependabot updates, GitHub automatically creates pull requests to update dependencies in two ways.

Enabling Dependabot alerts

Before you can enable Dependabot alerts, you must first set up Dependabot for your enterprise:

  1. No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.

    Captura de tela do menu suspenso que aparece quando você clica na foto de perfil no GitHub Enterprise Server. A opção "Configurações da empresa" está realçada em um contorno laranja escuro.

  2. Na barra lateral da conta corporativa, clique em GitHub Connect .

  3. Under "Dependabot", to the right of "Periodically download the GitHub Advisory Database so that users can receive vulnerability alerts for open source code dependencies", select the dropdown menu and click Enabled without notifications. Optionally, to enable alerts with notifications, click Enabled with notifications.

    Screenshot of the "Enable" dropdown menu for Dependabot alerts, showing the available options.

    Note

    This setting controls realtime email and web notifications only. Command line interface (CLI) warnings and email digests will still be delivered regardless of which option is selected.

    Tip

    We recommend configuring Dependabot alerts without notifications for the first few days to avoid an overload of realtime notifications. After a few days, you can enable notifications to receive Dependabot alerts as usual.

You can now enable Dependabot alerts for all existing or new private and internal repositories in the enterprise settings page for "Code security and analysis." Alternatively, repository administrators and organization owners can enable Dependabot alerts for each repository and organization. Public repositories are always enabled by default. For more information, see "Configurando alertas do Dependabot."

Enabling Dependabot updates

Before you can enable Dependabot updates:

Dependabot updates are not supported on GitHub Enterprise Server if your enterprise uses clustering.

Note: After you enable the dependency graph, you can use the Dependabot action. The action will raise an error if any vulnerabilities or invalid licenses are being introduced. Para obter mais informações sobre a ação e para obter instruções sobre como baixar a versão mais recente, confira "Using the latest version of the official bundled actions".

  1. Entre no sua instância do GitHub Enterprise Server em http(s)://HOSTNAME/login.

  2. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .

  3. Se você ainda não estiver na página "Administração do site", no canto superior esquerdo, clique em Administração do site.

  4. Na barra lateral " Administrador do site", clique em Console de Gerenciamento .

  5. Na barra lateral "Configurações", clique em Segurança.

  6. Under "Security", select Dependabot security updates.

  7. Na barra lateral "Configurações", clique em Salvar configurações.

    Observação: se você salvar as configurações no Console de Gerenciamento, isso reiniciará os serviços do sistema, o que poderá resultar em tempo de inatividade visível pelo usuário.

  8. Aguarde a conclusão da execução de suas configurações.

  9. Click Visit your instance.

  10. Configure dedicated self-hosted runners to create the pull requests that will update dependencies. This is required because the workflows use a specific runner label. For more information, see "Managing self-hosted runners for Dependabot updates on your enterprise."

  11. No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.

    Captura de tela do menu suspenso que aparece quando você clica na foto de perfil no GitHub Enterprise Server. A opção "Configurações da empresa" está realçada em um contorno laranja escuro.

  12. Na barra lateral da conta corporativa, clique em GitHub Connect .

  13. Under "Dependabot", to the right of "Users can easily upgrade to non-vulnerable open source code dependencies", click Enable.

When you enable Dependabot alerts, you should consider also setting up GitHub Actions for Dependabot security updates. This feature allows developers to fix vulnerabilities in their dependencies. For more information, see "Managing self-hosted runners for Dependabot updates on your enterprise."

If you need enhanced security, we recommend configuring Dependabot to use private registries. For more information, see "Configurando o acesso a registros privados para Dependabot."