Anpassen von Auto-Triage-Regeln zum Priorisieren von Dependabot-Warnungen

About custom auto-triage rules

You can create your own Dependabot auto-triage rules based on alert metadata. You can choose to auto-dismiss alerts indefinitely, or snooze alerts until a patch becomes available, and you can specify which alerts you want Dependabot to open pull requests for.

Since any rules that you create apply to both future and current alerts, you can also use auto-triage rules to manage your Dependabot alerts in bulk.

Repository administrators can create custom auto-triage rules for their public repositories.

Organization owners and security managers can set custom auto-triage rules at the organization-level, and then choose if a rule is enforced or enabled across all public repositories in the organization.

• Enforced: If an organization-level rule is "enforced", repository administrators cannot edit, disable, or delete the rule.
• Enabled: If an organization-level rule is "enabled", repository administrators can still disable the rule for their repository.

You can create rules to target alerts using the following metadata:

• CVE ID
• CWE
• Dependency scope (devDependency or runtime)
• Ecosystem
• GHSA ID
• Manifest path (for repository-level rules only)
• Package name
• Patch availability
• Severity

Understanding how custom auto-triage rules and Dependabot security updates interact

You can use custom auto-triage rules to tailor which alerts you want Dependabot to open pull requests for. However, for an "open a pull request" rule to take effect, you must ensure that Dependabot security updates are disabled for the repository (or repositories) that the rule should apply to.

When Dependabot security updates are enabled for a repository, Dependabot will automatically try to open pull requests to resolve every open Dependabot alert that has an available patch. If you prefer to customize this behavior using a rule, you must leave Dependabot security updates disabled.

For more information about enabling or disabling Dependabot security updates for a repository, see "Configuring Dependabot security updates."

Adding custom auto-triage rules to your repository

1. On GitHub.com, navigate to the main page of the repository.

2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

   

3. In the "Security" section of the sidebar, click Code security and analysis.

4. Under "Dependabot alerts", click close to "Dependabot rules".

5. Click New rule.

6. Under "Rule name", describe what this rule will do.

7. Under "State", use the dropdown menu to select whether the rule should be enabled or disabled for the repository.

8. Under "Target alerts", select the metadata you want to use to filter alerts.

9. Under "Rules", select the action you want to take on alerts that match the metadata:

   • Select Dismiss alerts to auto-dismiss alerts that match the metadata. You can choose to dismiss alerts indefinitely or until a patch is available.
   • Select Open a pull request to resolve this alert if you want Dependabot to suggest changes to resolve alerts that match the targeted metadata. Note that this option is unavailable if you have already selected the option to dismiss alerts indefinitely, or if Dependabot security updates are enabled in your repository settings.

10. Click Create rule.

Adding custom auto-triage rules to your organization

1. In the upper-right corner of GitHub.com, select your profile photo, then click Your organizations.

   

2. Next to the organization, click Settings.

3. In the "Security" section of the sidebar, click Code security and analysis.

   Note

   If your organization is enrolled in the security configurations and global settings public beta, instead of "Code security and analysis", you will see a "Code security" dropdown menu. Select Code security, then click Global settings. For next steps on adding Dependabot auto-triage rules to your organization with global settings, see "Configuring global security settings for your organization."

4. Under "Dependabot", then under "Dependabot alerts", click close to "Dependabot rules".

5. Click New rule.

6. Under "Rule name", describe what this rule will do.

7. Under "State", use the dropdown menu to choose how you want to apply the rule.

   • Choose Enforced to prevent repository administrators from being able to edit, disable, or delete the rule in the repository's settings page.
   • Choose Enabled to set the rule on-by-default for all repositories, while also allowing repository administrators to disable the rule in the repository's settings page.
   • Alternatively, you can choose to set the rule as Disabled, which cannot be overridden at the repository level. Disabled rules are hidden for all repositories.

8. Under "Target alerts", select the metadata you want to use to filter alerts.

9. Under "Rules", select the action you want to take on alerts that match the metadata:

   • Select Dismiss alerts to auto-dismiss alerts that match the metadata. You can choose to dismiss alerts indefinitely, or until a patch is available.
   • Select Open a pull request to resolve this alert if you want Dependabot to suggest changes to resolve alerts that match the metadata. Note that this option is unavailable if you have selected the option to dismiss the alerts indefinitely.

10. Click Create rule.

Editing or deleting custom auto-triage rules for your repository

1. On GitHub.com, navigate to the main page of the repository.

2. Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.

   

3. In the "Security" section of the sidebar, click Code security and analysis.

4. Under "Dependabot alerts", click close to "Dependabot rules".

5. Under "Repository rules", to the right of the rule that you want to edit or delete, click .

6. To edit the rule, make any changes to the applicable fields, then click Save rule.

7. To delete the rule, under "Danger Zone", click Delete rule.

8. In the "Are you sure you want to delete this rule?" dialog box, review the information, then click Delete rule.

Editing or deleting custom auto-triage rules for your organization

1. In the upper-right corner of GitHub.com, select your profile photo, then click Your organizations.

   

2. Next to the organization, click Settings.

3. In the "Security" section of the sidebar, click Code security and analysis.

   Note

   If your organization is enrolled in the security configurations and global settings public beta, instead of "Code security and analysis", you will see a "Code security" dropdown menu. Select Code security, then click Global settings. For next steps on editing or deleting Dependabot auto-triage rules in your organization with global settings, see "Configuring global security settings for your organization."

4. Under "Dependabot", then under "Dependabot alerts", click close to "Dependabot rules".

5. Under "Organization rules", to the right of the rule that you want to edit or delete, click .

6. To edit the rule, make any changes to the applicable fields, then click Save rule.

7. To delete the rule, under "Danger Zone", click Delete rule.

8. In the "Are you sure you want to delete this rule?" dialog box, review the information, then click Delete rule.