Skip to content

Commit a863bc4

Browse files
authored
Merge pull request #18184 from github/2764-dependabot-improvements
Dependabot docs improvements
2 parents 7e459b2 + 3ee7d92 commit a863bc4

File tree

6 files changed

+21
-0
lines changed

6 files changed

+21
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ When {% data variables.product.prodname_dependabot %} identifies an outdated dep
2222

2323
If you enable security updates, {% data variables.product.prodname_dependabot %} also raises pull requests to update vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)."
2424

25+
{% data reusables.dependabot.pull-request-security-vs-version-updates %}
26+
2527
{% data reusables.dependabot.dependabot-tos %}
2628

2729
### Frequency of {% data variables.product.prodname_dependabot %} pull requests

content/github/managing-security-vulnerabilities/about-dependabot-security-updates.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ The {% data variables.product.prodname_dependabot_security_updates %} feature is
2222

2323
{% endnote %}
2424

25+
You can enable a related feature, {% data variables.product.prodname_dependabot_version_updates %}, so that {% data variables.product.prodname_dependabot %} raises pull requests to update the manifest to the latest version of the dependency, whenever it detects an outdated dependency. For more information, see "[About {% data variables.product.prodname_dependabot %} version updates](/github/administering-a-repository/about-dependabot-version-updates)."
26+
27+
{% data reusables.dependabot.pull-request-security-vs-version-updates %}
28+
2529
### About pull requests for security updates
2630

2731
Each pull request contains everything you need to quickly and safely review and merge a proposed fix into your project. This includes information about the vulnerability like release notes, changelog entries, and commit details. Details of which vulnerability a pull request resolves are hidden from anyone who does not have access to {% data variables.product.prodname_dependabot_alerts %} for the repository.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ You can enable or disable features for all repositories. {% if currentVersion ==
7676
![Button to enable feature for all the eligible repositories in the organization](/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png)
7777
{% endif %}
7878

79+
{% data reusables.security.displayed-information %}
80+
7981
### Enabling or disabling a feature automatically when new repositories are added
8082

8183
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)."

content/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ For an overview of repository-level security, see "[About securing your reposito
2828
7. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories you own.
2929
![Button to disable or enable feature](/assets/images/help/settings/security-and-analysis-enable-dependency-graph.png)
3030

31+
{% data reusables.security.displayed-information %}
32+
3133
### Enabling or disabling features for new repositories
3234

3335
{% data reusables.user_settings.access_settings %}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
When {% data variables.product.prodname_dependabot %} raises pull requests, these pull requests could be for _security_ or _version_ updates:
2+
3+
- {% data variables.product.prodname_dependabot_security_updates %} are automated pull requests that help you update dependencies with known vulnerabilities.
4+
- {% data variables.product.prodname_dependabot_version_updates %} are automated pull requests that keep your dependencies updated, even when they don’t have any vulnerabilities. To check the status of version updates, navigate to the Insights tab of your repository, then Dependency Graph, and {% data variables.product.prodname_dependabot %}.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
When you enable one or more security and analysis features for existing repositories, you will see any results displayed on {% data variables.product.prodname_dotcom %} within minutes:
2+
3+
- All the existing repositories will have the selected configuration.
4+
- New repositories will follow the selected configuration if you've enabled the checkbox for new repositories.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
5+
- We use the permissions to scan for manifest files to apply the relevant services.
6+
- You'll see information on your dependency graph.
7+
- {% data variables.product.prodname_dotcom %} will generate {% data variables.product.prodname_dependabot_alerts %}{% endif %}{% if currentVersion == "free-pro-team@latest" %} and raise pull requests{% endif %}.

0 commit comments

Comments
 (0)