OpenClaw EnterpriseDOCSGitHub

Check the local k3d quickstart

Human verified

A human reviewed this page, but it may be out of date. Later edits may not have been reviewed.

Overview

Exercise the quickstart through browser onboarding, Linear, and Git on one Agent in a fresh local installation. This workflow uses real model and integration credentials.

Trigger

Dispatch manually from protected main. The workflow also accepts pushes to its named development branch only by the configured author and when the commit matches OCE_QUICKSTART_REVIEWED_SHA; see the exact workflow condition. It has no scheduled trigger and is not part of CI Required.

Scenarios

The stages use the same Agent throughout installation, integration changes, and redeployment. Setup executes the quickstart's published shell examples. The reusable CI runtime job builds this workflow's source before installation. Quickstart verifies the same-run artifact's source, checksum, OCI configuration, and platform before loading it. Image preparation builds the controller from the same checkout and records both immutable references through a run-owned loopback registry. Both selections are exported before operator credentials are staged; the launcher does not repeat either build. The registry is removed after the run, including failed preparation.

Setup and action Expected outcome Source
Create a fresh local installation and onboard a model-only Agent through the Control UI. The Agent completes onboarding, saves its identity and the user's preference in workspace files, and returns a terminal assistant response. Setup and browser checks.
Enable Linear through the published Add Plugin procedure and ask for a known team. The real codex_apps.linear.list_teams result and reply contain the configured team ID, which was not supplied in the prompt. Linear stage.
Add Git and push an empty commit to the fixture repository on a unique run-owned branch. The remote commit matches the expected branch, parent, tree, and author. Git stage.
Retire write access, deploy read-only access, and read the branch. A retired write is denied without new network calls or use receipts; the read returns the expected commit and the Agent retains its Linear configuration. Git stage and retired-write checks.
Reopen the original Control UI conversation after redeployment. The same Agent and conversation recall the saved preference on the final read-only revision. Recall stage and browser checks.
Retire Git credentials, remove the test branch, and delete the Agent and installation. Credential custody is retired, the verified run-owned branch is absent, the Agent returns 404, and its local cluster and state are removed. Git cleanup and teardown.

Execution

Configure these inputs at the repository level:

Input Purpose
Secret OCE_QUICKSTART_CODEX_PAT Codex service account with the selected model and an authorized Linear connection
Secret OCE_TEST_GITHUB_APP_PRIVATE_KEY RSA key for the App installed on the test repository
Variable OCE_QUICKSTART_MODEL Model available to the service account
Variable OCC_TEST_LINEAR_TEAM_ID ID of a team the connected account can read

Dispatch the k3d quickstart workflow on main:

sh
gh workflow run k3d-quickstart-e2e.yml --ref main

Results and limits

Use the workflow result and its sanitized receipt to check the push, read-only restoration, tool result and cleanup. If a run ends during a push, check the remote ref before retrying. Keep the private operator session on the runner.

The job has a 300-minute timeout. Inspect the k3d-quickstart-<run-id>-<attempt> artifact, retained for seven days. Its status.json records the source commit and stage outcomes; successful stages also supply browser, Linear, Git, image-digest, and cleanup receipts. The receipt collection script checks that the completed workflow used one Agent and the same conversation before and after redeployment. Missing or skipped stages do not count as a completed workflow.

Setup has a 102-minute subprocess deadline inside its 105-minute step limit. On expiry, the wrapper terminates the setup process group before reporting sanitized startup timings and entering teardown. Raw command output remains private. Setup saves the Agent's identifiers before its first deployment so failure diagnostics and teardown can use that Agent. Failed setup, Linear, and Git stages report source-defined deployment and worker codes without publishing provider messages. The diagnostic deployment read has a 20-second deadline and does not suppress runtime logs when it fails.

If Git cleanup fails, installation teardown is withheld so that credential retirement can be investigated. Private input files are removed by an always-run step. Uploaded evidence contains selected sanitized receipts, not raw private logs, operator credentials, or conversation bodies.

This qualifies the local k3d quickstart and its selected live integrations. It does not establish coverage for every installation type or provider.

Files

Search documentation