Skip to main content
The LaneSync GitHub App connects your repositories to the hosted SaaS at lanesync.dev. Installation triggers repository discovery, webhook subscription, and the repo setup wizard.

​
Installation flow

1

Sign in to LaneSync

Go to lanesync.dev and authenticate with GitHub OAuth.
2

Start installation

From the setup wizard, click Install GitHub App. You are redirected to GitHub to select org/account and repositories.
3

Grant repository access

Choose All repositories or select specific repos. You can adjust access later in GitHub Settings → Applications. If you select no repositories, LaneSync creates your workspace but the dashboard stays empty until you grant access and sync — you do not need to re-install the App.
4

Approve permissions

Review the requested permissions and click Install. LaneSync receives an installation webhook and creates or links your tenant.
5

Finish signing in to claim the workspace

Return to LaneSync and complete GitHub sign-in with an account that can access this exact App installation. For a new organization workspace, that account must be an active organization owner. For a personal workspace, sign in as the personal account owner. LaneSync then adds the first workspace admin; other teammates join through an invite.
6

Complete repo setup

For each new repository, run the repo setup wizard to configure branches, CI checks, and bootstrap sdlc.yaml plus workflows.

​
Wizard configuration

After installation, open the repo setup wizard for each repository. Review the configuration before applying setup. Additional wizard steps cover existing CI/deploy workflows and PR approval counts. LaneSync applies the reviewed configuration with the bootstrap request.
GitHub displays a check as Workflow name / Job name, but branch protection matches the job name. For example, if GitHub shows Deploy to Staging / deploy, the check name is deploy, not Deploy to Staging.
When LaneSync generates deployment starters, the first stage-specific check that is not already required by an earlier stage becomes that starter’s job name. For example, a testing check named Deploy to Staging produces a staging job with name: Deploy to Staging. Add another workflow job for every additional required check. If you keep existing deployment workflows, the wizard does not rename them. Enter their exact job check names so sdlc.yaml, the reported checks, and GitHub rulesets all agree.

​
After install — two bootstrap paths

Requires: administration:write and workflows:write on the GitHub App.On the final wizard step, click Apply setup. LaneSync uses the App token to create the setup files and configure protection. Successful setup reaches COMPLETE.If GitHub prevents automatic merging, setup returns PR_CREATED. Open Review & merge setup PR in the wizard, review the files, and merge when GitHub permits it. LaneSync then applies branch protection using the same App installation; you do not need a PAT.Best for teams that want hands-off branch protection and rulesets.After bootstrap, use Update LaneSync Workflows to refresh managed template files when LaneSync ships improvements.

​
Bootstrap state progression

For either tier, the wizard polls pending setup until COMPLETE. Normal status checks and background reconciliation can also recover a pending setup when the merge webhook was missed. A merged setup PR alone does not prove that protection is active.

​
App tiers

Best for: Teams that want zero-touch branch protection and rulesets.LaneSync can enforce PR approvals and required checks without manual branch protection setup.

​
Required permissions

If branch protection remains pending, check the reported error and use Retry branch protection setup. App-based setup retries with the installed App; verify Administration: Read & Write. PAT-based setup uses the saved token while available and asks for a replacement when needed.

​
Adding repositories later

1

Grant access on GitHub

Open GitHub Settings → Applications → Installed GitHub Apps and configure the LaneSync or LaneSync Lite installation for the account that owns the repository.If you chose Only select repositories, add the new repository and save. With All repositories, newly created repositories are included in the installation’s access.
2

Discover repositories in your workspace

Sign in to LaneSync, select the workspace for that GitHub account, and click Discover repositories on the dashboard.Discovery lists all repositories accessible to that workspace’s installed App, including repositories beyond the first 100. It uses the installed Full or Lite tier even when your sign-in uses the other App tier. To discover repositories for another account, switch to its workspace and repeat.
3

Review repository setup

Open Manage repositories & setup to find the repository and review its setup. Discovery starts synchronization in the background; a successful discovery response does not mean setup has finished. Complete the repo setup wizard before creating an active release.
Discovery refreshes the repository list for installations already linked to the selected workspace. It does not grant GitHub access or create a new workspace. See repository discovery troubleshooting if a repository is still missing.

​
Manual GitHub App setup (advanced)

Enterprise and self-hosted customers may register their own GitHub App and provide credentials via environment variables (GITHUB_APP_ID, GITHUB_APP_PRIVATE_KEY_PATH). See Enterprise self-hosting. For the hosted SaaS, use the setup wizard — manual setup is not required.

Trusted Bootstrap

PAT-based setup for the minimal App tier.

Configure sdlc.yaml

Customize gates after bootstrap.