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.

syntaqxAsk builds and ships something new from one card (#53): asked to build an app from nothing, Ask had no way to get there. It reads only, propose_session needed a repository that already existed, deployments are turned on only in Settings, and the session it handed off was told never to push to the default branch, so an empty workspace couldn't end with anything live. propose_session now takes new_repository (with private, and deploy, on unless asked otherwise) for a repo in the workspace that doesn't exist yet. Its card says what starting it does: it creates the repository as the person (its project described with the issue's title), turns on its deployments, opens the issue and starts the session, and then shows Created <repo> and the production address on g1t.page, or why deployments couldn't be turned on (no g1t plan, no Admin role), in which case the session still builds it. Sent again (a retry, or Copy after Start), the repository already made is used. The session is told the repository is new and empty: push the first working version straight to the default branch, since there's nothing to open a pull request against, close the issue with Closes #, watch `g1t deploy list` until it's live or fix what failed, and end its report with the address. The agent's system prompt allows that first push and says a push to a deploying project's default branch deploys production. Ask's prompt says when to propose a new repository, that the card, not Ask, changes g1t, and how to answer: what will be built, that it goes live by itself once pushed, and to ask how it's going. For an existing repository it points to Settings → Deployments. Ask still changes nothing itself; the person's click does.

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.