Skip to content

fix(github): Fix issue with users not getting picked up in GitHub config #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 5, 2025

Conversation

brendan-kellam
Copy link
Contributor

@brendan-kellam brendan-kellam commented Aug 4, 2025

Problem

Consider the following config:

{
    "$schema": "./schemas/v3/index.json",
    "connections": {
        "sourcebot": {
            "type": "github",
            "users": [
                "brendan-kellam",
                "torvalds"
            ],
            "token": {
                "env": "GITHUB_SB_TOKEN"
            }
        }
    }
}

Assume GITHUB_SB_TOKEN was scoped to my (brendan-kellam) user. We would expect to get all public & private repos from brendan-kellam, and all public repos from torvalds. In actuality, we were just getting the repos for brendan-kellam.

Why? We were using listForAuthenticatedUser when a token is specified, which only lists the repositories for the currently authenticated user (brendan-kellam), even when a username is specified. So, when we called this for torvalds, we were actually getting repos for brendan-kellam.

Solution

This discussion recommended using the search/repositories endpoint, so I switched to that.

Summary by CodeRabbit

  • Bug Fixes
    • Resolved an issue where users specified in GitHub configuration were not recognized when a token was provided.
  • Documentation
    • Updated changelog to include details of the fix.

Copy link

coderabbitai bot commented Aug 4, 2025

Walkthrough

A changelog entry was added to document a fix for recognizing users in GitHub configurations when a token is provided. In the backend GitHub integration, the getReposOwnedByUsers function was refactored to use the GitHub search API for repository discovery, removing the isAuthenticated parameter and simplifying the logic.

Changes

Cohort / File(s) Change Summary
Changelog Update
CHANGELOG.md
Added an unreleased fix entry for handling users with a token in GitHub config, referencing PR #428.
Backend GitHub Integration Refactor
packages/backend/src/github.ts
Refactored getReposOwnedByUsers: removed isAuthenticated parameter and conditional logic, now uses search API for repo discovery.

Sequence Diagram(s)

sequenceDiagram
    participant ConfigLoader
    participant BackendGithub
    participant GitHubAPI

    ConfigLoader->>BackendGithub: getGitHubReposFromConfig(users, token)
    BackendGithub->>GitHubAPI: search.repos (query by user, paginated)
    GitHubAPI-->>BackendGithub: List of repositories
    BackendGithub-->>ConfigLoader: Aggregated repository results
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐇
In the changelog, a fix now appears,
For tokens and users, let's give three cheers!
The backend hops with a streamlined call,
No more branching logic—just one API for all.
With every repo found,
This bunny leaps around,
Happy code and carrots abound!
🥕

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f40391e and 3d1cd1c.

📒 Files selected for processing (1)
  • CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • CHANGELOG.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bkellam/fix_github_user_sync

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@brendan-kellam brendan-kellam self-assigned this Aug 4, 2025
@brendan-kellam brendan-kellam requested a review from msukkari August 4, 2025 22:40
@brendan-kellam brendan-kellam marked this pull request as ready for review August 4, 2025 22:40
@brendan-kellam brendan-kellam merged commit 01dee16 into main Aug 5, 2025
6 checks passed
@brendan-kellam brendan-kellam deleted the bkellam/fix_github_user_sync branch August 5, 2025 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants