mirror of
https://github.com/twentyhq/twenty
synced 2026-04-21 21:47:38 +00:00
## Summary
### Externalize `twenty-client-sdk` from `twenty-sdk`
Previously, `twenty-client-sdk` was listed as a `devDependency` of
`twenty-sdk`, which caused Vite to bundle it inline into the dist
output. This meant end-user apps had two copies of `twenty-client-sdk`:
one hidden inside `twenty-sdk`'s bundle, and one installed explicitly in
their `node_modules`. These copies could drift apart since they weren't
guaranteed to be the same version.
**Change:** Moved `twenty-client-sdk` from `devDependencies` to
`dependencies` in `twenty-sdk/package.json`. Vite's `external` function
now recognizes it and keeps it as an external `require`/`import` in the
dist output. End users get a single deduplicated copy resolved by their
package manager.
### Externalize `twenty-sdk` from `create-twenty-app`
Similarly, `create-twenty-app` had `twenty-sdk` as a `devDependency`
(bundled inline). After refactoring `create-twenty-app` to
programmatically import operations from `twenty-sdk` (instead of
shelling out via `execSync`), it became a proper runtime dependency.
**Change:** Moved `twenty-sdk` from `devDependencies` to `dependencies`
in `create-twenty-app/package.json`.
### Switch E2E CI to `yarn npm publish`
The `workspace:*` protocol in `dependencies` is a Yarn-specific feature.
`npm publish` publishes it as-is (which breaks for consumers), while
`yarn npm publish` automatically replaces `workspace:*` with the
resolved version at publish time (e.g., `workspace:*` becomes `=1.2.3`).
**Change:** Replaced `npm publish` with `yarn npm publish` in
`.github/workflows/ci-create-app-e2e.yaml`.
### Replace `execSync` with programmatic SDK calls in
`create-twenty-app`
`create-twenty-app` was shelling out to `yarn twenty remote add` and
`yarn twenty server start` via `execSync`, which assumed the `twenty`
binary was already installed in the scaffolded app. This was fragile and
created an implicit circular dependency.
**Changes:**
- Replaced `execSync('yarn twenty remote add ...')` with a direct call
to `authLoginOAuth()` from `twenty-sdk/cli`
- Replaced `execSync('yarn twenty server start')` with a direct call to
`serverStart()` from `twenty-sdk/cli`
- Deleted the duplicated `setup-local-instance.ts` from
`create-twenty-app`
### Centralize `serverStart` as a dedicated operation
The Docker server start logic was previously inline in the `server
start` CLI command handler (`server.ts`), and `setup-local-instance.ts`
was shelling out to `yarn twenty server start` to invoke it -- meaning
`twenty-sdk` was calling itself via a child process.
**Changes:**
- Extracted the Docker container management logic into a new
`serverStart` operation (`cli/operations/server-start.ts`)
- Merged the detect-or-start flow from `setup-local-instance.ts` into
`serverStart` (detect across multiple ports, start Docker if needed,
poll for health)
- Deleted `setup-local-instance.ts` from `twenty-sdk`
- Added `onProgress` callback (consistent with other operations like
`appBuild`) instead of direct `console.log` calls
- Both the `server start` CLI command and `create-twenty-app` now call
`serverStart()` programmatically
related to https://github.com/twentyhq/twenty-infra/pull/525
202 lines
7.1 KiB
YAML
202 lines
7.1 KiB
YAML
name: CI Create App E2E
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
pull_request:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
|
|
|
|
jobs:
|
|
changed-files-check:
|
|
uses: ./.github/workflows/changed-files.yaml
|
|
with:
|
|
files: |
|
|
packages/create-twenty-app/**
|
|
packages/twenty-sdk/**
|
|
packages/twenty-client-sdk/**
|
|
packages/twenty-shared/**
|
|
packages/twenty-server/**
|
|
!packages/create-twenty-app/package.json
|
|
!packages/twenty-sdk/package.json
|
|
!packages/twenty-client-sdk/package.json
|
|
!packages/twenty-shared/package.json
|
|
!packages/twenty-server/package.json
|
|
create-app-e2e:
|
|
needs: changed-files-check
|
|
if: needs.changed-files-check.outputs.any_changed == 'true'
|
|
timeout-minutes: 30
|
|
runs-on: ubuntu-latest-4-cores
|
|
services:
|
|
postgres:
|
|
image: twentycrm/twenty-postgres-spilo
|
|
env:
|
|
PGUSER_SUPERUSER: postgres
|
|
PGPASSWORD_SUPERUSER: postgres
|
|
ALLOW_NOSSL: 'true'
|
|
SPILO_PROVIDER: 'local'
|
|
ports:
|
|
- 5432:5432
|
|
options: >-
|
|
--health-cmd pg_isready
|
|
--health-interval 10s
|
|
--health-timeout 5s
|
|
--health-retries 5
|
|
redis:
|
|
image: redis
|
|
ports:
|
|
- 6379:6379
|
|
env:
|
|
PUBLISHABLE_PACKAGES: twenty-client-sdk twenty-sdk create-twenty-app
|
|
steps:
|
|
- name: Fetch custom Github Actions and base branch history
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 10
|
|
|
|
- name: Install dependencies
|
|
uses: ./.github/actions/yarn-install
|
|
|
|
- name: Set CI version and prepare packages for publish
|
|
run: |
|
|
CI_VERSION="0.0.0-ci.$(date +%s)"
|
|
echo "CI_VERSION=$CI_VERSION" >> $GITHUB_ENV
|
|
npx nx run-many -t set-local-version -p $PUBLISHABLE_PACKAGES --releaseVersion=$CI_VERSION
|
|
|
|
- name: Build packages
|
|
run: |
|
|
for pkg in $PUBLISHABLE_PACKAGES; do
|
|
npx nx build $pkg
|
|
done
|
|
|
|
- name: Install and start Verdaccio
|
|
run: |
|
|
npx verdaccio --config .github/verdaccio-config.yaml &
|
|
|
|
for i in $(seq 1 30); do
|
|
if curl -s http://localhost:4873 > /dev/null 2>&1; then
|
|
echo "Verdaccio is ready"
|
|
break
|
|
fi
|
|
echo "Waiting for Verdaccio... ($i/30)"
|
|
sleep 1
|
|
done
|
|
|
|
- name: Publish packages to local registry
|
|
run: |
|
|
yarn config set npmRegistryServer http://localhost:4873
|
|
yarn config set unsafeHttpWhitelist --json '["localhost"]'
|
|
yarn config set npmAuthToken ci-auth-token
|
|
|
|
for pkg in $PUBLISHABLE_PACKAGES; do
|
|
cd packages/$pkg
|
|
yarn npm publish --tag ci
|
|
cd ../..
|
|
done
|
|
|
|
- name: Scaffold app using published create-twenty-app
|
|
run: |
|
|
npm install -g create-twenty-app@$CI_VERSION --registry http://localhost:4873
|
|
create-twenty-app --version
|
|
mkdir -p /tmp/e2e-test-workspace
|
|
cd /tmp/e2e-test-workspace
|
|
create-twenty-app test-app --exhaustive --display-name "Test App" --description "E2E test app" --skip-local-instance
|
|
|
|
- name: Install scaffolded app dependencies
|
|
run: |
|
|
cd /tmp/e2e-test-workspace/test-app
|
|
echo 'npmRegistryServer: "http://localhost:4873"' >> .yarnrc.yml
|
|
echo 'unsafeHttpWhitelist: ["localhost"]' >> .yarnrc.yml
|
|
YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install --no-immutable
|
|
|
|
- name: Verify installed app versions
|
|
run: |
|
|
cd /tmp/e2e-test-workspace/test-app
|
|
echo "--- Checking package.json references correct SDK version ---"
|
|
node -e "
|
|
const pkg = require('./package.json');
|
|
const sdkVersion = pkg.devDependencies['twenty-sdk'];
|
|
if (!sdkVersion.startsWith('0.0.0-ci.')) {
|
|
console.error('Expected twenty-sdk version to start with 0.0.0-ci., got:', sdkVersion);
|
|
process.exit(1);
|
|
}
|
|
console.log('SDK version in scaffolded app:', sdkVersion);
|
|
"
|
|
|
|
- name: Verify SDK CLI is available
|
|
run: |
|
|
cd /tmp/e2e-test-workspace/test-app
|
|
npx --no-install twenty --version
|
|
|
|
- name: Setup server environment
|
|
run: npx nx reset:env:e2e-testing-server twenty-server
|
|
|
|
- name: Build server
|
|
run: npx nx build twenty-server
|
|
|
|
- name: Create and setup database
|
|
run: |
|
|
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
|
|
run: |
|
|
npx nx start twenty-server &
|
|
echo "Waiting for server to be ready..."
|
|
timeout 60 bash -c 'until curl -s http://localhost:3000/health; do sleep 2; done'
|
|
|
|
- name: Authenticate with twenty-server
|
|
env:
|
|
SEED_API_KEY: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIyMDIwMjAyMC1lNmI1LTQ2ODAtOGEzMi1iODIwOTczNzE1NmIiLCJ1c2VySWQiOiIyMDIwMjAyMC1lNmI1LTQ2ODAtOGEzMi1iODIwOTczNzE1NmIiLCJ3b3Jrc3BhY2VJZCI6IjIwMjAyMDIwLTFjMjUtNGQwMi1iZjI1LTZhZWNjZjdlYTQxOSIsIndvcmtzcGFjZU1lbWJlcklkIjoiMjAyMDIwMjAtNDYzZi00MzViLTgyOGMtMTA3ZTAwN2EyNzExIiwidXNlcldvcmtzcGFjZUlkIjoiMjAyMDIwMjAtMWU3Yy00M2Q5LWE1ZGItNjg1YjUwNjlkODE2IiwidHlwZSI6IkFDQ0VTUyIsImF1dGhQcm92aWRlciI6InBhc3N3b3JkIiwiaWF0IjoxNzUxMjgxNzA0LCJleHAiOjIwNjY4NTc3MDR9.HMGqCsVlOAPVUBhKSGlD1X86VoHKt4LIUtET3CGIdik'
|
|
run: |
|
|
cd /tmp/e2e-test-workspace/test-app
|
|
npx --no-install twenty remote add --token $SEED_API_KEY --url http://localhost:3000
|
|
|
|
- name: Deploy scaffolded app
|
|
run: |
|
|
cd /tmp/e2e-test-workspace/test-app
|
|
npx --no-install twenty deploy
|
|
|
|
- name: Install scaffolded app
|
|
run: |
|
|
cd /tmp/e2e-test-workspace/test-app
|
|
npx --no-install twenty install
|
|
|
|
- name: Execute hello-world logic function
|
|
run: |
|
|
cd /tmp/e2e-test-workspace/test-app
|
|
EXEC_OUTPUT=$(npx --no-install twenty exec --functionName hello-world-logic-function)
|
|
echo "$EXEC_OUTPUT"
|
|
echo "$EXEC_OUTPUT" | grep -q "Hello, World!"
|
|
|
|
- name: Execute create-hello-world-company logic function
|
|
run: |
|
|
cd /tmp/e2e-test-workspace/test-app
|
|
EXEC_OUTPUT=$(npx --no-install twenty exec --functionName create-hello-world-company)
|
|
echo "$EXEC_OUTPUT"
|
|
echo "$EXEC_OUTPUT" | grep -q "Created company"
|
|
|
|
- name: Run scaffolded app integration test
|
|
env:
|
|
TWENTY_API_URL: http://localhost:3000
|
|
run: |
|
|
cd /tmp/e2e-test-workspace/test-app
|
|
yarn test
|
|
|
|
ci-create-app-e2e-status-check:
|
|
if: always() && !cancelled()
|
|
timeout-minutes: 5
|
|
runs-on: ubuntu-latest
|
|
needs: [changed-files-check, create-app-e2e]
|
|
steps:
|
|
- name: Fail job if any needs failed
|
|
if: contains(needs.*.result, 'failure')
|
|
run: exit 1
|