Skip to content

Commit d525abe

Browse files
committed
fix: update readme about dependabot labels
Based on [Dependabot docs](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#labels--) we can specify the labels applied. Previously Dependabot was applying `major`, `minor', or `patch` labels based on the version of dependency updates. This was causing conflicts with our auto releasing. If those labels were present they were being applied to our releases. This is not what we want. We are changing the Dependabot config to just note the package type (i.e., go, github_actions, etc) and `dependencies`, in case we ever need to filter in the UI. Updated README with a CAUTION flag about this. Signed-off-by: jmeridth <[email protected]>
1 parent 2d87847 commit d525abe

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

.github/dependabot.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ updates:
77
timezone: 'America/Chicago'
88
commit-message:
99
prefix: "chore(deps)"
10+
labels: ["github_actions", "dependencies"]
1011
groups:
1112
dependencies:
1213
applies-to: version-updates

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ This is a placeholder repo for multiple GitHub Actions we use in open source pro
1818
>
1919
> [Workflows](.github/workflows)
2020
21+
> [!CAUTION]
22+
> In our default `release-drafter.yaml` file and hardcoded in our `release.yaml` reusable workflow, we use the labels `major`, `minor`, and `patch` to determine the type of release to create. Unfortunately, Dependabot uses these same labels, by default, on its PRs to indicate the type of version update. This can cause unintended releases to be created when Dependabot PRs are merged.
23+
> The "fix" is to include `labels: ["package-name", "dependencies"]` in your `dependabot.yaml` configuration file to ensure Dependabot PRs are labeled correctly and do not use the `major`, `minor`, or `patch` labels.
24+
> You can see an example of this in the [dependabot.yaml](.github/dependabot.yaml) file in this repository.
25+
2126
> [!TIP]
2227
> You can reuse the following files in this repository in your own as they are used by the reusable workflows:
2328
>

0 commit comments

Comments
 (0)