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.

syntaqxThe app's frame and your own pages fail one part at a time. Root loader: the viewer stays strict; the sidebar's projects, the open counts, Shared with you and the live feed's ticket go through part() and do without quietly, so one of them failing no longer drops the sidebar to its bare form or, for a visitor, takes down every page. A repository's frame: the repository and its project stay strict (404s, renames, transfers); its open counts and the project lookup do without. Profile: activity, workspaces, stars and contributions each say so in place. Notifications, invitations ("No invitations waiting" was what a failure said), pricing's usage and price changes, importing from GitHub on New, and the installations already on GitHub. Settings: account's erasure and deletion check show Unavailable instead of their forms; notifications' email, security and new-repository sections show Unavailable instead of forms that could save over unknown values (the page used to blank entirely), and watched repositories in place; GitHub ("not set up here" was what a failure said); integrations' GitHub link and grants; two-factor's message is Unavailable. Kept strict on purpose: sign-in, registration, invites, OAuth, device, two-factor sign-in and email confirmation, and every page that reads only its subject. Kept quiet on purpose: profile descriptions, notification tab counts, billing on pricing, hasPassword (it only asks for a password, which identity checks anyway), sounds. Checked: apps/web tsc -b; npm test (987, 1 skipped).

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.