Skip to content

Commit 3923970

Browse files
authored
repo sync
2 parents b111207 + c4914d7 commit 3923970

10 files changed

Lines changed: 64 additions & 42 deletions
86.8 KB
Loading
85.1 KB
Loading

content/github/administering-a-repository/about-dependabot-version-updates.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ If you've enabled security updates, you'll sometimes see extra pull requests for
3333

3434
### Supported repositories and ecosystems
3535

36+
You can configure version updates for repositories that contain a dependency manifest or lock file for one of the supported package managers. For some package managers, you can also configure vendoring for dependencies. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#vendor)."
37+
3638
{% note %}
3739

38-
{% data reusables.dependabot.private-dependencies %}
40+
{% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. See the details in the table below.
3941

4042
{% endnote %}
4143

42-
You can configure version updates for repositories that contain a dependency manifest or lock file for one of the supported package managers. For some package managers, you can also configure vendoring for dependencies. For more information, see "[Configuration options for dependency updates](/github/administering-a-repository/configuration-options-for-dependency-updates#vendor)."
43-
4444
{% data reusables.dependabot.supported-package-managers %}
4545

4646
If your repository already uses an integration for dependency management, you will need to disable this before enabling {% data variables.product.prodname_dependabot %}. For more information, see "[About integrations](/github/customizing-your-github-workflow/about-integrations)."

content/github/administering-a-repository/configuration-options-for-dependency-updates.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,8 @@ updates:
308308
309309
{% note %}
310310
311-
**Note**: {% data variables.product.prodname_dependabot_version_updates %} can't run version updates for any dependencies in manifests containing private git dependencies or private git registries, even if you add the private dependencies to the `ignore` option of your configuration file. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot#supported-repositories-and-ecosystems)."
311+
**Note**: {% data variables.product.prodname_dependabot %} can only run version updates on manifest or lock files if it can access all of the dependencies in the file, even if you add inaccessible dependencies to the `ignore` option of your configuration file. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-repositories)" and "[Troubleshooting {% data variables.product.prodname_dependabot %} errors](/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors#dependabot-cant-resolve-your-dependency-files)."
312+
312313

313314
{% endnote %}
314315

content/github/administering-a-repository/enabling-and-disabling-version-updates.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,9 @@ You enable {% data variables.product.prodname_dependabot_version_updates %} by c
1414

1515
{% data reusables.dependabot.initial-updates %} For more information, see "[Customizing dependency updates](/github/administering-a-repository/customizing-dependency-updates)."
1616

17-
### Enabling {% data variables.product.prodname_dependabot_version_updates %}
18-
19-
{% note %}
17+
{% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. For more information, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates#supported-repositories-and-ecosystems)."
2018

21-
{% data reusables.dependabot.private-dependencies %}
22-
23-
{% endnote %}
19+
### Enabling {% data variables.product.prodname_dependabot_version_updates %}
2420

2521
{% data reusables.dependabot.create-dependabot-yml %}
2622
1. Use `package-ecosystem` to specify the package managers to monitor.

content/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ versions:
1212
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% else %}When {% data variables.product.product_name %} detects vulnerable dependencies in your repositories, it sends security alerts.{% endif %}{% if currentVersion == "free-pro-team@latest" %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability.
1313
{% endif %}
1414

15-
{% if currentVersion == "free-pro-team@latest" %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-features-for-new-repositories)."
15+
{% if currentVersion == "free-pro-team@latest" %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether the detection of vulnerable dependencies will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)."
1616
{% endif %}
1717

1818
{% if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@2.21" %}

content/github/managing-security-vulnerabilities/troubleshooting-dependabot-errors.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,12 @@ There are separate limits for security and version update pull requests, so that
7676

7777
The best way to resolve this error is to merge or close some of the existing pull requests and trigger a new pull request manually. For more information, see "[Triggering a {% data variables.product.prodname_dependabot %} pull request manually](#triggering-a-dependabot-pull-request-manually)."
7878

79+
#### {% data variables.product.prodname_dependabot %} can't resolve your dependency files
80+
81+
**Version updates only.** If {% data variables.product.prodname_dependabot %} attempts to check whether dependency references need to be updated in a repository, but can't access one or more of the referenced files, you will see the error message "{% data variables.product.prodname_dependabot %} can't resolve your LANGUAGE dependency files".
82+
83+
{% data reusables.dependabot.private-dependencies-note %} Additionally, {% data variables.product.prodname_dependabot %} doesn't support private {% data variables.product.prodname_dotcom %} dependencies for all package managers. For more information, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates#supported-repositories-and-ecosystems)."
84+
7985
### Triggering a {% data variables.product.prodname_dependabot %} pull request manually
8086

8187
If you unblock {% data variables.product.prodname_dependabot %}, you can manually trigger a fresh attempt to create a pull request.

content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,47 @@ versions:
99
### About management of security and analysis settings
1010

1111
{% data variables.product.prodname_dotcom %} can help secure the repositories in your organization. You can manage the security and analysis features for all existing or new repositories that members create in your organization.
12-
1312
{% data reusables.security.some-security-and-analysis-features-are-enabled-by-default %}
13+
{% data reusables.security.security-and-analysis-features-enable-read-only %}
1414

15-
{% if currentVersion == "free-pro-team@latest" %}{% data reusables.security.security-and-analysis-features-enable-read-only %}
16-
{% endif %}
17-
18-
### Enabling or disabling features for existing repositories
15+
### Displaying the security and analysis settings
1916

2017
{% data reusables.profile.access_profile %}
2118
{% data reusables.profile.access_org %}
2219
{% data reusables.organizations.org_settings %}
2320
{% data reusables.organizations.security-and-analysis %}
24-
5. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**.
21+
22+
The page that's displayed allows you to enable or disable security and analysis features for the repositories in your organization.
23+
24+
### Enabling or disabling a feature for all existing repositories
25+
26+
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
27+
1. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**.
2528
!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/organizations/security-and-analysis-disable-or-enable-all.png)
26-
6. Optionally, enable the feature by default for new repositories in your organization.
29+
1. Optionally, enable the feature by default for new repositories in your organization.
2730
!["Enable by default" option for new repositories](/assets/images/help/organizations/security-and-analysis-enable-by-default-in-modal.png)
28-
7. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories in your organization.
31+
1. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories in your organization.
2932
![Button to disable or enable feature](/assets/images/help/organizations/security-and-analysis-enable-dependency-graph.png)
3033

31-
### Enabling or disabling features for new repositories
34+
### Enabling or disabling a feature for all new repositories when they are added
3235

33-
{% data reusables.profile.access_profile %}
34-
{% data reusables.profile.access_org %}
35-
{% data reusables.organizations.org_settings %}
36-
{% data reusables.organizations.security-and-analysis %}
37-
5. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories in your organization.
36+
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
37+
1. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories in your organization.
3838
![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox.png)
3939

40+
### Allowing Dependabot to access private repositories
41+
42+
{% data variables.product.prodname_dependabot %} can check for outdated dependency references in a project and automatically generate a pull request to update them. To do this, {% data variables.product.prodname_dependabot %} must have access to the targeted dependency files. By default, {% data variables.product.prodname_dependabot %} can't update dependencies that are located in private repositories. However, if a dependency is in a private {% data variables.product.prodname_dotcom %} repository within the same organization as the project that uses that dependency, you can allow {% data variables.product.prodname_dependabot %} to update the version successfully by giving it access to the host repository. For more information, including details of limitations to private dependency support, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates)."
43+
44+
1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
45+
1. In the "{% data variables.product.prodname_dependabot %} repository access" section, click the settings button **{% octicon "gear" aria-label="The Gear icon" %}**.
46+
![Repository access setting button](/assets/images/help/organizations/repository-access-cog-button.png)
47+
A list is displayed showing all of the private repositories in your organization.
48+
![The Repositories list](/assets/images/help/organizations/repositories-dialog.png)
49+
1. Select the repositories that {% data variables.product.prodname_dependabot %} can access.
50+
1. Click **Select repositories**.
51+
52+
4053
### Further reading
4154

4255
{% if currentVersion == "free-pro-team@latest" %}- "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)"
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
When running version updates, {% data variables.product.prodname_dependabot %} must be able to resolve all dependencies from their source to verify that version updates have been successful. If your manifest or lock files contain any dependencies hosted in private {% data variables.product.prodname_dotcom %} repositories within your organization, {% data variables.product.prodname_dependabot %} must be able to access those repositories. Organization owners can configure this. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization#allowing-dependabot-to-access-private-repositories)."
2+
3+
Currently, {% data variables.product.prodname_dependabot %} version updates doesn't support manifest or lock files that contain any dependencies hosted in private registries, or in private {% data variables.product.prodname_dotcom %} repositories that belong to a different organization than the dependent project.

data/reusables/dependabot/supported-package-managers.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1-
Package manager | Supports vendoring
2-
--- | :---:
3-
Bundler: `bundler` | **X**
4-
Cargo: `cargo` |
5-
Composer: `composer` |
6-
Docker: `docker` |
7-
Elm: `elm` |
8-
git submodule: `gitsubmodule` |
9-
GitHub Actions: `github-actions` |
10-
Go modules: `gomod` | **X**
11-
Gradle: `gradle` |
12-
Maven: `maven` |
13-
Mix: `mix` |
14-
npm: `npm` |
15-
NuGet: `nuget` |
16-
pip: `pip` |
17-
Terraform: `terraform` |
1+
The following table shows, for each package manager, whether {% data variables.product.prodname_dependabot %} supports: dependencies in private {% data variables.product.prodname_dotcom %} repositories, and vendored dependencies.
2+
3+
Package manager | Private {% data variables.product.prodname_dotcom %} repositories | Vendoring
4+
--- | :---:| :---:
5+
Bundler: `bundler` | | **** |
6+
Cargo: `cargo` | **** | |
7+
Composer: `composer` | **** | |
8+
Docker: `docker` | **** | |
9+
Elixir: `hex` | | |
10+
Elm: `elm` | **** | |
11+
git submodule: `gitsubmodule` | **** | |
12+
GitHub Actions: `github-actions` | **** | |
13+
Go modules: `gomod` | **** | **** |
14+
Gradle: `gradle` | **** | |
15+
Maven: `maven` | **** | |
16+
Mix: `mix` | **** | |
17+
npm: `npm` | **** | |
18+
NuGet: `nuget` | **** | |
19+
pip: `pip` | | |
20+
Terraform: `terraform` | **** | |
1821

1922
{% note %}
2023

0 commit comments

Comments
 (0)