Skip to content

Commit

Permalink
fix: dependabot commit config (#34149)
Browse files Browse the repository at this point in the history
Co-authored-by: Jan Brasna <[email protected]>
Co-authored-by: mc <[email protected]>
  • Loading branch information
3 people authored Aug 1, 2024
1 parent ce536c2 commit 9587764
Showing 1 changed file with 3 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -304,8 +304,8 @@ Use the `allow` option to customize which dependencies are updated. This applies
| `direct` | All | All explicitly defined dependencies. |
| `indirect` | `bundler`, `pip`, `composer`, `cargo`{% ifversion dependabot-updates-gomod-indirect %}, `gomod`{% endif %} | Dependencies of direct dependencies (also known as sub-dependencies, or transient dependencies).|
| `all` | All | All explicitly defined dependencies. For `bundler`, `pip`, `composer`, `cargo`,{% ifversion dependabot-updates-gomod-indirect %} `gomod`,{% endif %} also the dependencies of direct dependencies.|
| `production` | `bundler`, `composer`, `mix`, `maven`, `npm`, `pip` | Only dependencies in the "Production dependency group". |
| `development`| `bundler`, `composer`, `mix`, `maven`, `npm`, `pip` | Only dependencies in the "Development dependency group". |
| `production` | `bundler`, `composer`, `mix`, `maven`, `npm`, `pip` (not all managers) | Only dependencies in the "Production dependency group". |
| `development`| `bundler`, `composer`, `mix`, `maven`, `npm`, `pip` (not all managers) | Only dependencies in the "Development dependency group". |

```yaml
# Use `allow` to specify which dependencies to maintain
Expand Down Expand Up @@ -381,7 +381,7 @@ Supported options
The code snippet below provides examples of both in the same configuration file.

* `prefix-development` specifies a separate prefix for all commit messages that update dependencies in the Development dependency group. When you specify a value for this option, the `prefix` is used only for updates to dependencies in the Production dependency group. This is supported by: `bundler`, `composer`, `mix`, `maven`, `npm`, and `pip`.
* `include: "scope"` specifies that any prefix is followed by a list of the dependencies updated in the commit.
* `include: "scope"` specifies that any prefix is followed by the type of the dependencies (`deps` or `deps-dev`) updated in the commit.

{% data reusables.dependabot.option-affects-security-updates %}

Expand Down Expand Up @@ -425,7 +425,6 @@ updates:
commit-message:
prefix: "pip prod"
prefix-development: "pip dev"
include: "scope"
```

If you use the same configuration as in the example above, bumping the `requests` library in the `pip` development dependency group will generate a commit message of:
Expand Down

0 comments on commit 9587764

Please sign in to comment.