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.

gitagentscloudflarerustforgemcp
syntaqxConnecting GitHub to a workspace is one click and one trip to GitHub. A workspace owner's Connect GitHub on Import from GitHub links their GitHub account on the way if it is not linked yet and comes straight back to carry on: an installation they already have on GitHub and the workspace lacks is added rather than installed again (with several, they choose), and only with none are they sent to install the app; GitHub then returns them to the import page with the account connected. Before, linking and installing were separate chores (link, come back, install), Settings -> GitHub stopped at "Linked" with nowhere to go, and an app already on the account was "installed" again through GitHub's settings page. When GitHub returns after an installation that did not start from g1t, an unlinked account is linked on the way instead of showing an error with a button, and someone who owns one workspace has it added there without being asked which. Choose repositories on GitHub opens in the same tab, since GitHub brings you back after saving; Add a GitHub account still always installs on another account; Settings -> GitHub points to Import from GitHub once linked. A link that does not take shows the page instead of going round again. The GitHub guide describes the one-step flow. (The app's Setup URL was empty on GitHub, which left people there after installing; it is now set to /integrations/github/setup.) Checked: the site's typecheck (tsc -b --force), its 911 tests (new: what Connect GitHub does next), a production build and the deploy tool's 92 tests.

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.