Skip to content

Where people and agents ship software together. The open-source git platform for the whole job: issues, agents, checks and deploys to the edge.

syntaqxA workspace's owners get Getting started, a setup guide that opens by itself on Home and the Workspace page until they finish it or close it. It is a dialog with a rail of six steps beside the step at hand (on a phone, the sheet with "Step n of 6" and a progress bar above it): add an AI provider, choose Ask's model, bring your code, connect your harness, invite your team, add a runner. Each step is ticked from what the workspace has, never from clicks (lib/onboarding.ts, read by lib/onboarding.server.ts at once from integrations, projects, the GitHub App, identity, billing and actions): a provider whose key passed its last check; Ask answering with a provider and no problem; a project, or GitHub connected; a token named "g1t CLI on …" or an app signed in with g1t, as the Claude Code plugin does; another member or an invitation waiting; a runner. The AI steps work in place: choosing a lab (or a platform or endpoint from More providers), pasting its key and Add and check the key, Test, and Use for Ask all post to the AI page's own action, so they are the AI page's checks and the page reads the new state after. Bring your code offers New project and the one-click Connect GitHub; the harness step has the CLI's install commands for macOS and Linux and for Windows, g1t auth login and the plugin's two commands, ready to copy; on a free workspace the team step says workspace invites come with the plan, links to it, and offers inviting a friend to g1t instead. Every step but the provider can be skipped, and when everything is done or skipped it says All set and Finish puts it away. AI stays a base setting: nothing of it is in Integrations.

README.md

g1t/deploy

Builds the checkout a g1t Actions job is in and puts it on g1t.page: production when the run is on the project's production branch, the pull request's preview for a pull request's run, and the branch's preview for a run on any other branch.

name: Deploy

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read
  deployments: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - id: deploy
        uses: g1t/deploy@v1
      - run: echo "Live at ${{ steps.deploy.outputs.url }}"
yaml

The project must have Deployments on, and the workspace's plan must include them. The guide, Deploying from a workflow, says what is built and when.

Inputs

InputDefault
projectThe repository's one project with Deployments onThe project's slug. Needed when the repository has several.
root-dirThe project's settingWhere the project is in the checkout.
build-commandThe project's setting, else what the build findsWhat builds it.
output-dirThe project's setting, else the folder the framework writes, else the first of dist, build, out, public, _site, .output/publicThe folder a static build writes.
build-asThe project's setting, else autoWhat it is built as: auto, static, workers or docker. A container is built with the docker on the job's PATH.
dockerfileThe project's setting, else Dockerfile or ContainerfileThe Dockerfile a container is built from, relative to the project.
shaThe run's commitThe commit this is a build of, for its g1t / deploy check.
token${{ github.token }}The job's own token. It needs deployments: write; any other token is refused.

Outputs

Output
urlWhere the app is served.
deployment-idThe build's id, dpl_….
kindproduction or preview.

How it works

  1. It calls POST /repos/{owner}/{repo}/deployments/builds with the job's token. g1t checks the plan and the spend limit, decides production or preview from the run, sets the commit's g1t / deploy check to pending, and answers with a token for this build alone and the project's variables and secrets for builds of that kind.
  2. It masks that token and every secret with ::add-mask::.
  3. It runs g1t-runner deploy in the checkout, which installs, builds and uploads the app exactly as g1t's own builds do, and reports to g1t with the build's token. The build's log is in the step's.

A pull request from a fork or from someone without the Write role, and a run that had to be approved, build without the project's secrets. The build's time is the job's Actions time; it is not charged again.

g1t-runner is on g1t's machines. Elsewhere (a self-hosted runner), the action uses the one on PATH, or downloads the newest release from https://g1t.sh/downloads/runner/latest/ and checks it against the release's SHA256SUMS. It runs on Linux and macOS, with curl and either jq or python3.