ci: test twenty-apps install against latest dockerhub and local server + new trigger (#22636)
## Why App installability can silently regress from two directions, and today CI only covers one of them: 1. A **server** change (about to merge from the monorepo) breaks the ability to install the **current public apps** — a backward-compatibility regression users would hit on upgrade. 2. An **app** change breaks against a server **built from the current monorepo files** (not just the last published image), so the app and the upcoming server drift apart before either ships. Both are compatibility guarantees between the server and the app catalog. Today they are only tested from the app side, against the latest published image. This PR makes CI enforce the contract from both sides: - Any server PR must keep **every** current public app installable. - Any app PR is exercised against both the **released** server (its integration suite — what users run today) and the **upcoming** (monorepo) server (integration plus deploy + install). ## What Shared building blocks so both CIs exercise the same paths instead of duplicating them: - **`spawn-twenty-server`** (composite action) — returns a running server (`server-url` + `api-key`) from either the latest published Docker Hub image or a server built from the monorepo. Both sources expose the same contract, so callers never branch on how the server came up. - **`test-twenty-app`** (composite action) — exercises one app against a given server, delegating deploy + install to the shared `deploy-twenty-app` / `install-twenty-app` actions. - **`discover-apps`** (reusable workflow) — the single source of truth for the app matrix. Parameterized by `scope` (`public` vs `internal-and-public`) and `changed-only`, so both CIs derive their matrix from the filesystem instead of a hand-maintained list. Discovery stays automatic: a newly added public app is picked up with no CI edit, which is what keeps the "every public app" guarantee honest. Wired in: - **CI Server** gains a `server-apps-install-smoke` matrix that installs every public app (`discover-apps` with `scope: public, changed-only: false`) against the about-to-merge server, gated in `ci-server-status-check` so a regression blocks merge. - **CI Twenty Apps** discovers changed apps (`scope: internal-and-public, changed-only: true`) and runs each against both server sources — the released image and the monorepo build. ## Why the coverage differs per side (not "always everything") `test-twenty-app` has three explicit modes — `installation-and-integration-test` (integration + deploy + install), `integration-test-only` (suite only), `installation-only` (deploy + install only) — because the useful signal depends on what actually changed: - **App PR against the monorepo server → `installation-and-integration-test`.** The app changed, so run its whole suite against the upcoming server, install included. - **App PR against the released server → `integration-test-only`.** Checks the app's own suite against what users run today; install against the released image is left to the SDK e2e path. - **Server PR → `installation-only`, across all apps.** The apps did not change; the only question is "can each one still be installed." Running every app's full integration suite on every server PR would be far slower and largely redundant. Installation-only keeps this broad (the whole catalog) and cheap enough to always run and block merge. The tradeoff is deliberate: broad but shallow where nothing in the app changed, deep where it did. ## Notes / trade-offs - On app-only PRs the `local` source pays a full server build per app (the `server-build` cache is only warm on server PRs). Could be optimized later with a shared warm-up job. - SDK-local (Verdaccio) install testing stays in `ci-create-app-e2e-minimal`; this PR's `local` source targets the server build. <a href="https://cubic.dev/pr/twentyhq/twenty/pull/22636?utm_source=github" rel="nofollow noreferrer noopener" target="_blank">``<img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg">``</a>
This commit is contained in:
Paul Rastoin
@@ -40,7 +40,7 @@ runs:
|
||||
const fs = require('fs'), path = require('path'), os = require('os');
|
||||
fs.writeFileSync(path.join(os.homedir(), '.twenty', 'config.json'), JSON.stringify({
|
||||
version: 1,
|
||||
remotes: { target: { apiUrl: process.env.API_URL, apiKey: process.env.API_KEY } }
|
||||
remotes: { target: { apiUrl: process.env.API_URL, apiKey: process.env.API_KEY, accessToken: process.env.API_KEY } }
|
||||
}, null, 2));
|
||||
"
|
||||
env:
|
||||
|
||||
@@ -40,7 +40,7 @@ runs:
|
||||
const fs = require('fs'), path = require('path'), os = require('os');
|
||||
fs.writeFileSync(path.join(os.homedir(), '.twenty', 'config.json'), JSON.stringify({
|
||||
version: 1,
|
||||
remotes: { target: { apiUrl: process.env.API_URL, apiKey: process.env.API_KEY } }
|
||||
remotes: { target: { apiUrl: process.env.API_URL, apiKey: process.env.API_KEY, accessToken: process.env.API_KEY } }
|
||||
}, null, 2));
|
||||
"
|
||||
env:
|
||||
|
||||
@@ -0,0 +1,124 @@
|
||||
name: Spawn Twenty Server
|
||||
description: >
|
||||
Provisions a running Twenty server and returns its URL + API key, from one of
|
||||
two sources:
|
||||
- dockerhub-latest: the latest published twentycrm/twenty-app-dev image
|
||||
(delegates to spawn-twenty-app-dev-test, port 2021).
|
||||
- local: a server built from the monorepo's current files (port 3000). It
|
||||
brings up its own postgres + redis via docker, so it works inside any job
|
||||
without declaring job-level services.
|
||||
Both sources expose the same server-url / api-key contract so callers never
|
||||
branch on how the server came up.
|
||||
|
||||
inputs:
|
||||
source:
|
||||
description: 'Where the server comes from: "dockerhub-latest" or "local".'
|
||||
required: false
|
||||
default: 'local'
|
||||
twenty-version:
|
||||
description: 'Docker Hub image tag, only used when source is "dockerhub-latest".'
|
||||
required: false
|
||||
default: 'latest'
|
||||
server-build-cache-key:
|
||||
description: 'Cache key used to speed up the local server build (nx cache).'
|
||||
required: false
|
||||
default: 'server-build'
|
||||
|
||||
outputs:
|
||||
server-url:
|
||||
description: 'URL where the Twenty server can be reached'
|
||||
value: ${{ steps.resolve.outputs.server-url }}
|
||||
api-key:
|
||||
description: 'API key (or access token) for the seeded workspace'
|
||||
value: ${{ steps.resolve.outputs.api-key }}
|
||||
|
||||
runs:
|
||||
using: 'composite'
|
||||
steps:
|
||||
- name: Spawn from Docker Hub image
|
||||
id: dockerhub
|
||||
if: inputs.source == 'dockerhub-latest'
|
||||
uses: ./.github/actions/spawn-twenty-app-dev-test
|
||||
with:
|
||||
twenty-version: ${{ inputs.twenty-version }}
|
||||
|
||||
- name: Start postgres and redis
|
||||
if: inputs.source == 'local'
|
||||
shell: bash
|
||||
run: |
|
||||
docker run -d --name twenty-postgres \
|
||||
-e POSTGRES_USER=postgres \
|
||||
-e POSTGRES_PASSWORD=postgres \
|
||||
-p 5432:5432 \
|
||||
postgres:18
|
||||
docker run -d --name twenty-redis -p 6379:6379 redis
|
||||
|
||||
echo "Waiting for postgres…"
|
||||
for i in {1..30}; do
|
||||
if PGPASSWORD=postgres pg_isready -h localhost -p 5432 -U postgres > /dev/null 2>&1; then
|
||||
echo "Postgres ready"
|
||||
break
|
||||
fi
|
||||
sleep 2
|
||||
if [ "$i" -eq 30 ]; then
|
||||
echo "::error::Postgres did not become ready in time"
|
||||
docker logs twenty-postgres 2>&1 | tail -40
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
- name: Install dependencies
|
||||
if: inputs.source == 'local'
|
||||
uses: ./.github/actions/yarn-install
|
||||
|
||||
- name: Restore server build cache
|
||||
if: inputs.source == 'local'
|
||||
uses: ./.github/actions/restore-cache
|
||||
with:
|
||||
key: ${{ inputs.server-build-cache-key }}
|
||||
|
||||
- name: Build server from monorepo
|
||||
if: inputs.source == 'local'
|
||||
shell: bash
|
||||
run: |
|
||||
npx nx build twenty-shared
|
||||
npx nx build twenty-server
|
||||
|
||||
- name: Write server env and create databases
|
||||
if: inputs.source == 'local'
|
||||
shell: bash
|
||||
run: |
|
||||
npx nx reset:env:e2e-testing-server twenty-server
|
||||
PGPASSWORD=postgres psql -h localhost -p 5432 -U postgres -d postgres -c 'CREATE DATABASE "default";'
|
||||
PGPASSWORD=postgres psql -h localhost -p 5432 -U postgres -d postgres -c 'CREATE DATABASE "test";'
|
||||
npx nx run twenty-server:database:reset
|
||||
|
||||
- name: Start server
|
||||
if: inputs.source == 'local'
|
||||
shell: bash
|
||||
run: nohup npx nx start:ci twenty-server &
|
||||
|
||||
- name: Wait for server to be ready
|
||||
if: inputs.source == 'local'
|
||||
shell: bash
|
||||
run: npx wait-on http://localhost:3000/healthz --timeout 180000 --interval 1000
|
||||
|
||||
- name: Resolve server url and api key
|
||||
id: resolve
|
||||
shell: bash
|
||||
env:
|
||||
SOURCE: ${{ inputs.source }}
|
||||
DOCKERHUB_URL: ${{ steps.dockerhub.outputs.server-url }}
|
||||
DOCKERHUB_KEY: ${{ steps.dockerhub.outputs.api-key }}
|
||||
LOCAL_KEY: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIyMDIwMjAyMC1lNmI1LTQ2ODAtOGEzMi1iODIwOTczNzE1NmIiLCJ1c2VySWQiOiIyMDIwMjAyMC1lNmI1LTQ2ODAtOGEzMi1iODIwOTczNzE1NmIiLCJ3b3Jrc3BhY2VJZCI6IjIwMjAyMDIwLTFjMjUtNGQwMi1iZjI1LTZhZWNjZjdlYTQxOSIsIndvcmtzcGFjZU1lbWJlcklkIjoiMjAyMDIwMjAtNDYzZi00MzViLTgyOGMtMTA3ZTAwN2EyNzExIiwidXNlcldvcmtzcGFjZUlkIjoiMjAyMDIwMjAtMWU3Yy00M2Q5LWE1ZGItNjg1YjUwNjlkODE2IiwidHlwZSI6IkFDQ0VTUyIsImF1dGhQcm92aWRlciI6InBhc3N3b3JkIiwiaWF0IjoxNzUxMjgxNzA0LCJleHAiOjIwNjY4NTc3MDR9.HMGqCsVlOAPVUBhKSGlD1X86VoHKt4LIUtET3CGIdik
|
||||
run: |
|
||||
if [ "$SOURCE" = "dockerhub-latest" ]; then
|
||||
echo "server-url=$DOCKERHUB_URL" >> "$GITHUB_OUTPUT"
|
||||
echo "api-key=$DOCKERHUB_KEY" >> "$GITHUB_OUTPUT"
|
||||
elif [ "$SOURCE" = "local" ]; then
|
||||
echo "server-url=http://localhost:3000" >> "$GITHUB_OUTPUT"
|
||||
echo "api-key=$LOCAL_KEY" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "::error::Unknown source '$SOURCE' (expected 'dockerhub-latest' or 'local')"
|
||||
exit 1
|
||||
fi
|
||||
@@ -0,0 +1,85 @@
|
||||
name: Test Twenty App
|
||||
description: >
|
||||
Exercises a single Twenty app against an already-running server. In
|
||||
"installation-and-integration-test" mode it runs the app's integration suite,
|
||||
then deploys and installs the app. In "installation-only" mode it only deploys
|
||||
and installs, which is enough to catch server-side install regressions without
|
||||
paying for each app's full test suite.
|
||||
|
||||
inputs:
|
||||
api-url:
|
||||
description: Base URL of the target Twenty instance
|
||||
required: true
|
||||
api-key:
|
||||
description: API key or access token for the target workspace
|
||||
required: true
|
||||
app-path:
|
||||
description: Path to the app directory (relative to repo root)
|
||||
required: true
|
||||
mode:
|
||||
description: >
|
||||
What to run: "installation-and-integration-test" (integration + deploy +
|
||||
install), "integration-test-only" (integration suite only) or
|
||||
"installation-only" (deploy + install only).
|
||||
required: false
|
||||
default: 'installation-and-integration-test'
|
||||
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- name: Validate mode
|
||||
shell: bash
|
||||
env:
|
||||
MODE: ${{ inputs.mode }}
|
||||
run: |
|
||||
case "$MODE" in
|
||||
installation-and-integration-test|integration-test-only|installation-only) ;;
|
||||
*)
|
||||
echo "::error::Unknown mode '$MODE' (expected 'installation-and-integration-test', 'integration-test-only' or 'installation-only')"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
- name: Enable Corepack
|
||||
if: inputs.mode == 'installation-and-integration-test' || inputs.mode == 'integration-test-only'
|
||||
shell: bash
|
||||
run: corepack enable
|
||||
|
||||
- name: Setup Node.js
|
||||
if: inputs.mode == 'installation-and-integration-test' || inputs.mode == 'integration-test-only'
|
||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||
with:
|
||||
node-version-file: '${{ inputs.app-path }}/.nvmrc'
|
||||
cache: yarn
|
||||
cache-dependency-path: '${{ inputs.app-path }}/yarn.lock'
|
||||
|
||||
- name: Install dependencies
|
||||
if: inputs.mode == 'installation-and-integration-test' || inputs.mode == 'integration-test-only'
|
||||
shell: bash
|
||||
working-directory: ${{ inputs.app-path }}
|
||||
run: yarn install --immutable
|
||||
|
||||
- name: Integration tests
|
||||
if: inputs.mode == 'installation-and-integration-test' || inputs.mode == 'integration-test-only'
|
||||
shell: bash
|
||||
working-directory: ${{ inputs.app-path }}
|
||||
env:
|
||||
TWENTY_API_URL: ${{ inputs.api-url }}
|
||||
TWENTY_API_KEY: ${{ inputs.api-key }}
|
||||
run: yarn test
|
||||
|
||||
- name: Deploy app
|
||||
if: inputs.mode == 'installation-and-integration-test' || inputs.mode == 'installation-only'
|
||||
uses: ./.github/actions/deploy-twenty-app
|
||||
with:
|
||||
api-url: ${{ inputs.api-url }}
|
||||
api-key: ${{ inputs.api-key }}
|
||||
app-path: ${{ inputs.app-path }}
|
||||
|
||||
- name: Install app
|
||||
if: inputs.mode == 'installation-and-integration-test' || inputs.mode == 'installation-only'
|
||||
uses: ./.github/actions/install-twenty-app
|
||||
with:
|
||||
api-url: ${{ inputs.api-url }}
|
||||
api-key: ${{ inputs.api-key }}
|
||||
app-path: ${{ inputs.app-path }}
|
||||
Reference in New Issue
Block a user