✨ Specific error message for branch protection permission failure.#4892
Closed
✨ Specific error message for branch protection permission failure.#4892
Conversation
kash2104
requested review from
raghavkaul and
spencerschrock
and removed request for
a team
dosubot
bot
added
the
size:XS
kash2104
temporarily deployed
to
integration-test
GitHub Actions
Inactive
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #4892 +/- ##
==========================================
+ Coverage 66.80% 69.69% +2.89%
==========================================
Files 230 251 +21
Lines 16602 15651 -951
==========================================
- Hits 11091 10908 -183
+ Misses 4808 3869 -939
- Partials 703 874 +171 🚀 New features to boost your workflow:
|
AdamKorcz
reviewed
Dec 26, 2025
clients/githubrepo/branches.go
Outdated
| queryData := new(branchData) | ||
| if err := handler.graphClient.Query(handler.ctx, queryData, vars); err != nil { | ||
| if strings.Contains(err.Error(), "resource not accessible by integration") { | ||
| return nil, sce.WithMessage(sce.ErrScorecardInternal, "Branch protection check failed. Need to use a PAT.") |
Contributor
There was a problem hiding this comment.
The message doesn't convey that the token doesn't have permissions. Would be great to make that clearer.
Contributor
Author
There was a problem hiding this comment.
@AdamKorcz Have made the message more clear.
kash2104
temporarily deployed
to
integration-test
GitHub Actions
Inactive
Signed-off-by: kash2104 <kparikh1104@gmail.com>
kash2104
temporarily deployed
to
integration-test
GitHub Actions
Inactive
Contributor
Author
|
@AdamKorcz Any more changes required? Would appreciate another review. |
Contributor
Author
|
@spencerschrock Would appreciate a review. |
AdamKorcz
approved these changes
Jan 6, 2026
spencerschrock
requested changes
Jan 8, 2026
Comment on lines
321
to
324
| // only report permission errors if no ruleset data | ||
| if len(handler.ruleSets) == 0 { | ||
| return nil, sce.WithMessage(sce.ErrScorecardInternal, classicBranchErrMsg) | ||
| } |
Member
There was a problem hiding this comment.
|
This pull request has been marked stale because it has been open for 10 days with no activity |
|
This pull request has been marked stale because it has been open for 10 days with no activity |
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
3 participants
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.
What kind of change does this PR introduce?
This PR introduces a code change to provide specific error message when branch protection rule fails due to the use of
default GITHUB_TOKENwhich doesn't have permission to view branch protection rules.(Is it a bug fix, feature, docs update, something else?)
feature
What is the current behavior?
When the CI fails because of branch protection rules, it shows generic error message which doesn't give the users an idea of what the actual underlying issue is.
What is the new behavior (if this is a feature change)?**
When error is shown, string matching is done based on which it shows error message specific to the failure of branch protection CI test.
Which issue(s) this PR fixes
Fixes #2946
Special notes for your reviewer
Here
strings.Contains()is case-sensitive so need to adjust the substring or the error message string accordingly.Does this PR introduce a user-facing change?
Yes
For user-facing changes, please add a concise, human-readable release note to
the
release-note(In particular, describe what changes users might need to make in their
application as a result of this pull request.)