Skip to content
Sign up

flagon-io/g1t

public
00

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

g1t.sh
gitagentscloudflarerustforgemcp
syntaqxThe desktop app's runner is a dot right beside Settings in the title bar, with its own menu, and the settings open over the page rather than in a window to manage; every button that asks the app for something shows it is working until what it asked for shows. The dot is the runner's colour, live (green running, blue and breathing while it works, amber or red when it needs you, grey stopped), with the words on hover and beside it on a wide window. A click hangs the runner menu under it: what the runner is doing with Start or Stop for the whole runner, the whole runner's line and fix when it needs you, each kind of job with its state, the job it runs linked to its run, a newer runner waiting and its own Start or Stop, when the app last looked for updates with Check for runner updates, the last lines of the log with Open the whole log, and Runner settings…. Escape, a click outside or the dot again closes it, and the dot says whether it is open. The settings are a dialog with their sections down the left (Starting and closing, Runner, Notifications, Window, Updates, Server, About) and the one chosen on the right, opened by the title bar's button, the File or g1t menu's Settings and Ctrl+, or ⌘,, the tray's Settings…, the account menu's Desktop app settings, and Check for updates…, which opens them at Updates and looks; the window comes forward if it was hidden. Both are drawn by the site's page, which fills the window under the bar and tells the app it can once it has loaded; while the window shows no page of the site's (the server picker, the offline page, signing in with GitHub), or a site too old to say so, they open in the Settings and Runner windows as before. Each change is saved over the settings as the app has them at that moment, so a change made elsewhere meanwhile isn't undone. The site's page may change every setting but one: it can't take the runner out of its sandbox; choosing In Docker or Directly on this computer opens the Runner window, bundled with the app, where that is chosen, and putting it back in the sandbox works from either. Retry, Check now, Start, Stop, Remove it and start again, Open Docker, Check for runner updates, Check for updates, Restart now and the rest show a spinner, can't be pressed again and are said to be busy from the click until the runner's status or the answer that follows changes, an error, or 20 seconds with nothing, in the site and in the app's own windows alike; which fixes wait for the runner, and what Remove it and start again asks first, are now the app's catalogue's to say. The desktop guide says all of it.

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.