feat: Allow to customize temporary working branch created by Updatecli - #5589
Merged
olblak merged 8 commits intoJul 13, 2025
Merged
feat: Allow to customize temporary working branch created by Updatecli#5589olblak merged 8 commits into
olblak merged 8 commits into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for customizing the prefix and separator used when Updatecli creates temporary working branches. Key changes include:
- Introduce workingBranchPrefix and workingBranchSeparator parameters in SCM plugin specs and propagate them through each provider implementation.
- Update the branch sanitization logic to trim leading separators and adjust replacement behavior.
- Add an example to the Venom integration test configuration showing how to set the new parameters.
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file| File | Description |
|---|---|
| updatecli/updatecli.d/venom.yaml | Example test updated with workingbranchprefix and workingbranchseparator |
| pkg/plugins/utils/gitgeneric/main.go | Trim leading separators and adjust replacement array |
| pkg/plugins/scms/stash/scm.go | Use strings.Join with custom prefix/separator in GetBranches |
| pkg/plugins/scms/stash/main.go | Add WorkingBranchPrefix/Separator fields and initialization |
| pkg/plugins/scms/gitlab/scm.go | Use strings.Join with custom prefix/separator in GetBranches |
| pkg/plugins/scms/gitlab/main.go | Add WorkingBranchPrefix/Separator fields and initialization |
| pkg/plugins/scms/github/scm.go | Use strings.Join with custom prefix/separator in GetBranches |
| pkg/plugins/scms/github/main.go | Add WorkingBranchPrefix/Separator fields and initialization |
| pkg/plugins/scms/gitea/scm.go | Use strings.Join with custom prefix/separator in GetBranches |
| pkg/plugins/scms/gitea/main.go | Add WorkingBranchPrefix/Separator fields and initialization |
| pkg/plugins/scms/git/scm.go | Use strings.Join with custom prefix/separator in GetBranches |
| pkg/plugins/scms/git/main.go | Add WorkingBranchPrefix/Separator fields and initialization |
| pkg/plugins/scms/bitbucket/scm.go | Use strings.Join with custom prefix/separator in GetBranches |
| pkg/plugins/scms/bitbucket/main.go | Add WorkingBranchPrefix/Separator fields and initialization |
updatecli/updatecli.d/venom.yaml:38
- [nitpick] The change to the version filter pattern (<1) in the Venom test appears unrelated to branch customization. Consider removing or documenting it separately to keep the test focused.
pattern: "<1"
pkg/plugins/scms/bitbucket/main.go:193
- Typo in variable name workingBranchhPrefix (extra 'h'). Rename to workingBranchPrefix for clarity and consistency.
workingBranchhPrefix := "updatecli"
pkg/plugins/utils/gitgeneric/main.go:698
- There are no unit tests covering custom separator trimming. Add tests for SanitizeBranchName, especially cases with leading slashes and varied separators.
branch = strings.TrimPrefix(branch, "/")
Sorry, something went wrong.
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.
Fix #1399
Today temporary working branch looks like
updatecli_<the targeted branch>_<pipelineid>
This pullrequest allows to override the default separator from _ to whatever defined by the parameter workingbranchseparator
The prefix updatecli_ can also be replace by setting the parameter workingbranchprefix:
For example
scms: default: kind: github spec: branch: "{{ .scm.branch }}" email: "{{ .scm.email }}" owner: "{{ .scm.owner }}" repository: "{{ .scm.repository }}" token: '{{ requiredEnv "GITHUB_TOKEN" }}' user: "{{ .scm.user }}" username: '{{ requiredEnv "GITHUB_ACTOR" }}' workingbranchprefix: "deps" workingbranchseparator: '/' disabled: falseTest
Test manually
Additional Information
Checklist
Tradeoff
I see two risks here that are not Updatecli related.
Potential improvement