GitHub
The GitHub app connects your GitHub organisation or account to Sprigr Team. Agents can browse repositories and directories, read files, compare commits, search code, list and create issues, comment and label, open, review, update and merge pull requests, read diffs, check runs and Actions results, create branches and commit files. It is built for development teams that want an agent to triage issues, summarise pull requests, or fetch the relevant source during a conversation.
Prerequisites
Section titled “Prerequisites”- A GitHub organisation or personal account with the repositories you want agents to use, and an organisation owner available to install the App.
- Admin or Owner role in your Sprigr Team organisation to install the app.
Installing and connecting
Section titled “Installing and connecting”-
Install the app
Sign in to team.sprigr.com, open Apps in the sidebar, find GitHub under Available, and install it. No secrets are requested. See Installing Apps.
-
Connect your organisation
Open the app’s settings page from Apps > Installed and click Connect GitHub, or ask your agent to connect GitHub. GitHub asks an organisation owner to pick the organisation and either all repositories or a selected list, then returns you to Sprigr. If your organisation already has the Sprigr GitHub App (GitHub shows Configure instead of Install), the agent gives you a link that authorises you once and links the existing installation; if you can access several installations, it lists them and you pick one.
-
Optionally narrow the scope
Under Configuration on the settings page, set Repository scope to one repository (
owner/repo) or one owner (org/*). Calls outside the scope are refused with “Access denied”. Leave it empty to allow every repository the installation can see. The Sprigr dev-fleet conventions switch is for Sprigr’s own engineering fleet and should stay off. -
Check the connection
Ask your agent “Which GitHub repositories can you see?” It reports the connected account, whether the installation covers all or selected repositories, and the repository list.
github_connection_statusgives the same without calling GitHub.
Available actions
Section titled “Available actions”The app exposes a single github tool that takes an action parameter. Actions take flat parameters such as owner, repo, path, branch and number; repo may be given as owner/repo.
| Action | Description |
|---|---|
list_repos | List repositories the installation can see, with the connected account and repository selection |
get_repo | Get details about a repository |
read_file | Read a file from a repository |
list_directory | List the entries in a directory |
create_or_update_file | Create or update a file with a commit |
create_branch | Create a branch |
list_branches | List branches |
list_commits | List recent commits on a branch |
compare_commits | Compare two commits, branches or tags |
search_code | Search code across accessible repositories |
list_issues | List issues with optional state, label and assignee filters |
get_issue | Get an issue |
list_issue_comments | List the comments on an issue |
get_issue_comment | Get one issue comment |
create_issue | Create an issue with a title, body and labels |
update_issue | Update an issue’s title, body, labels or state |
add_labels | Add labels to an issue or pull request |
remove_label | Remove a label |
add_issue_comment | Comment on an issue |
search_issues_and_prs | Search issues and pull requests |
list_pull_requests | List pull requests |
get_pull_request | Get a pull request, including draft and mergeable status |
get_pull_request_diff | Get a pull request’s diff |
get_pull_request_checks | Get the status of checks on a pull request |
get_workflow_runs | List GitHub Actions workflow runs |
create_pull_request | Open a pull request |
update_pull_request | Update a pull request’s title, body, base or state |
add_pull_request_comment | Comment on a pull request |
create_pull_request_review | Submit a review (approve, request changes or comment) |
list_pull_request_reviews | List reviews on a pull request |
mark_ready_for_review | Mark a draft pull request ready for review |
merge_pull_request | Merge a pull request (merge, squash or rebase) |
Writes run without a confirmation card, so agents are expected to read before they write and report what changed. GitHub refuses an approving review on a pull request the App itself opened. In chat, pull requests render as a live status card with a diff viewer.
Common use cases
Section titled “Common use cases”- Issue triage. An agent reviews new issues, labels them by content, and leaves an acknowledging comment.
- PR summaries. “What changed in #482?” reads the diff, the commits and the check results.
- Status reports. A workflow queries open issues and recently merged pull requests and posts a weekly development summary.
- Code reference. During a conversation about a bug, the agent reads the relevant source file and the recent commits that touched it.
- CI watch. “Is main green?” lists the latest workflow runs.
Troubleshooting
Section titled “Troubleshooting”Not connected Nobody has installed the Sprigr GitHub App for this workspace. Click Connect GitHub on the settings page or ask the agent to connect GitHub; an organisation owner completes the GitHub side.
“Installation requested” Your organisation requires owner approval for new apps. An owner approves the request on GitHub, then you connect again.
A private repository returns not found The installation does not include that repository. An organisation admin adds it under the App’s Configure page on GitHub (the settings page links there), or removes a narrower repository scope in Sprigr.
“Access denied: repository scope is limited to …” The request is outside the repository scope set on the settings page. Widen or clear the scope.
Credential errors after it used to work The installation was removed or suspended on GitHub. Disconnect from the settings page, then connect again.
GitHub rate limits Installation tokens carry GitHub’s per-installation rate limit. Spread out automated queries in workflows.
Next steps
Section titled “Next steps”- Integrations Overview: See all available integrations.
- Agent Settings: Make the app available to specific agents.
- Workflows: Use GitHub actions as steps, for example creating an issue when a workflow detects a problem.