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.

syntaqxMerging a pull request that has fallen behind waits for the required checks on the commit that brings it up to date, and a merge the repository does not answer says so instead of hanging. Pressing Merge on a pull request behind its target brought it up to date and then landed it at once, asking to skip its checks; a ruleset that requires checks and does not allow skipping them (flagon-io/g1t's "Main stays deployable", CI required) refused that, so every catch-up-then-merge there stopped at "Needs you" with "The required check CI from actions has not reported on its latest commit". Now the merge waits: once the catch-up push arrives, it lands as soon as every required check passes on that new commit (decided as each of the commit's checks finishes, statuses.rs store_status), at once when none are required, and when a required check fails there it stops with "It was brought up to date, but the required check CI failed on that commit, so it was not merged. Push a fix, then merge again." Two checks finishing together land it once (the waiting merge is taken in one statement). A merge asked to go past failing checks, where the repository allows that, still lands without waiting. The wait stands for three hours (the catch-up push still for 30 minutes); a pull request g1t is seeing through shows it as Checking. The merge box says "Merging once checks pass: Brought up to date with main. It lands once the required check CI passes on that commit.", then "Landing now."; while it is still being brought up to date it says it lands once the required checks pass on that commit, when there are any.

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.