Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
12 changes: 12 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,13 @@ OPENAI_API_KEY=
# CLAUDE_CODE_OAUTH_TOKEN=
# CHATGPT_AUTH_FILE=

# Where a ChatGPT plan's model calls go, for the TypeScript LangGraph engine and the server's own
# Bots: the LangGraph harness (agent-langgraph-agui), which holds that plan's token store, by its
# name on the Compose network. Set only with CHATGPT_AUTH_FILE. The token defaults to
# MANAGED_AGENT_TOKEN. The desktop app sets this itself on a ChatGPT plan.
# CHATGPT_PLAN_HARNESS_URL=http://agent-langgraph-agui:4206
# CHATGPT_PLAN_HARNESS_TOKEN=

# Which model the framework Bot uses. Defaults per provider: gpt-5.5, claude-sonnet-5-5,
# gemini-2.5-flash. A 5.6 tier works here: set one and the Responses API is switched on
# automatically. It used to answer nothing at all on those models — RUN_STARTED, RUN_FINISHED, no
Expand Down Expand Up @@ -466,6 +473,11 @@ COMPUTER_TOKEN=
# the LangGraph harness (agent-langgraph-agui) on 4201 for a laptop.
# MANAGED_AGENT_AG_UI_URL=http://127.0.0.1:4201/

# The TypeScript LangGraph engine (agent-langgraph-ts), which new Bots run on. Optional: unset, new
# Bots run on the server's built-in engine. Called with MANAGED_AGENT_TOKEN, like the managed Bot.
# `scripts/start.sh` points this at the engine on 4215 for a laptop.
# LANGGRAPH_TS_AG_UI_URL=http://127.0.0.1:4215/

# Shared secret sent by the server on every call to a managed Bot, as the `x-openbot-agent-token`
# header. Required together with the URL above; the server starts without either.
#
Expand Down
1 change: 1 addition & 0 deletions .github/published-images.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"agent-llamaindex",
"agent-agno",
"agent-langgraph-agui",
"agent-langgraph-ts",
"agent-adk",
"agent-pydantic-ai",
"agent-microsoft",
Expand Down
134 changes: 122 additions & 12 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@ jobs:
- run: bun run typecheck
- name: Desktop version tracks the release version
run: bun desktop/scripts/desktop-version.ts check
# What each recorded OpenBot Desktop launch hands Compose, read with this tree's
# docker-compose.yml by Compose itself: the file must take it, and must still hand the server
# everything the app of the published launcherApi gives it. See scripts/check-launcher-inputs.ts.
- name: Every recorded Desktop launch still starts this release's server
run: bun scripts/check-launcher-inputs.ts

