Crescendo Lab Docs
English
Sign up

Deploy from GitHub

Connect a GitHub repository to a project. The project deploys from its production branch; turn on auto deploy on push to go live on every push.

Last updated

How it works#

Agent Lab's GitHub App, Crescendo Agent Lab, provided by Crescendo Lab, reads the repositories you allow and is told about every push.

  • The project is bound to its production branch (the repository's default branch unless you change it). With auto deploy on push turned on, a push to it builds and goes live on the project's address.
  • A push to a git branch with the same name as one of your workspace's Agent Lab environments, such as staging, goes live there (also only with auto deploy on).
  • A push to any other branch builds nothing: no version, no preview address, nothing on the commit.
  • The commit on GitHub can show the result: pending while it builds, then success with the version's address, or failure with a link to the build log.

The build works as it does for an upload, and the platform detects the framework the same way. See deploy from source code.

Not the same as the GitHub integration

The GitHub integration under Integrations lets assistants use GitHub's tools in a conversation. Deploying uses its own connection, set up here.

1. Connect GitHub#

  1. In Settings › Deploy settings, select Connect GitHub.
  2. GitHub asks where to install Crescendo Agent Lab: your account or one of your organizations. Choose all repositories or only the ones the projects need.
  3. You come back to Agent Lab with the account listed. An organization whose owner has to approve the install shows as requested until they do.

A workspace connects one GitHub account or organization. Connecting, changing and disconnecting happen only here, and only workspace owners and admins can do them.

Change the account

Select Change account and install Crescendo Agent Lab on the new account or organization. Back in Agent Lab, before anything changes, you see every project connected through the current account:

  • projects whose repository the new account can also read keep their repository, production branch and auto deploy;
  • the others are disconnected: they lose their repository link and branch settings.

Select Change account to replace it in one step, or keep the current one. Nothing changes if you don't decide within 30 minutes. Either way, Crescendo Agent Lab stays installed on the new account on GitHub until you uninstall it there.

Disconnect

Disconnect first lists every project connected through the account. Each loses its repository link and branch settings; what it has deployed stays, and it can still deploy by upload or with an AI tool. Crescendo Agent Lab stays installed on GitHub; uninstall it there if you no longer want it to read anything.

When GitHub stops it

If the account suspends Crescendo Agent Lab on GitHub, Deploy settings and each connected project's Settings › Git say so, and pushes aren't deployed until an owner restores it on GitHub. If it is uninstalled on GitHub, its projects are disconnected and Deploy settings says so; connect again to deploy from GitHub.

2. Import a repository#

  1. On the projects page, select Create project, then Import from GitHub.
  2. Search for the repository by name and select it. The search covers every repository the account lets Agent Lab read. Can't find one? Use Adjust repository access on GitHub at the end of the results to share it.
  3. Check the name, the address label and the production branch. For a monorepo, set the Root Directory, such as apps/web.
  4. Paste the variables the project needs, or add them later.
  5. Select Deploy. The newest commit on the production branch builds and goes live. Auto deploy on push starts off, so later pushes don't deploy until you turn it on (see below).

An existing project connects in Settings › Git.

Auto deploy on push#

Each project has a switch, Auto deploy on push, in Settings › Git. It is off when you connect a repository, including projects connected before the switch existed.

  • On: a push to the production branch builds and goes live, and a push to a branch named like an Agent Lab environment updates that environment.
  • Off: pushes build nothing. Select Deploy latest commit when you want to go live; it works whether the switch is on or off.

Only people who can manage projects can change it.

When two pushes are close together, the newest commit goes live, even if the earlier push finishes building last: a version never goes live by itself over a newer one. See Go back to earlier code.

Environments#

A git branch goes live in the Agent Lab environment with exactly the same name, automatically: a push to staging goes live in your staging environment. There is nothing to map. Create the Agent Lab environment first; until it exists, pushes to that git branch build nothing. The production branch always goes live on the project's main address. In Settings › Git you can change the production branch. Deploy latest commit builds the production branch again without a push.

Limits#

  • A repository is held to the same limits as an uploaded source: 20,000 files and 512 MB, without node_modules and .env.local / .env.*.local files. Committed .env and .env.<mode> files are kept, as Vite and Next.js expect. The commit's .git (depth 1) counts toward the limits; a repository that would pass them with it builds without .git.
  • The build has git and the pushed commit; see Build environment.
  • Git submodules and Git LFS files are not fetched.
  • Each push uses build minutes like any other build.