GitHub
Connect GitHub so Sprocket's agent can link pull requests to threads, watch their checks and reviews, and settle threads when they merge.
The agent uses the GitHub CLI for pull requests and other GitHub work. Sprocket installs it for you.
This is only in dev and canary builds. It isn’t in a stable release yet. See release channels.
Sign in
In Settings → Connectors, click Sign in next to github.com. Sprocket shows a code and a link to GitHub. Open the link on any device, enter the code, and approve the sign-in. The GitHub card then shows Signed in as and your GitHub username. Sign out removes the login from the computer running Sprocket.
For GitHub Enterprise, click Add a GitHub Enterprise host, enter its hostname, and sign in the same way.
If GH_TOKEN or GITHUB_TOKEN is set where Sprocket runs, Sprocket uses that token instead. For an Enterprise host, set GH_HOST to its hostname and GH_ENTERPRISE_TOKEN or GITHUB_ENTERPRISE_TOKEN to its token.
Sprocket no longer saves GitHub tokens. If you saved one in Settings → Version Control, sign in again from Settings → Connectors.
Pull requests in threads
The agent links the pull requests it works on to the thread. They appear in the thread’s Pull requests list with their current status. The agent can wait on a pull request until its checks finish or a reviewer comments.
To settle a thread when its pull requests merge, turn on Settle threads when their PRs merge in Settings → General.
Commits
Sprocket tells the agent to add Sprocket as a co-author on its commits. Turn this off in Settings → Version Control.
Turn off GitHub
Turn off GitHub, or one of its hosts, in Settings → Connectors. The agent then can’t link pull requests, and their status stops refreshing.