Add sanitization to BranchNamer::DependencyGroupStrategy#7452
Merged
brrygrdn merged 3 commits intodependabot:mainfrom Jun 21, 2023
Merged
Conversation
b81d419 to
ed307b5
Compare
brrygrdn
approved these changes
Jun 21, 2023
Contributor
brrygrdn
left a comment
There was a problem hiding this comment.
Thanks for this, this looks good to me!
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
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.
Summary
This MR adds sanitisation support to the
BranchNamer::DependencyGroupStrategy. It addresses this fixme:dependabot-core/common/lib/dependabot/pull_request_creator/branch_namer/dependency_group_strategy.rb
Line 18 in 0193c77
History
max_lengthoption was added to the (at the time) single branch namer: Add max length option to BranchNamer #5338 so users with restrictive branch names (e.g. sometimes found on Gitlab) could limit branch name lengthmax_lengthparameterReasoning
max_lengthparameter (e.g. throughdependabot-gitlabwhich is built ondependabot-common)seperatorcommand)DependencyGroupStrategy, special care is taken that dependency order and time yields a consistent name. As hashing a consistent string also yields a consistent string, it is safe to reuse the sanitization strategy from theSoloStrategy.To address those, I created a common superclass (
BranchNamer::Base) with some basic sanitization methods (at the moment, moved from theSoloStrategy).