Fix Default Branch Issue on GitOps Comment Event in Github #1918
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
Issue: when a user uses GitOps comment on pushed commit in Github, Head and Base branch is set as `main` in hardcoded string and considered default branch here but default could differ by repos like it could be `master` or `trunk` as well. Fix: use Event.Repository.DefaultBranch field for Head and Base branch value in this case. Signed-off-by: Zaki Shaikh <[email protected]>
|
heu good catch, which commit implemented that? |
chmouel
reviewed
Feb 6, 2025
| @@ -48,7 +48,7 @@ var sampleRepo = &github.Repository{ | |||
| Login: github.Ptr("owner"), | |||
| }, | |||
| Name: github.Ptr("reponame"), | |||
| DefaultBranch: github.Ptr("defaultbranch"), | |||
| DefaultBranch: github.Ptr("main"), | |||
There was a problem hiding this comment.
i think there is no test for that right ? ie it doesn't check if the user has set something else than main on their repo and that we are actuallyusing it ?
There was a problem hiding this comment.
yes seems same to mee, that it wasn't used that's why this bug is ignored
There was a problem hiding this comment.
@chmouel there are already tests for commit comment and branch matches, but the issue was DefaultBranch value of repo wasn't used in test due to hardcoded "main".
|
|
/lgtm |
![pipelines-as-code[bot]](https://avatars.githubusercontent.com/in/112592?s=60&v=4){kind=small}
There was a problem hiding this comment.
✅ Pull Request Approved
Approval Status:
- Required Approvals: 1
- Current Approvals: 1
👥 Approved By:
| Reviewer | Permission | Status |
|---|---|---|
| @chmouel | admin |
✅ |
📝 Next Steps
- All required checks must pass
- Branch protection rules apply
- Get a maintainer to use the
/mergecommand to merge the PR
Thank you for your contributions! 🎉
|
/rebase |
|
/merge |
pipelines-as-code
bot
merged commit 04127aa
into
openshift-pipelines:main
3 of 5 checks passed
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.
Issue: when a user uses GitOps comment on pushed commit in Github, Head and Base branch is set as
mainin hardcoded string and considered default branch here but default could differ by repos like it could bemasterortrunkas well.Fix: use Event.Repository.DefaultBranch field for Head and Base branch value in this case.
Changes
Submitter Checklist
📝 Ensure your commit message is clear and informative. Refer to the How to write a git commit message guide. Include the commit message in the PR body rather than linking to an external site (e.g., Jira ticket).
♽ Run make test lint before submitting a PR to avoid unnecessary CI processing. Consider installing pre-commit and running pre-commit install in the repository root for an efficient workflow.
✨ We use linters to maintain clean and consistent code. Run make lint before submitting a PR. Some linters offer a --fix mode, executable with make fix-linters (ensure markdownlint and golangci-lint are installed).
📖 Document any user-facing features or changes in behavior.
🧪 While 100% coverage isn't required, we encourage unit tests for code changes where possible.
🎁 If feasible, add an end-to-end test. See README for details.
🔎 Address any CI test flakiness before merging, or provide a valid reason to bypass it (e.g., token rate limitations).
If adding a provider feature, fill in the following details:
(update the documentation accordingly)