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 pages fail one part at a time, and never say something false because a read failed. The frame: a visitor's sidebar projects do without instead of taking every page down. Settings: data residency (a failure could save "anywhere" over "eu"), two-factor and Delete (what deleting would take) show Unavailable instead of their forms or button. Billing: spend limit, allowance and alerts, credit, limit requests and Billing on Stripe (its stream no longer rejects) each in place. AI: Ask's setting shows Unavailable instead of a form that could save over the real choice. Security: a failed overview no longer shows the activate-the-plan prompt. Members: outside collaborators, each member's teams; personal access tokens: members' tokens; Actions: managed workflows; packages: deleted packages; repositories: recently deleted; projects: production links; integrations: repositories to add and each alert source's recent deliveries; the visitors' overview: counts and open pull requests; code access, team repositories to add, members on the overview, installed apps, artifact spaces' teams (a space's form is withheld rather than lose its team kind). Artifact spaces and repository files no longer turn a failure into a 404. Home's streamed sections are each in a Boundary; usage has an errorElement. Kept quiet on purpose: the price book and this month's usage on billing (defaults and "—" stand in), EU availability, the delete list's app count, the workspace name (its slug stands in), descriptions, pins, the bypass badge. Checked: apps/web tsc -b; npm test (987).

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.