# The API contract. api/openapi.yaml is the single source of truth every client is generated from,
# so four things are checked about it, each its own step so a red run names which:
Expand All @@ -63,15 +68,28 @@ jobs:
# base branch's spec with this one and fails on any breaking change, warnings included: a field a
# client reads going away is a warning to oasdiff and a broken screen to a person. A change that
# takes nothing from a client (a rule the server already enforced, now written in the spec) is
# listed with its reason in api/accepted-breaking-changes.md, and only that change passes.
# listed with its reason in api/accepted-breaking-changes.md, and only that change passes. Every
# deprecation names its sunset (`x-sunset`), at least 365 days after the change that deprecates
# it, and nothing is removed before its sunset;
# - it breaks nothing a client of a release it still serves relies on. The same comparison against
# the spec of every release of the last 12 months, and the last release's, on every run, so a
# string of changes each harmless against its own base cannot add up to a break for an app people
# already have, and a change let through as one no release serves is checked against what each
# release really serves;
# - the support window holds (scripts/support-window.ts): no oldest-app minimum cuts off an app
# released in the last 12 months, and every deprecation's sunset is at least 365 days after the
# release that first served it deprecated.
api:
name: API spec
runs-on: ubuntu-latest
env:
# Pinned with its checksum, from https://github.com/oasdiff/oasdiff/releases. The spec never
# leaves the runner: the binary runs here, rather than the action, which uploads by default.
OASDIFF_VERSION: 1.34.1
OASDIFF_SHA256: 75775f65b0adebd26a8e013af51a799342dfdc6262d89efa9e3b7bdf89657d90
OASDIFF_VERSION: 1.38.0
OASDIFF_SHA256: 613037fd6a1d3362a1b742d6d86c338c0eb5ab3511f4942ce3948e78720ea2da
# The deprecation window (API versioning design, section 4.3): a deprecated operation,
# parameter or property keeps answering for at least this long, whatever its stability level.
DEPRECATION_DAYS: 365
REDOCLY_TELEMETRY: "off"
REDOCLY_SUPPRESS_UPDATE_NOTICE: "true"
steps:
Expand Down Expand Up @@ -107,6 +125,13 @@ jobs:
echo "::error::A generated client (${generated[*]}) is not what api/openapi.yaml generates. Run bun run api:generate and commit the result."
exit 1
fi
- name: Install oasdiff
run: |
set -euo pipefail
archive="$RUNNER_TEMP/oasdiff.tar.gz"
curl -fsSL -o "$archive" "https://github.com/oasdiff/oasdiff/releases/download/v${OASDIFF_VERSION}/oasdiff_${OASDIFF_VERSION}_linux_amd64.tar.gz"
echo "${OASDIFF_SHA256} $archive" | sha256sum -c -
tar -xzf "$archive" -C "$RUNNER_TEMP" oasdiff
- name: No breaking change against the base branch
if: github.event_name == 'pull_request'
env:
Expand All @@ -119,16 +144,72 @@ jobs:
exit 0
fi
git show FETCH_HEAD:api/openapi.yaml > "$RUNNER_TEMP/base-openapi.yaml"
archive="$RUNNER_TEMP/oasdiff.tar.gz"
curl -fsSL -o "$archive" "https://github.com/oasdiff/oasdiff/releases/download/v${OASDIFF_VERSION}/oasdiff_${OASDIFF_VERSION}_linux_amd64.tar.gz"
echo "${OASDIFF_SHA256} $archive" | sha256sum -c -
tar -xzf "$archive" -C "$RUNNER_TEMP" oasdiff
# A change listed in api/accepted-breaking-changes.md, with its reason, is let through; oasdiff
# matches each line by method, path and the change's own words, so nothing else is.
accepted=api/accepted-breaking-changes.md
# A deprecation made here must name its sunset, DEPRECATION_DAYS or more from today, and a
# sunset may not move earlier than the date clients were given. Removing anything deprecated
# before its sunset fails whatever the flags.
deprecation=(--deprecation-days-stable "$DEPRECATION_DAYS" --deprecation-days-beta "$DEPRECATION_DAYS")
# Twice: once readable in the log, once as annotations on the pull request's diff.
"$RUNNER_TEMP/oasdiff" breaking "$RUNNER_TEMP/base-openapi.yaml" api/openapi.yaml --flatten-allof --err-ignore "$accepted" --warn-ignore "$accepted" || true
"$RUNNER_TEMP/oasdiff" breaking "$RUNNER_TEMP/base-openapi.yaml" api/openapi.yaml --flatten-allof --fail-on WARN --format githubactions --err-ignore "$accepted" --warn-ignore "$accepted"
"$RUNNER_TEMP/oasdiff" breaking "$RUNNER_TEMP/base-openapi.yaml" api/openapi.yaml --flatten-allof "${deprecation[@]}" --err-ignore "$accepted" --warn-ignore "$accepted" || true
"$RUNNER_TEMP/oasdiff" breaking "$RUNNER_TEMP/base-openapi.yaml" api/openapi.yaml --flatten-allof "${deprecation[@]}" --fail-on WARN --format githubactions --err-ignore "$accepted" --warn-ignore "$accepted"
# Release names and dates are the published GitHub releases', the day each reached people.
- name: The published releases
env:
GH_TOKEN: ${{ github.token }}
run: gh release list --repo "$GITHUB_REPOSITORY" --limit 1000 --exclude-drafts --json tagName,publishedAt,isPrerelease > "$RUNNER_TEMP/releases.json"
# The spec of every release whose apps this tree's server still serves (scripts/support-window.ts
# held-releases): each release of the last 12 months at or below this tree's version, and the
# last release even once it has aged out, so a fix on a release branch is held to its own line.
# Each release's apps were built from its own spec and call this server, so the spec is held to
# each, not only to the last: a release in between need not have served everything an older one
# did. A release with no api/openapi.yaml predates this API and has no client of it.
#
# A line in api/accepted-breaking-changes.md that lets a change through because no release
# serves it yet ("no release serves it") is not applied here: if a release does serve it, that
# reason was wrong, and this fails. Every other line is, since its reason holds for any client.
#
# The deprecation window is not counted here: oasdiff counts it from today, and a deprecation
# made after the release is new against it on every run until the next one. The base-branch run
# counts it on the day the deprecation is made; scripts/support-window.ts counts it from the
# release that first served it.
- name: No breaking change against any release whose apps are served
run: |
set -euo pipefail
held="$(bun scripts/support-window.ts held-releases --releases "$RUNNER_TEMP/releases.json")"
if [ -z "$held" ]; then
echo "::notice::No release at or below this tree's version yet, so there is no released spec to hold to."
exit 0
fi
accepted="$RUNNER_TEMP/accepted-against-release.md"
grep -v -F 'no release serves it' api/accepted-breaking-changes.md > "$accepted" || true
failed=()
mapfile -t releases <<< "$held"
# One fetch for every release, each under a ref of its own, so a tag this checkout already
# holds is never in the way.
refspecs=()
for release in "${releases[@]}"; do refspecs+=("+refs/tags/$release:refs/held-releases/$release"); done
git fetch --no-tags --depth=1 origin "${refspecs[@]}"
for release in "${releases[@]}"; do
if ! git cat-file -e "refs/held-releases/$release:api/openapi.yaml" 2>/dev/null; then
echo "$release has no api/openapi.yaml, so no client of it uses this API."
continue
fi
echo "::group::Holding api/openapi.yaml to $release's"
git show "refs/held-releases/$release:api/openapi.yaml" > "$RUNNER_TEMP/release-openapi.yaml"
"$RUNNER_TEMP/oasdiff" breaking "$RUNNER_TEMP/release-openapi.yaml" api/openapi.yaml --flatten-allof --err-ignore "$accepted" --warn-ignore "$accepted" || true
echo "::endgroup::"
if ! "$RUNNER_TEMP/oasdiff" breaking "$RUNNER_TEMP/release-openapi.yaml" api/openapi.yaml --flatten-allof --fail-on WARN --format githubactions --err-ignore "$accepted" --warn-ignore "$accepted"; then
failed+=("$release")
fi
done
if [ "${#failed[@]}" -gt 0 ]; then
echo "::error::api/openapi.yaml breaks a client of ${failed[*]}, whose apps this server still serves."
exit 1
fi
- name: The 12-month support window holds
run: bun scripts/support-window.ts check --releases "$RUNNER_TEMP/releases.json"
# The live channels (api/asyncapi.yaml). The differences come from the AsyncAPI CLI, pinned in
# api/asyncapi-tools with its own lockfile so only this job installs it; what counts as breaking
# is decided in api/asyncapi-diff.ts, whose tests run here against real edits to the file.
Expand Down Expand Up @@ -204,14 +285,24 @@ jobs:
# and paint resolve, and the app following the system's light or dark, which only a
# browser's `prefers-color-scheme` reports, with what OpenBot Desktop's window is told of
# it, and a sign-in through Composio held on OpenBot's own step for its countdown before it
# leaves, in this tab and in the new one a Bot's card opens. The
# leaves, in this tab and in the new one a Bot's card opens, and a picture over 8MB fetched
# only when it is opened, counted on the wire. The
# onboarding frame reads the generated app config, which `bun test` alone doesn't write (the
# test script's pretest does).
- run: |
bun run generate:app-config
bun test app/tests/tool-line-reduced-motion.test.tsx app/tests/onboarding-window-buttons.test.tsx app/tests/onboarding-orb-room.test.tsx app/tests/transcript-rail-clearance.test.tsx app/tests/a2ui-frame.test.tsx app/tests/update-banner-layout.test.tsx app/tests/composer-dictation-notice-layout.test.tsx app/tests/conversation-intro-halo.test.tsx app/tests/transcript-room.test.tsx app/tests/skins-window-buttons.test.tsx app/tests/opendots-rail-badge.test.tsx app/tests/account-version-layout.test.tsx app/tests/organization-menu-names.test.tsx app/tests/bot-orb-one-color.test.tsx app/tests/theme-follows-system.test.tsx app/tests/desktop-window-theme.test.tsx app/tests/bot-screen-record-layout.test.tsx app/tests/teams-screens-layout.test.tsx app/tests/team-grants-screens-layout.test.tsx app/tests/needs-you-board-layout.test.tsx app/tests/checkbox-contrast.test.tsx app/tests/maths-rendering.test.tsx app/tests/task-report-chip.test.tsx app/tests/consent-handoff.test.tsx
bun test app/tests/tool-line-reduced-motion.test.tsx app/tests/onboarding-window-buttons.test.tsx app/tests/onboarding-orb-room.test.tsx app/tests/transcript-rail-clearance.test.tsx app/tests/a2ui-frame.test.tsx app/tests/update-banner-layout.test.tsx app/tests/composer-dictation-notice-layout.test.tsx app/tests/conversation-intro-halo.test.tsx app/tests/transcript-room.test.tsx app/tests/skins-window-buttons.test.tsx app/tests/opendots-rail-badge.test.tsx app/tests/account-version-layout.test.tsx app/tests/organization-menu-names.test.tsx app/tests/bot-orb-one-color.test.tsx app/tests/theme-follows-system.test.tsx app/tests/desktop-window-theme.test.tsx app/tests/bot-screen-record-layout.test.tsx app/tests/teams-screens-layout.test.tsx app/tests/team-grants-screens-layout.test.tsx app/tests/needs-you-board-layout.test.tsx app/tests/checkbox-contrast.test.tsx app/tests/maths-rendering.test.tsx app/tests/task-report-chip.test.tsx app/tests/consent-handoff.test.tsx app/tests/large-picture-tile.test.tsx
env:
OPENBOT_APP_BROWSER: '1'
# Dictation in the Desktop window on a Mac whose recognizer has no English (United Kingdom) on
# the device, in Chromium and in WebKit, the engine the Mac window draws with: it listens in the
# next language the recognizer has, or says which language to add and where. The page's
# language and its names for languages are the engine's own.
- run: bunx playwright-core install --with-deps webkit
- run: bun test app/tests/composer-dictation-language.test.tsx
env:
OPENBOT_APP_BROWSER: '1'
OPENBOT_APP_ENGINES: chromium,webkit
# The desktop setup window's, for the same reason: the AI step's form holding still while the
# install behind it comes and goes. It bundles the window from the desktop's own dependencies.
- run: bun install --frozen-lockfile
Expand Down Expand Up @@ -329,6 +420,25 @@ jobs:
- run: bun install --frozen-lockfile
- run: bun test app/tests/build-cache.test.ts

