fix: update readme about dependabot labels #78
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]>
There was a problem hiding this comment.
Pull Request Overview
Updates Dependabot configuration to prevent conflicts with automated release workflows by customizing the labels applied to dependency update PRs.
- Adds custom labels configuration to Dependabot to avoid using semantic versioning labels (
major,minor,patch) that interfere with release automation - Documents the issue and solution in README with a caution notice for other users
- Provides example configuration in the repository's own
dependabot.yamlfile
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds documentation explaining Dependabot label conflicts and the solution |
| .github/dependabot.yaml | Implements custom labels configuration to prevent release conflicts |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on Dependabot docs we can specify the labels applied. Previously Dependabot was applying
major,minor', orpatchlabels 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) anddependencies`, in case we ever need to filter in the UI.Updated README with a CAUTION flag about this.