Skip to main content

require-dependabot-commit-message-include-scope

Rule catalog ID: R089

Targeted pattern scopeโ€‹

Dependabot commit-message configuration, including values inherited from multi-ecosystem-groups.

What this rule reportsโ€‹

This rule reports update entries that do not resolve to commit-message.include: "scope".

Why this rule existsโ€‹

Including scope in Dependabot commit messages makes pull request titles more informative by distinguishing production and development dependency updates. That extra context is useful for triage and automation.

โŒ Incorrectโ€‹

version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
commit-message:
prefix: "deps"

โœ… Correctโ€‹

version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
commit-message:
prefix: "deps"
include: "scope"

Additional examplesโ€‹

This rule is especially helpful when grouped updates would otherwise produce similar-looking pull request titles across dependency classes.

ESLint flat config exampleโ€‹

import githubActions from "eslint-plugin-github-actions-2";

export default [githubActions.configs.dependabot];

When not to use itโ€‹

Disable this rule if the repository intentionally prefers shorter Dependabot titles without dependency scope markers.

Further readingโ€‹