# The TypeScript LangGraph engine, the default Bot engine: its type check and its own tests, on the
# Node it ships on, from its own lockfile, as each Python harness below runs its own.
langgraph-ts:
name: typescript langgraph engine
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
with:
node-version: "22"
- run: npm ci
working-directory: agent-langgraph-ts
- run: npm run typecheck
working-directory: agent-langgraph-ts
- run: npm test
working-directory: agent-langgraph-ts

python-harness:
name: python harness regressions
# CPU-bound: runs on a 16-core larger runner (org runner group openbot-larger, billed per
Expand Down Expand Up @@ -521,7 +631,7 @@ jobs:
name: verify
runs-on: ubuntu-latest
if: always()
needs: [static, api, mobile, app-browser, test, test-total, startup, python-harness, build, component-dockerfiles]
needs: [static, api, mobile, app-browser, test, test-total, startup, langgraph-ts, python-harness, build, component-dockerfiles]
steps:
- name: Require every check
env:
Expand Down
7 changes: 7 additions & 0 deletions .github/workflows/desktop-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,13 @@ jobs:
if: matrix.platform == 'linux'
run: cargo test --locked --lib update_ready::live -- --ignored --test-threads=1
working-directory: desktop/src-tauri
# The AI connection changed in the app, on the runner's Docker with this tree's Compose file:
# a plan's engine starts alone and stops alone, the picked Bot restarts alone, and the
# database never stops.
- name: AI connection change regression tests
if: matrix.platform == 'linux'
run: cargo test --locked --lib ai_connection::tests::real_engine -- --ignored --test-threads=1
working-directory: desktop/src-tauri
# OpenBot's machine on Windows shares one network namespace with every WSL distro, so a
# stopped machine's port rules outlive it. Reproduced on real netavark, both generations
# Podman runs on WSL, in a privileged lab on the runner's Docker, then cleared.
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/desktop-macos-signing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@ jobs:
scripts/publish-signed-windows.test.ts scripts/signing-workflows.test.ts
scripts/sign-windows-update.test.ts
../scripts/release-latest.test.ts ../scripts/release-download-names.test.ts
../scripts/downloads-sync.test.ts scripts/release-cli-bundle.test.ts
../scripts/downloads-sync.test.ts ../scripts/release-older-installers.test.ts
scripts/release-cli-bundle.test.ts
scripts/verify-mac-arch.test.ts scripts/staple-with-retry.test.ts
working-directory: desktop
- name: Importing the Developer ID intermediate twice succeeds
Expand Down
Loading
Loading