Groundfloor Docs

Deploying and versions

Upload new versions, deploy or roll back, deploy from Git, and promote between environments.

Every upload creates a new version of your Coderunner. Deploying puts a version into service with its settings. Because old versions are kept, you can roll back by deploying an earlier one.

From upload to running

StepWhat happensStatus to watch
UploadYour ZIP becomes a new version and starts buildingBuild: Completed or Failed
DeployThe built version starts running with its settingsDeployment: Deployed or Failed
RunA Function answers requests; a Job or Schedule runsExecution: Succeeded or Failed

In the CLI, gf deploy does the first two steps and waits for each. If the new deployment fails, gf deploy exits with an error and the reason, and the previous version keeps serving. While a new version is being deployed, the Client Portal keeps showing the previous Deployment URL until the new one is ready.

Deploy a different version

To roll back, deploy an earlier version:

  • Client Portal: open the Coderunner, pick the version and deploy it.
  • API: POST …/coderunners/{coderunner_id}/deploy with that version_id. List versions with GET …/coderunners/{coderunner_id}/versions.

To upload without deploying, use gf deploy --skip-deploy.

Deploy from Git

Deploy straight from a Git repository instead of a ZIP:

gf deploy --git https://github.com/acme/greeter.git --ref main

Add --subdir if the code lives in a folder of the repository.

Deploys from Git, and the promotions below, don't carry your environment variables, so keep settings your code always needs in the code itself.

To redeploy on every push, connect a Git source to the Coderunner in the Client Portal and add the webhook it gives you to your repository. For a private repository, store an access token in Secrets and choose it when connecting. The Git source API is in the Coderunners API.

Promote between environments

A Coderunner belongs to one environment, such as dev or prod. When a version works in dev, promote it: Groundfloor deploys the same version to the matching Coderunner in the target environment, and creates that Coderunner if it doesn't exist yet. Compare the two environments first to see what will change. See Environments.

Delete

Deleting a Coderunner removes it from the workspace. You need the Writer, Admin or Owner role.

Next steps

On this page