Create twenty app e2e test ci (#18497)

# Introduction
Verifies whole following flow:
- Create and sdk app build and publication
- Global create-twenty-app installation
- Creating an app
- installing app dependencies
- auth:login
- app:build
- function:execute
- Running successfully auto-generated integration tests

## Create twenty app options refactor
Allow having a flow that do not require any prompt

.github/verdaccio-config.yaml

@@ -0,0 +1,19 @@
+storage: /tmp/verdaccio-storage
+auth:
+  htpasswd:
+    file: /tmp/verdaccio-htpasswd
+    max_users: 100
+uplinks:
+  npmjs:
+    url: https://registry.npmjs.org/
+packages:
+  'twenty-sdk':
+    access: $all
+    publish: $all
+  'create-twenty-app':
+    access: $all
+    publish: $all
+  '**':
+    access: $all
+    proxy: npmjs
+log: { type: stdout, format: pretty, level: warn }

.github/workflows/ci-create-app-e2e.yaml

@@ -0,0 +1,182 @@
+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-shared/**
+        packages/twenty-server/**
+        !packages/create-twenty-app/package.json
+        !packages/twenty-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
+    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 twenty-sdk create-twenty-app --releaseVersion=$CI_VERSION
+
+      - name: Build packages
+        run: |
+          npx nx build twenty-sdk
+          npx nx build create-twenty-app
+
+      - 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: |
+          npm set //localhost:4873/:_authToken "ci-auth-token"
+
+          for pkg in twenty-sdk create-twenty-app; do
+            cd packages/$pkg
+            npm publish --registry http://localhost:4873 --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"
+
+      - 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 auth:login --api-key $SEED_API_KEY --api-url http://localhost:3000
+
+      - name: Build scaffolded app
+        run: |
+          cd /tmp/e2e-test-workspace/test-app
+          npx --no-install twenty app:build
+          test -d .twenty/output
+
+      - name: Execute hello-world logic function
+        run: |
+          cd /tmp/e2e-test-workspace/test-app
+          EXEC_OUTPUT=$(npx --no-install twenty function:execute --functionName hello-world-logic-function)
+          echo "$EXEC_OUTPUT"
+          echo "$EXEC_OUTPUT" | grep -q "Hello, World!"
+
+      - name: Run scaffolded app integration test
+        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

nx.json

@@ -136,6 +136,14 @@
       "cache": true,
       "dependsOn": ["^build"]
     },
+    "set-local-version": {
+      "executor": "nx:run-commands",
+      "cache": false,
+      "options": {
+        "cwd": "{projectRoot}",
+        "command": "npm pkg set version={args.releaseVersion}"
+      }
+    },
     "storybook:build": {
       "executor": "nx:run-commands",
       "cache": true,

package.json

@@ -164,6 +164,7 @@
     "tsc-alias": "^1.8.16",
     "tsconfig-paths": "^4.2.0",
     "tsx": "^4.17.0",
+    "verdaccio": "^6.3.1",
     "vite": "^7.0.0",
     "vitest": "^4.0.18"
   },

packages/create-twenty-app/project.json

@@ -24,6 +24,7 @@
         "command": "node dist/cli.cjs"
       }
     },
+    "set-local-version": {},
     "typecheck": {},
     "lint": {},
     "test": {

packages/create-twenty-app/src/cli.ts

@@ -18,6 +18,15 @@ const program = new Command(packageJson.name)
     '-m, --minimal',
     'Create only core entities (application-config and default-role)',
   )
+  .option('-n, --name <name>', 'Application name (skips prompt)')
+  .option(
+    '-d, --display-name <displayName>',
+    'Application display name (skips prompt)',
+  )
+  .option(
+    '--description <description>',
+    'Application description (skips prompt)',
+  )
   .helpOption('-h, --help', 'Display this help message.')
   .action(
     async (
@@ -25,6 +34,9 @@ const program = new Command(packageJson.name)
       options?: {
         exhaustive?: boolean;
         minimal?: boolean;
+        name?: string;
+        displayName?: string;
+        description?: string;
       },
     ) => {
       const modeFlags = [options?.exhaustive, options?.minimal].filter(Boolean);
@@ -47,9 +59,20 @@ const program = new Command(packageJson.name)
         process.exit(1);
       }
 
+      if (options?.name !== undefined && options.name.trim().length === 0) {
+        console.error(chalk.red('Error: --name cannot be empty.'));
+        process.exit(1);
+      }
+
       const mode: ScaffoldingMode = options?.minimal ? 'minimal' : 'exhaustive';
 
-      await new CreateAppCommand().execute(directory, mode);
+      await new CreateAppCommand().execute({
+        directory,
+        mode,
+        name: options?.name,
+        displayName: options?.displayName,
+        description: options?.description,
+      });
     },
   );
 

packages/create-twenty-app/src/create-app.command.ts

@@ -7,6 +7,7 @@ import * as fs from 'fs-extra';
 import inquirer from 'inquirer';
 import kebabCase from 'lodash.kebabcase';
 import * as path from 'path';
+import { isDefined } from 'twenty-shared/utils';
 
 import {
   type ExampleOptions,
@@ -15,16 +16,23 @@ import {
 
 const CURRENT_EXECUTION_DIRECTORY = process.env.INIT_CWD || process.cwd();
 
+type CreateAppOptions = {
+  directory?: string;
+  mode?: ScaffoldingMode;
+  name?: string;
+  displayName?: string;
+  description?: string;
+};
+
 export class CreateAppCommand {
-  async execute(
-    directory?: string,
-    mode: ScaffoldingMode = 'exhaustive',
-  ): Promise<void> {
+  async execute(options: CreateAppOptions = {}): Promise<void> {
     try {
       const { appName, appDisplayName, appDirectory, appDescription } =
-        await this.getAppInfos(directory);
+        await this.getAppInfos(options);
 
-      const exampleOptions = this.resolveExampleOptions(mode);
+      const exampleOptions = this.resolveExampleOptions(
+        options.mode ?? 'exhaustive',
+      );
 
       await this.validateDirectory(appDirectory);
 
@@ -54,19 +62,25 @@ export class CreateAppCommand {
     }
   }
 
-  private async getAppInfos(directory?: string): Promise<{
+  private async getAppInfos(options: CreateAppOptions): Promise<{
     appName: string;
     appDisplayName: string;
     appDescription: string;
     appDirectory: string;
   }> {
+    const { directory } = options;
+
+    const hasName = isDefined(options.name) || isDefined(directory);
+    const hasDisplayName = isDefined(options.displayName);
+    const hasDescription = isDefined(options.description);
+
     const { name, displayName, description } = await inquirer.prompt([
       {
         type: 'input',
         name: 'name',
         message: 'Application name:',
-        when: () => !directory,
-        default: 'my-awesome-app',
+        when: () => !hasName,
+        default: 'my-twenty-app',
         validate: (input) => {
           if (input.length === 0) return 'Application name is required';
           return true;
@@ -76,25 +90,33 @@ export class CreateAppCommand {
         type: 'input',
         name: 'displayName',
         message: 'Application display name:',
-        default: (answers: any) => {
-          return convertToLabel(answers?.name ?? directory);
+        when: () => !hasDisplayName,
+        default: (answers: { name?: string }) => {
+          return convertToLabel(
+            answers?.name ?? options.name ?? directory ?? '',
+          );
         },
       },
       {
         type: 'input',
         name: 'description',
         message: 'Application description (optional):',
+        when: () => !hasDescription,
         default: '',
       },
     ]);
 
-    const computedName = name ?? directory;
+    const appName = (
+      options.name ??
+      name ??
+      directory ??
+      'my-twenty-app'
+    ).trim();
 
-    const appName = computedName.trim();
+    const appDisplayName =
+      (options.displayName ?? displayName)?.trim() || convertToLabel(appName);
 
-    const appDisplayName = displayName.trim();
-
-    const appDescription = description.trim();
+    const appDescription = (options.description ?? description ?? '').trim();
 
     const appDirectory = directory
       ? path.join(CURRENT_EXECUTION_DIRECTORY, directory)

packages/create-twenty-app/src/utils/app-template.ts

@@ -30,12 +30,12 @@ export const copyBaseApplicationProject = async ({
     includeExampleIntegrationTest: exampleOptions.includeExampleIntegrationTest,
   });
 
+  await createYarnLock(appDirectory);
+
   await createGitignore(appDirectory);
 
   await createPublicAssetDirectory(appDirectory);
 
-  await createYarnLock(appDirectory);
-
   const sourceFolderPath = join(appDirectory, SRC_FOLDER);
 
   await fs.ensureDir(sourceFolderPath);
@@ -142,13 +142,6 @@ const createPublicAssetDirectory = async (appDirectory: string) => {
   await fs.ensureDir(join(appDirectory, ASSETS_DIR));
 };
 
-const createYarnLock = async (appDirectory: string) => {
-  const yarnLockContent = `# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-`;
-
-  await fs.writeFile(join(appDirectory, 'yarn.lock'), yarnLockContent);
-};
 const createGitignore = async (appDirectory: string) => {
   const gitignoreContent = `# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
@@ -590,6 +583,14 @@ export default defineApplication({
   await fs.writeFile(join(appDirectory, fileFolder ?? '', fileName), content);
 };
 
+const createYarnLock = async (appDirectory: string) => {
+  const yarnLockContent = `# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+`;
+
+  await fs.writeFile(join(appDirectory, 'yarn.lock'), yarnLockContent);
+};
+
 const createPackageJson = async ({
   appName,
   appDirectory,

packages/twenty-sdk/project.json

@@ -36,6 +36,7 @@
         "command": "node dist/cli.cjs"
       }
     },
+    "set-local-version": {},
     "typecheck": {},
     "lint": {},
     "test": {