GitHub
Connect sfora's GitHub App, see a project's pull requests, review and merge them in sfora, and browse the code in the Library.
GitHub connects to sfora through the sfora GitHub App. Once a project has a repository attached, its pull requests and its code show in the project's Library, and you can review and merge pull requests without leaving sfora.
- + Attach repo adds another repository to the project.
- Each pull request's checks: running, passing or failing.
Connect GitHub
A workspace owner or admin connects GitHub once for the whole workspace.
Open Settings (7), and under Manage, pick Integrations.
On the GitHub card, click Connect. GitHub opens.
Install the sfora GitHub App on your account or organization, and choose the repositories it can see.
GitHub sends you back to sfora, which links the installation to your workspace. If you belong to more than one workspace, pick one under Connect GitHub to….
The GitHub card then says Connected and which GitHub account it's installed on. Manage opens the installation on GitHub, where you can change which repositories sfora can see. Under the card, Connected repositories lists every repository attached to a project, with a link to the project.
Attach another repository
When a project already has a repository, its Library shows a Pull requests section, which lists the attached repositories at the top. To add one:
Click + Attach repo.
In Attach a repository, search for the repository. The list shows the ones the sfora GitHub App can see; private ones have a lock.
Click Attach beside it.
A project can have several repositories, and a repository can be attached to more than one project.
See a project's pull requests
Open the project's Library (4) and scroll to Pull requests. It lists the open pull requests of every attached repository, the most recently updated first. Each row shows:
- its state: Open or Draft;
- its title, then the repository and number, the author, and when it last changed;
- the lines added and removed;
- its checks: Checks running, Checks pass or Checks fail.
Click a pull request to open it.
Review a pull request
The pull request's page shows its state, title, author and branches, the cards and posts that reference it under Referenced in, and the diff.
To comment on a line, point at it in the diff and click ＋. Type in Leave a comment on this line… and click Add comment. The comment waits, marked Pending review, until you send your review.
Send your review with one of the buttons at the top:
- Approve;
- Request changes;
- Comment, which opens Leave a review summary…; click Submit comment to send it.
Your line comments go with it.
To merge, click Merge (squash). sfora squashes the pull request's commits into one.
The buttons show only while the pull request is open. GitHub at the top right opens it on GitHub, and Pull requests at the top left takes you back to the list.
Reviews and merges are sent by the sfora GitHub App, not by your own GitHub account.
Browse the code
In the project's Library, open Repositories, then the repository. It shows the files on the repository's default branch.
Click a file to read it. A Markdown file switches between Rendered and Source. Copy path copies the file's path, and Open on GitHub opens it there.
Availability
Connecting GitHub, attaching a repository, reviewing and merging take a workspace owner or admin. Any member of the project can see its pull requests and browse its code. GitHub works on every plan.
Troubleshooting
Approve or Merge fails
Only workspace owners and admins can review and merge from sfora. Ask one of them, or review on GitHub.
A repository isn't in Attach a repository
The sfora GitHub App can't see it. In Settings › Integrations, click Manage on the GitHub card and give the App access to it.
A file says Preview is too large
sfora shows files up to 1 MB. Larger files, and binary files, stay on GitHub: click Open on GitHub. A repository's file list holds at most 8,000 files and folders.
Last updated on