GitHub installation

Install the Warpway GitHub App on an organization or account, choose repositories, and change them later.

Warpway is a GitHub App. Installing it on a GitHub organization or personal account gives Warpway access to the repositories you select and makes that account your Warpway organization.

Who can install

Organizations: organization owners can install GitHub Apps directly. Warpway requests organization Members read access, so repository admins request installation and an organization owner approves it. Other members can request an installation; GitHub sends the request to the owners to approve.
Personal accounts: the account owner installs it on their own repositories.

Installing requires accepting the app's permissions. GitHub permissions explains each one.

Install the app

Choose Install on GitHub on this site or in the dashboard.
On GitHub, pick the organization or account.
Choose repository access:
- All repositories includes every current and future repository in the account.
- Only select repositories limits Warpway to the repositories you pick.
Review the permissions and choose Install (or Request, if an owner has to approve it).
GitHub returns you to Warpway, first asking you to authorize it if you have not signed in before. Warpway signs you in, links the installation to your organization and starts analyzing the selected repositories.

One GitHub account maps to one Warpway organization. When Warpway creates the organization, the person who installed the app becomes its first Owner. The installation is the boundary of what Warpway can see: it never reads repositories outside it.

What happens after installation

Warpway analyzes each enabled repository's default branch to detect languages, tests, CODEOWNERS, CI checks, documentation and any .warpway.yml, then recommends lenses. Reviews start with the next eligible pull request event: a pull request opened, reopened, marked ready for review, or updated with new commits.

Pull requests that were already open are reviewed the next time they change or are reopened. Once a review exists, you can rerun it from the dashboard.

Who can see the organization in Warpway

Membership follows GitHub. When someone who belongs to your GitHub organization signs in to Warpway with GitHub, Warpway confirms the membership with GitHub and they join your Warpway organization as a Member. Outside collaborators and people with access to only some repositories do not join; they see Warpway's results on GitHub and answer questions sent to them there or in Slack. Membership is re-checked hourly: people who leave the GitHub organization lose their Warpway membership, whatever their role. If that leaves the organization without an Owner, the next GitHub organization owner who signs in becomes its Owner. Admins can make people Admins; only Owners can make people Owners:

Role	Can
Member	View reviews, re-run reviews, answer tasks assigned to them, give feedback, view knowledge and people
Admin	Everything a Member can, plus configure repositories, lenses, Slack, routing, identities, policy and runtime verification; view analytics; approve knowledge; manage members; reassign tasks
Owner	Everything an Admin can, plus billing, deletion, retention, trust levels of Clear and above, organization locks, auto-approval and managing Owners

People who only answer questions in Slack do not need a Warpway account at all.

Add or remove repositories

Repository access is managed on GitHub:

Organization: Organization settings → GitHub Apps (under Third-party Access) → Configure next to Warpway → Repository access.
Personal account: Settings → Applications → Installed GitHub Apps → Configure next to Warpway.

Warpway receives an event when repositories are added or removed:

Added repositories are analyzed and reviewed from their next pull request event.
Removed repositories stop being reviewed immediately. Their review history stays in Warpway, subject to your retention period, until you delete the organization.

Admins can also pause reviews for a repository inside Warpway without changing its GitHub access.

Suspend or uninstall

On the same GitHub settings page an owner can Suspend the installation, which stops all access and events until it is unsuspended, or Uninstall it. Uninstalling stops access immediately but does not delete data in Warpway; see Uninstall and deletion. If Warpway / Review is a required check, remove that requirement first, or pull requests will wait for a check that never arrives.

Plans and repository visibility

On the Free plan, reviews of public repositories are unlimited and private repositories get 20 reviews per calendar month. The Team plan removes the private limit. See Billing.

Troubleshooting

If no check appears on a pull request after installation, see No Warpway check on a pull request.