diff --git a/packages/twenty-docs/l/ar/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/ar/developers/extend/apps/getting-started.mdx index afd661c8b0..cbe668bdc8 100644 --- a/packages/twenty-docs/l/ar/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/ar/developers/extend/apps/getting-started.mdx @@ -220,6 +220,7 @@ npx create-twenty-app@latest my-twenty-app --example postcard | -------------------------------------- | --------------------------------------------- | | `yarn twenty server start` | بدء الخادم المحلي (يسحب الصورة إذا لزم الأمر) | | `yarn twenty server start --port 3030` | ابدأ على منفذ مخصّص | +| `yarn twenty server start --test` | ابدأ مثيل اختبار منفصل على المنفذ 2021 | | `yarn twenty server stop` | إيقاف الخادم (مع الحفاظ على البيانات) | | `yarn twenty server status` | عرض حالة الخادم، وعنوان URL، وبيانات الاعتماد | | `yarn twenty server logs` | بث سجلات الخادم | @@ -228,6 +229,20 @@ npx create-twenty-app@latest my-twenty-app --example postcard يتم الاحتفاظ بالبيانات عبر عمليات إعادة التشغيل في وحدتي تخزين Docker (`twenty-app-dev-data` لـ PostgreSQL، و`twenty-app-dev-storage` للملفات). استخدم `reset` لمسح كل شيء والبدء من جديد. +### Running a test instance + +Pass `--test` to any `server` command to manage a second, fully isolated instance — useful for running integration tests or experimenting without touching your main dev data. + +| أمر | الوصف | +| ---------------------------------- | ----------------------------------------------- | +| `yarn twenty server start --test` | Start the test instance (defaults to port 2021) | +| `yarn twenty server stop --test` | Stop the test instance | +| `yarn twenty server status --test` | Show test instance status, URL, and credentials | +| `yarn twenty server logs --test` | Stream test instance logs | +| `yarn twenty server reset --test` | Wipe test data and start fresh | + +The test instance runs in its own Docker container (`twenty-app-dev-test`) with dedicated volumes (`twenty-app-dev-test-data`, `twenty-app-dev-test-storage`) and config, so it can run in parallel with your main instance without conflicts. Combine `--test` with `--port` to override the default 2021. + يتطلّب الخادم أن يكون **Docker** قيد التشغيل. إذا ظهرت لك رسالة خطأ "Docker not running"، فتأكّد من تشغيل Docker Desktop (أو خادوم Docker). diff --git a/packages/twenty-docs/l/ar/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/ar/developers/extend/apps/publishing.mdx index 465aec3dd3..c0094262d1 100644 --- a/packages/twenty-docs/l/ar/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/ar/developers/extend/apps/publishing.mdx @@ -80,6 +80,57 @@ yarn twenty deploy {/* TODO: add screenshot of the Upgrade button */} +## Automated CI/CD (scaffolded workflows) + +Apps generated with `create-twenty-app` ship with two GitHub Actions workflows out of the box, under `.github/workflows/`. They are ready to run as soon as you push the repo to GitHub — no extra setup is needed for CI, and CD only requires a single secret. + +### CI — `ci.yml` + +Runs integration tests on every push to `main` and every pull request. + +**What it does:** + +1. Checks out your app's source. +2. Spawns an isolated Twenty test instance using the `twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main` composite action (the CI equivalent of `yarn twenty server start --test`). +3. Enables Corepack, sets up Node.js from your `.nvmrc`, and installs dependencies with `yarn install --immutable`. +4. Runs `yarn test`, passing `TWENTY_API_URL` and `TWENTY_API_KEY` from the spawned instance so your tests can talk to a real server. + +**Config knobs:** + +* `TWENTY_VERSION` (env, defaults to `latest`) — pin the Twenty server version used in CI by editing this in `ci.yml`. +* Concurrency is grouped by `github.ref` and cancels in-progress runs on new pushes. + +No secrets are required — the test instance is ephemeral and lives only for the duration of the job. + +### CD — `cd.yml` + +Deploys your app to a configured Twenty server on every push to `main`, and optionally from a pull request when the `deploy` label is applied. + +**What it does:** + +1. Checks out the PR head (for labeled PRs) or the pushed commit. +2. Runs `twentyhq/twenty/.github/actions/deploy-twenty-app@main` — the CI equivalent of `yarn twenty deploy`. +3. Runs `twentyhq/twenty/.github/actions/install-twenty-app@main` so the newly deployed version is installed into the target workspace. + +**Required configuration:** + +| الإعداد | حيث | الغرض | +| ----------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `TWENTY_DEPLOY_URL` | `env` in `cd.yml` (defaults to `http://localhost:3000`) | The Twenty server to deploy to. Change this to your real server URL before first use. | +| `TWENTY_DEPLOY_API_KEY` | GitHub repo **Settings → Secrets and variables → Actions** | API key with deploy permission on the target server. | + + +The default `TWENTY_DEPLOY_URL` of `http://localhost:3000` is a placeholder — it will not reach anything from a GitHub-hosted runner. Update it to your server's public URL (or use a self-hosted runner with network access) before enabling CD. + + +**Triggering a preview deploy from a PR:** + +Add the `deploy` label to a pull request. The `if:` guard in `cd.yml` will run the job for that PR using the PR's head commit, letting you validate a change on the target server before merging. + +### Pinning the reusable actions + +Both workflows reference reusable actions at `@main`, so action updates in the `twentyhq/twenty` repo are picked up automatically. If you want deterministic builds, replace `@main` with a commit SHA or release tag on each `uses:` line. + ## النشر على npm يُتيح النشر على npm إمكانية العثور على تطبيقك في سوق Twenty. يمكن لأي مساحة عمل في Twenty استعراض تطبيقات السوق وتثبيتها وترقيتها مباشرةً من واجهة المستخدم. diff --git a/packages/twenty-docs/l/cs/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/cs/developers/extend/apps/getting-started.mdx index 846e917185..f85348e923 100644 --- a/packages/twenty-docs/l/cs/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/cs/developers/extend/apps/getting-started.mdx @@ -220,6 +220,7 @@ Nástroj pro vytvoření kostry vám již spustil lokální server Twenty. Pro j | -------------------------------------- | ------------------------------------------------------ | | `yarn twenty server start` | Spustí lokální server (v případě potřeby stáhne image) | | `yarn twenty server start --port 3030` | Spustí na vlastním portu | +| `yarn twenty server start --test` | Spusťte samostatnou testovací instanci na portu 2021 | | `yarn twenty server stop` | Zastaví server (zachová data) | | `yarn twenty server status` | Zobrazí stav serveru, URL a přihlašovací údaje | | `yarn twenty server logs` | Streamuje protokoly serveru | @@ -228,6 +229,20 @@ Nástroj pro vytvoření kostry vám již spustil lokální server Twenty. Pro j Data přetrvávají při restartech ve dvou svazcích Dockeru (`twenty-app-dev-data` pro PostgreSQL, `twenty-app-dev-storage` pro soubory). Pomocí `reset` vymažte vše a začněte znovu. +### Running a test instance + +Pass `--test` to any `server` command to manage a second, fully isolated instance — useful for running integration tests or experimenting without touching your main dev data. + +| Příkaz | Popis | +| ---------------------------------- | ----------------------------------------------- | +| `yarn twenty server start --test` | Start the test instance (defaults to port 2021) | +| `yarn twenty server stop --test` | Stop the test instance | +| `yarn twenty server status --test` | Show test instance status, URL, and credentials | +| `yarn twenty server logs --test` | Stream test instance logs | +| `yarn twenty server reset --test` | Wipe test data and start fresh | + +The test instance runs in its own Docker container (`twenty-app-dev-test`) with dedicated volumes (`twenty-app-dev-test-data`, `twenty-app-dev-test-storage`) and config, so it can run in parallel with your main instance without conflicts. Combine `--test` with `--port` to override the default 2021. + Server vyžaduje, aby **Docker** běžel. Pokud vidíte chybu "Docker not running", ujistěte se, že je spuštěný Docker Desktop (nebo démon Dockeru). diff --git a/packages/twenty-docs/l/cs/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/cs/developers/extend/apps/publishing.mdx index 3d6811aae0..535bbd5e10 100644 --- a/packages/twenty-docs/l/cs/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/cs/developers/extend/apps/publishing.mdx @@ -80,6 +80,57 @@ Předběžné tagy fungují podle očekávání: zvýšení z `1.0.0-rc.1` → ` {/* TODO: add screenshot of the Upgrade button */} +## Automated CI/CD (scaffolded workflows) + +Apps generated with `create-twenty-app` ship with two GitHub Actions workflows out of the box, under `.github/workflows/`. They are ready to run as soon as you push the repo to GitHub — no extra setup is needed for CI, and CD only requires a single secret. + +### CI — `ci.yml` + +Runs integration tests on every push to `main` and every pull request. + +**What it does:** + +1. Checks out your app's source. +2. Spawns an isolated Twenty test instance using the `twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main` composite action (the CI equivalent of `yarn twenty server start --test`). +3. Enables Corepack, sets up Node.js from your `.nvmrc`, and installs dependencies with `yarn install --immutable`. +4. Runs `yarn test`, passing `TWENTY_API_URL` and `TWENTY_API_KEY` from the spawned instance so your tests can talk to a real server. + +**Config knobs:** + +* `TWENTY_VERSION` (env, defaults to `latest`) — pin the Twenty server version used in CI by editing this in `ci.yml`. +* Concurrency is grouped by `github.ref` and cancels in-progress runs on new pushes. + +No secrets are required — the test instance is ephemeral and lives only for the duration of the job. + +### CD — `cd.yml` + +Deploys your app to a configured Twenty server on every push to `main`, and optionally from a pull request when the `deploy` label is applied. + +**What it does:** + +1. Checks out the PR head (for labeled PRs) or the pushed commit. +2. Runs `twentyhq/twenty/.github/actions/deploy-twenty-app@main` — the CI equivalent of `yarn twenty deploy`. +3. Runs `twentyhq/twenty/.github/actions/install-twenty-app@main` so the newly deployed version is installed into the target workspace. + +**Required configuration:** + +| Nastavení | Kde | Účel | +| ----------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `TWENTY_DEPLOY_URL` | `env` in `cd.yml` (defaults to `http://localhost:3000`) | The Twenty server to deploy to. Change this to your real server URL before first use. | +| `TWENTY_DEPLOY_API_KEY` | GitHub repo **Settings → Secrets and variables → Actions** | API key with deploy permission on the target server. | + + +The default `TWENTY_DEPLOY_URL` of `http://localhost:3000` is a placeholder — it will not reach anything from a GitHub-hosted runner. Update it to your server's public URL (or use a self-hosted runner with network access) before enabling CD. + + +**Triggering a preview deploy from a PR:** + +Add the `deploy` label to a pull request. The `if:` guard in `cd.yml` will run the job for that PR using the PR's head commit, letting you validate a change on the target server before merging. + +### Pinning the reusable actions + +Both workflows reference reusable actions at `@main`, so action updates in the `twentyhq/twenty` repo are picked up automatically. If you want deterministic builds, replace `@main` with a commit SHA or release tag on each `uses:` line. + ## Publikování na npm Publikování na npm zajistí, že bude vaše aplikace dohledatelná v Marketplace Twenty. Jakýkoli pracovní prostor Twenty může procházet, instalovat a aktualizovat aplikace z Marketplace přímo z UI. diff --git a/packages/twenty-docs/l/de/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/de/developers/extend/apps/getting-started.mdx index 85335192d4..1fe0dd8627 100644 --- a/packages/twenty-docs/l/de/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/de/developers/extend/apps/getting-started.mdx @@ -220,6 +220,7 @@ Der Scaffolder hat bereits einen lokalen Twenty-Server für Sie gestartet. Um ih | -------------------------------------- | ----------------------------------------------------------- | | `yarn twenty server start` | Lokalen Server starten (lädt das Image bei Bedarf herunter) | | `yarn twenty server start --port 3030` | Auf einem benutzerdefinierten Port starten | +| `yarn twenty server start --test` | Starten Sie eine separate Testinstanz auf Port 2021 | | `yarn twenty server stop` | Server stoppen (Daten bleiben erhalten) | | `yarn twenty server status` | Serverstatus, URL und Anmeldedaten anzeigen | | `yarn twenty server logs` | Serverprotokolle streamen | @@ -228,6 +229,20 @@ Der Scaffolder hat bereits einen lokalen Twenty-Server für Sie gestartet. Um ih Daten bleiben über Neustarts hinweg in zwei Docker-Volumes bestehen (`twenty-app-dev-data` für PostgreSQL, `twenty-app-dev-storage` für Dateien). Verwenden Sie `reset`, um alles zu löschen und neu zu beginnen. +### Running a test instance + +Pass `--test` to any `server` command to manage a second, fully isolated instance — useful for running integration tests or experimenting without touching your main dev data. + +| Befehl | Beschreibung | +| ---------------------------------- | ----------------------------------------------- | +| `yarn twenty server start --test` | Start the test instance (defaults to port 2021) | +| `yarn twenty server stop --test` | Stop the test instance | +| `yarn twenty server status --test` | Show test instance status, URL, and credentials | +| `yarn twenty server logs --test` | Stream test instance logs | +| `yarn twenty server reset --test` | Wipe test data and start fresh | + +The test instance runs in its own Docker container (`twenty-app-dev-test`) with dedicated volumes (`twenty-app-dev-test-data`, `twenty-app-dev-test-storage`) and config, so it can run in parallel with your main instance without conflicts. Combine `--test` with `--port` to override the default 2021. + Der Server erfordert, dass **Docker** läuft. Wenn der Fehler "Docker not running" angezeigt wird, stellen Sie sicher, dass Docker Desktop (oder der Docker-Daemon) gestartet ist. diff --git a/packages/twenty-docs/l/de/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/de/developers/extend/apps/publishing.mdx index bb746fc690..5870abc95f 100644 --- a/packages/twenty-docs/l/de/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/de/developers/extend/apps/publishing.mdx @@ -80,6 +80,57 @@ Pre-Release-Tags funktionieren wie erwartet: Das Erhöhen von `1.0.0-rc.1` → ` {/* TODO: add screenshot of the Upgrade button */} +## Automated CI/CD (scaffolded workflows) + +Apps generated with `create-twenty-app` ship with two GitHub Actions workflows out of the box, under `.github/workflows/`. They are ready to run as soon as you push the repo to GitHub — no extra setup is needed for CI, and CD only requires a single secret. + +### CI — `ci.yml` + +Runs integration tests on every push to `main` and every pull request. + +**What it does:** + +1. Checks out your app's source. +2. Spawns an isolated Twenty test instance using the `twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main` composite action (the CI equivalent of `yarn twenty server start --test`). +3. Enables Corepack, sets up Node.js from your `.nvmrc`, and installs dependencies with `yarn install --immutable`. +4. Runs `yarn test`, passing `TWENTY_API_URL` and `TWENTY_API_KEY` from the spawned instance so your tests can talk to a real server. + +**Config knobs:** + +* `TWENTY_VERSION` (env, defaults to `latest`) — pin the Twenty server version used in CI by editing this in `ci.yml`. +* Concurrency is grouped by `github.ref` and cancels in-progress runs on new pushes. + +No secrets are required — the test instance is ephemeral and lives only for the duration of the job. + +### CD — `cd.yml` + +Deploys your app to a configured Twenty server on every push to `main`, and optionally from a pull request when the `deploy` label is applied. + +**What it does:** + +1. Checks out the PR head (for labeled PRs) or the pushed commit. +2. Runs `twentyhq/twenty/.github/actions/deploy-twenty-app@main` — the CI equivalent of `yarn twenty deploy`. +3. Runs `twentyhq/twenty/.github/actions/install-twenty-app@main` so the newly deployed version is installed into the target workspace. + +**Required configuration:** + +| Einstellung | Wo | Zweck | +| ----------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `TWENTY_DEPLOY_URL` | `env` in `cd.yml` (defaults to `http://localhost:3000`) | The Twenty server to deploy to. Change this to your real server URL before first use. | +| `TWENTY_DEPLOY_API_KEY` | GitHub repo **Settings → Secrets and variables → Actions** | API key with deploy permission on the target server. | + + +The default `TWENTY_DEPLOY_URL` of `http://localhost:3000` is a placeholder — it will not reach anything from a GitHub-hosted runner. Update it to your server's public URL (or use a self-hosted runner with network access) before enabling CD. + + +**Triggering a preview deploy from a PR:** + +Add the `deploy` label to a pull request. The `if:` guard in `cd.yml` will run the job for that PR using the PR's head commit, letting you validate a change on the target server before merging. + +### Pinning the reusable actions + +Both workflows reference reusable actions at `@main`, so action updates in the `twentyhq/twenty` repo are picked up automatically. If you want deterministic builds, replace `@main` with a commit SHA or release tag on each `uses:` line. + ## Auf npm veröffentlichen Die Veröffentlichung auf npm macht Ihre App im Twenty-Marktplatz auffindbar. Jeder Twenty-Arbeitsbereich kann Marktplatz-Apps direkt über die Benutzeroberfläche durchsuchen, installieren und aktualisieren. diff --git a/packages/twenty-docs/l/it/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/it/developers/extend/apps/getting-started.mdx index de3e7d9fb7..23273a2a2f 100644 --- a/packages/twenty-docs/l/it/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/it/developers/extend/apps/getting-started.mdx @@ -220,6 +220,7 @@ Lo scaffolder ha già avviato per te un server Twenty locale. Per gestirlo in se | -------------------------------------- | --------------------------------------------------------- | | `yarn twenty server start` | Avvia il server locale (scarica l'immagine se necessario) | | `yarn twenty server start --port 3030` | Avvia su una porta personalizzata | +| `yarn twenty server start --test` | Avvia un'istanza di test separata sulla porta 2021 | | `yarn twenty server stop` | Arresta il server (conserva i dati) | | `yarn twenty server status` | Mostra stato del server, URL e credenziali | | `yarn twenty server logs` | Trasmetti in streaming i log del server | @@ -228,6 +229,20 @@ Lo scaffolder ha già avviato per te un server Twenty locale. Per gestirlo in se I dati vengono mantenuti tra i riavvii in due volumi Docker (`twenty-app-dev-data` per PostgreSQL, `twenty-app-dev-storage` per i file). Usa `reset` per cancellare tutto e ripartire da zero. +### Running a test instance + +Pass `--test` to any `server` command to manage a second, fully isolated instance — useful for running integration tests or experimenting without touching your main dev data. + +| Comando | Descrizione | +| ---------------------------------- | ----------------------------------------------- | +| `yarn twenty server start --test` | Start the test instance (defaults to port 2021) | +| `yarn twenty server stop --test` | Stop the test instance | +| `yarn twenty server status --test` | Show test instance status, URL, and credentials | +| `yarn twenty server logs --test` | Stream test instance logs | +| `yarn twenty server reset --test` | Wipe test data and start fresh | + +The test instance runs in its own Docker container (`twenty-app-dev-test`) with dedicated volumes (`twenty-app-dev-test-data`, `twenty-app-dev-test-storage`) and config, so it can run in parallel with your main instance without conflicts. Combine `--test` with `--port` to override the default 2021. + Il server richiede che **Docker** sia in esecuzione. Se vedi l'errore "Docker not running", assicurati che Docker Desktop (o il demone Docker) sia avviato. diff --git a/packages/twenty-docs/l/it/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/it/developers/extend/apps/publishing.mdx index 010ad21cbc..62e9b3e56d 100644 --- a/packages/twenty-docs/l/it/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/it/developers/extend/apps/publishing.mdx @@ -80,6 +80,57 @@ I tag di pre-release funzionano come previsto: incrementare `1.0.0-rc.1` → `1. {/* TODO: add screenshot of the Upgrade button */} +## Automated CI/CD (scaffolded workflows) + +Apps generated with `create-twenty-app` ship with two GitHub Actions workflows out of the box, under `.github/workflows/`. They are ready to run as soon as you push the repo to GitHub — no extra setup is needed for CI, and CD only requires a single secret. + +### CI — `ci.yml` + +Runs integration tests on every push to `main` and every pull request. + +**What it does:** + +1. Checks out your app's source. +2. Spawns an isolated Twenty test instance using the `twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main` composite action (the CI equivalent of `yarn twenty server start --test`). +3. Enables Corepack, sets up Node.js from your `.nvmrc`, and installs dependencies with `yarn install --immutable`. +4. Runs `yarn test`, passing `TWENTY_API_URL` and `TWENTY_API_KEY` from the spawned instance so your tests can talk to a real server. + +**Config knobs:** + +* `TWENTY_VERSION` (env, defaults to `latest`) — pin the Twenty server version used in CI by editing this in `ci.yml`. +* Concurrency is grouped by `github.ref` and cancels in-progress runs on new pushes. + +No secrets are required — the test instance is ephemeral and lives only for the duration of the job. + +### CD — `cd.yml` + +Deploys your app to a configured Twenty server on every push to `main`, and optionally from a pull request when the `deploy` label is applied. + +**What it does:** + +1. Checks out the PR head (for labeled PRs) or the pushed commit. +2. Runs `twentyhq/twenty/.github/actions/deploy-twenty-app@main` — the CI equivalent of `yarn twenty deploy`. +3. Runs `twentyhq/twenty/.github/actions/install-twenty-app@main` so the newly deployed version is installed into the target workspace. + +**Required configuration:** + +| Impostazione | Dove | Scopo | +| ----------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `TWENTY_DEPLOY_URL` | `env` in `cd.yml` (defaults to `http://localhost:3000`) | The Twenty server to deploy to. Change this to your real server URL before first use. | +| `TWENTY_DEPLOY_API_KEY` | GitHub repo **Settings → Secrets and variables → Actions** | API key with deploy permission on the target server. | + + +The default `TWENTY_DEPLOY_URL` of `http://localhost:3000` is a placeholder — it will not reach anything from a GitHub-hosted runner. Update it to your server's public URL (or use a self-hosted runner with network access) before enabling CD. + + +**Triggering a preview deploy from a PR:** + +Add the `deploy` label to a pull request. The `if:` guard in `cd.yml` will run the job for that PR using the PR's head commit, letting you validate a change on the target server before merging. + +### Pinning the reusable actions + +Both workflows reference reusable actions at `@main`, so action updates in the `twentyhq/twenty` repo are picked up automatically. If you want deterministic builds, replace `@main` with a commit SHA or release tag on each `uses:` line. + ## Pubblicazione su npm La pubblicazione su npm rende la tua app scopribile nel marketplace di Twenty. Qualsiasi spazio di lavoro Twenty può sfogliare, installare e aggiornare le app del marketplace direttamente dall'interfaccia utente. diff --git a/packages/twenty-docs/l/pt/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/pt/developers/extend/apps/getting-started.mdx index fc66815223..9eeb82ef48 100644 --- a/packages/twenty-docs/l/pt/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/pt/developers/extend/apps/getting-started.mdx @@ -220,6 +220,7 @@ A ferramenta de scaffolding já iniciou um servidor local do Twenty para você. | -------------------------------------- | ------------------------------------------------------ | | `yarn twenty server start` | Inicia o servidor local (baixa a imagem se necessário) | | `yarn twenty server start --port 3030` | Iniciar em uma porta personalizada | +| `yarn twenty server start --test` | Inicie uma instância de teste separada na porta 2021 | | `yarn twenty server stop` | Interrompe o servidor (preserva os dados) | | `yarn twenty server status` | Mostra o status do servidor, a URL e as credenciais | | `yarn twenty server logs` | Transmite os logs do servidor | @@ -228,6 +229,20 @@ A ferramenta de scaffolding já iniciou um servidor local do Twenty para você. Os dados são persistidos entre reinicializações em dois volumes do Docker (`twenty-app-dev-data` para PostgreSQL, `twenty-app-dev-storage` para arquivos). Use `reset` para apagar tudo e começar do zero. +### Running a test instance + +Pass `--test` to any `server` command to manage a second, fully isolated instance — useful for running integration tests or experimenting without touching your main dev data. + +| Comando | Descrição | +| ---------------------------------- | ----------------------------------------------- | +| `yarn twenty server start --test` | Start the test instance (defaults to port 2021) | +| `yarn twenty server stop --test` | Stop the test instance | +| `yarn twenty server status --test` | Show test instance status, URL, and credentials | +| `yarn twenty server logs --test` | Stream test instance logs | +| `yarn twenty server reset --test` | Wipe test data and start fresh | + +The test instance runs in its own Docker container (`twenty-app-dev-test`) with dedicated volumes (`twenty-app-dev-test-data`, `twenty-app-dev-test-storage`) and config, so it can run in parallel with your main instance without conflicts. Combine `--test` with `--port` to override the default 2021. + O servidor requer que o **Docker** esteja em execução. Se você vir um erro "Docker not running", certifique-se de que o Docker Desktop (ou o daemon do Docker) esteja iniciado. diff --git a/packages/twenty-docs/l/pt/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/pt/developers/extend/apps/publishing.mdx index ef7dd02325..d66698a7af 100644 --- a/packages/twenty-docs/l/pt/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/pt/developers/extend/apps/publishing.mdx @@ -80,6 +80,57 @@ Tags de pré-lançamento funcionam como esperado: incrementar `1.0.0-rc.1` → ` {/* TODO: add screenshot of the Upgrade button */} +## Automated CI/CD (scaffolded workflows) + +Apps generated with `create-twenty-app` ship with two GitHub Actions workflows out of the box, under `.github/workflows/`. They are ready to run as soon as you push the repo to GitHub — no extra setup is needed for CI, and CD only requires a single secret. + +### CI — `ci.yml` + +Runs integration tests on every push to `main` and every pull request. + +**What it does:** + +1. Checks out your app's source. +2. Spawns an isolated Twenty test instance using the `twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main` composite action (the CI equivalent of `yarn twenty server start --test`). +3. Enables Corepack, sets up Node.js from your `.nvmrc`, and installs dependencies with `yarn install --immutable`. +4. Runs `yarn test`, passing `TWENTY_API_URL` and `TWENTY_API_KEY` from the spawned instance so your tests can talk to a real server. + +**Config knobs:** + +* `TWENTY_VERSION` (env, defaults to `latest`) — pin the Twenty server version used in CI by editing this in `ci.yml`. +* Concurrency is grouped by `github.ref` and cancels in-progress runs on new pushes. + +No secrets are required — the test instance is ephemeral and lives only for the duration of the job. + +### CD — `cd.yml` + +Deploys your app to a configured Twenty server on every push to `main`, and optionally from a pull request when the `deploy` label is applied. + +**What it does:** + +1. Checks out the PR head (for labeled PRs) or the pushed commit. +2. Runs `twentyhq/twenty/.github/actions/deploy-twenty-app@main` — the CI equivalent of `yarn twenty deploy`. +3. Runs `twentyhq/twenty/.github/actions/install-twenty-app@main` so the newly deployed version is installed into the target workspace. + +**Required configuration:** + +| Configuração | Onde | Finalidade | +| ----------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `TWENTY_DEPLOY_URL` | `env` in `cd.yml` (defaults to `http://localhost:3000`) | The Twenty server to deploy to. Change this to your real server URL before first use. | +| `TWENTY_DEPLOY_API_KEY` | GitHub repo **Settings → Secrets and variables → Actions** | API key with deploy permission on the target server. | + + +The default `TWENTY_DEPLOY_URL` of `http://localhost:3000` is a placeholder — it will not reach anything from a GitHub-hosted runner. Update it to your server's public URL (or use a self-hosted runner with network access) before enabling CD. + + +**Triggering a preview deploy from a PR:** + +Add the `deploy` label to a pull request. The `if:` guard in `cd.yml` will run the job for that PR using the PR's head commit, letting you validate a change on the target server before merging. + +### Pinning the reusable actions + +Both workflows reference reusable actions at `@main`, so action updates in the `twentyhq/twenty` repo are picked up automatically. If you want deterministic builds, replace `@main` with a commit SHA or release tag on each `uses:` line. + ## Publicação no npm Publicar no npm torna seu aplicativo descobrível no Marketplace da Twenty. Qualquer espaço de trabalho da Twenty pode navegar, instalar e atualizar aplicativos do Marketplace diretamente pela UI. diff --git a/packages/twenty-docs/l/ru/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/ru/developers/extend/apps/getting-started.mdx index 641cd507df..1ef3c32a82 100644 --- a/packages/twenty-docs/l/ru/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/ru/developers/extend/apps/getting-started.mdx @@ -220,6 +220,7 @@ npx create-twenty-app@latest my-twenty-app --example postcard | -------------------------------------- | -------------------------------------------------------------- | | `yarn twenty server start` | Запустить локальный сервер (при необходимости скачивает образ) | | `yarn twenty server start --port 3030` | Запустить на пользовательском порту | +| `yarn twenty server start --test` | Запускает отдельный тестовый экземпляр на порту 2021 | | `yarn twenty server stop` | Остановить сервер (данные сохраняются) | | `yarn twenty server status` | Показать состояние сервера, URL и учётные данные | | `yarn twenty server logs` | Потоковый вывод журналов сервера | @@ -228,6 +229,20 @@ npx create-twenty-app@latest my-twenty-app --example postcard Данные сохраняются между перезапусками в двух томах Docker (`twenty-app-dev-data` для PostgreSQL, `twenty-app-dev-storage` для файлов). Используйте `reset`, чтобы стереть всё и начать заново. +### Running a test instance + +Pass `--test` to any `server` command to manage a second, fully isolated instance — useful for running integration tests or experimenting without touching your main dev data. + +| Команда | Описание | +| ---------------------------------- | ----------------------------------------------- | +| `yarn twenty server start --test` | Start the test instance (defaults to port 2021) | +| `yarn twenty server stop --test` | Stop the test instance | +| `yarn twenty server status --test` | Show test instance status, URL, and credentials | +| `yarn twenty server logs --test` | Stream test instance logs | +| `yarn twenty server reset --test` | Wipe test data and start fresh | + +The test instance runs in its own Docker container (`twenty-app-dev-test`) with dedicated volumes (`twenty-app-dev-test-data`, `twenty-app-dev-test-storage`) and config, so it can run in parallel with your main instance without conflicts. Combine `--test` with `--port` to override the default 2021. + Для работы сервера необходимо, чтобы **Docker** был запущен. Если вы видите ошибку "Docker not running", убедитесь, что запущен Docker Desktop (или демон Docker). diff --git a/packages/twenty-docs/l/ru/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/ru/developers/extend/apps/publishing.mdx index d4ae1090ff..78c69685a1 100644 --- a/packages/twenty-docs/l/ru/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/ru/developers/extend/apps/publishing.mdx @@ -80,6 +80,57 @@ When updating an already deployed tarball app, the server requires the `version` {/* TODO: add screenshot of the Upgrade button */} +## Automated CI/CD (scaffolded workflows) + +Apps generated with `create-twenty-app` ship with two GitHub Actions workflows out of the box, under `.github/workflows/`. They are ready to run as soon as you push the repo to GitHub — no extra setup is needed for CI, and CD only requires a single secret. + +### CI — `ci.yml` + +Runs integration tests on every push to `main` and every pull request. + +**What it does:** + +1. Checks out your app's source. +2. Spawns an isolated Twenty test instance using the `twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main` composite action (the CI equivalent of `yarn twenty server start --test`). +3. Enables Corepack, sets up Node.js from your `.nvmrc`, and installs dependencies with `yarn install --immutable`. +4. Runs `yarn test`, passing `TWENTY_API_URL` and `TWENTY_API_KEY` from the spawned instance so your tests can talk to a real server. + +**Config knobs:** + +* `TWENTY_VERSION` (env, defaults to `latest`) — pin the Twenty server version used in CI by editing this in `ci.yml`. +* Concurrency is grouped by `github.ref` and cancels in-progress runs on new pushes. + +No secrets are required — the test instance is ephemeral and lives only for the duration of the job. + +### CD — `cd.yml` + +Deploys your app to a configured Twenty server on every push to `main`, and optionally from a pull request when the `deploy` label is applied. + +**What it does:** + +1. Checks out the PR head (for labeled PRs) or the pushed commit. +2. Runs `twentyhq/twenty/.github/actions/deploy-twenty-app@main` — the CI equivalent of `yarn twenty deploy`. +3. Runs `twentyhq/twenty/.github/actions/install-twenty-app@main` so the newly deployed version is installed into the target workspace. + +**Required configuration:** + +| Настройка | Где | Назначение | +| ----------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `TWENTY_DEPLOY_URL` | `env` in `cd.yml` (defaults to `http://localhost:3000`) | The Twenty server to deploy to. Change this to your real server URL before first use. | +| `TWENTY_DEPLOY_API_KEY` | GitHub repo **Settings → Secrets and variables → Actions** | API key with deploy permission on the target server. | + + +The default `TWENTY_DEPLOY_URL` of `http://localhost:3000` is a placeholder — it will not reach anything from a GitHub-hosted runner. Update it to your server's public URL (or use a self-hosted runner with network access) before enabling CD. + + +**Triggering a preview deploy from a PR:** + +Add the `deploy` label to a pull request. The `if:` guard in `cd.yml` will run the job for that PR using the PR's head commit, letting you validate a change on the target server before merging. + +### Pinning the reusable actions + +Both workflows reference reusable actions at `@main`, so action updates in the `twentyhq/twenty` repo are picked up automatically. If you want deterministic builds, replace `@main` with a commit SHA or release tag on each `uses:` line. + ## Публикация в npm Публикация в npm делает ваше приложение видимым в маркетплейсе Twenty. Любое рабочее пространство Twenty может просматривать, устанавливать и обновлять приложения из маркетплейса непосредственно из интерфейса. diff --git a/packages/twenty-docs/l/tr/developers/extend/apps/getting-started.mdx b/packages/twenty-docs/l/tr/developers/extend/apps/getting-started.mdx index 2e15938654..7c79160e3c 100644 --- a/packages/twenty-docs/l/tr/developers/extend/apps/getting-started.mdx +++ b/packages/twenty-docs/l/tr/developers/extend/apps/getting-started.mdx @@ -216,18 +216,33 @@ npx create-twenty-app@latest my-twenty-app --example postcard İskelet oluşturucu sizin için zaten yerel bir Twenty sunucusu başlattı. Daha sonra yönetmek için `yarn twenty server` komutunu kullanın: -| Komut | Açıklama | -| -------------------------------------- | ------------------------------------------------------ | -| `yarn twenty server start` | Yerel sunucuyu başlatır (gerekirse imajı çeker) | -| `yarn twenty server start --port 3030` | Özel bir portta başlatır | -| `yarn twenty server stop` | Sunucuyu durdurur (verileri korur) | -| `yarn twenty server status` | Sunucu durumunu, URL'yi ve kimlik bilgilerini gösterir | -| `yarn twenty server logs` | Sunucu günlüklerini akış olarak iletir | -| `yarn twenty server logs --lines 100` | Son 100 günlük satırını gösterir | -| `yarn twenty server reset` | Tüm verileri siler ve sıfırdan başlatır | +| Komut | Açıklama | +| -------------------------------------- | --------------------------------------------------------------- | +| `yarn twenty server start` | Yerel sunucuyu başlatır (gerekirse imajı çeker) | +| `yarn twenty server start --port 3030` | Özel bir portta başlatır | +| `yarn twenty server start --test` | 2021 numaralı bağlantı noktasında ayrı bir test örneği başlatın | +| `yarn twenty server stop` | Sunucuyu durdurur (verileri korur) | +| `yarn twenty server status` | Sunucu durumunu, URL'yi ve kimlik bilgilerini gösterir | +| `yarn twenty server logs` | Sunucu günlüklerini akış olarak iletir | +| `yarn twenty server logs --lines 100` | Son 100 günlük satırını gösterir | +| `yarn twenty server reset` | Tüm verileri siler ve sıfırdan başlatır | Veriler, yeniden başlatmalar arasında iki Docker biriminde kalıcıdır (PostgreSQL için `twenty-app-dev-data`, dosyalar için `twenty-app-dev-storage`). Her şeyi silip baştan başlamak için `reset` kullanın. +### Running a test instance + +Pass `--test` to any `server` command to manage a second, fully isolated instance — useful for running integration tests or experimenting without touching your main dev data. + +| Komut | Açıklama | +| ---------------------------------- | ----------------------------------------------- | +| `yarn twenty server start --test` | Start the test instance (defaults to port 2021) | +| `yarn twenty server stop --test` | Stop the test instance | +| `yarn twenty server status --test` | Show test instance status, URL, and credentials | +| `yarn twenty server logs --test` | Stream test instance logs | +| `yarn twenty server reset --test` | Wipe test data and start fresh | + +The test instance runs in its own Docker container (`twenty-app-dev-test`) with dedicated volumes (`twenty-app-dev-test-data`, `twenty-app-dev-test-storage`) and config, so it can run in parallel with your main instance without conflicts. Combine `--test` with `--port` to override the default 2021. + Sunucunun çalışması için **Docker**'ın çalışıyor olması gerekir. "Docker not running" hatası görürseniz Docker Desktop'ın (veya Docker daemon'ının) başlatıldığından emin olun. diff --git a/packages/twenty-docs/l/tr/developers/extend/apps/publishing.mdx b/packages/twenty-docs/l/tr/developers/extend/apps/publishing.mdx index 4c94a6a7bc..5426aaeb93 100644 --- a/packages/twenty-docs/l/tr/developers/extend/apps/publishing.mdx +++ b/packages/twenty-docs/l/tr/developers/extend/apps/publishing.mdx @@ -80,6 +80,57 @@ Bir güncelleme yayımlamak için: {/* TODO: add screenshot of the Upgrade button */} +## Automated CI/CD (scaffolded workflows) + +Apps generated with `create-twenty-app` ship with two GitHub Actions workflows out of the box, under `.github/workflows/`. They are ready to run as soon as you push the repo to GitHub — no extra setup is needed for CI, and CD only requires a single secret. + +### CI — `ci.yml` + +Runs integration tests on every push to `main` and every pull request. + +**What it does:** + +1. Checks out your app's source. +2. Spawns an isolated Twenty test instance using the `twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main` composite action (the CI equivalent of `yarn twenty server start --test`). +3. Enables Corepack, sets up Node.js from your `.nvmrc`, and installs dependencies with `yarn install --immutable`. +4. Runs `yarn test`, passing `TWENTY_API_URL` and `TWENTY_API_KEY` from the spawned instance so your tests can talk to a real server. + +**Config knobs:** + +* `TWENTY_VERSION` (env, defaults to `latest`) — pin the Twenty server version used in CI by editing this in `ci.yml`. +* Concurrency is grouped by `github.ref` and cancels in-progress runs on new pushes. + +No secrets are required — the test instance is ephemeral and lives only for the duration of the job. + +### CD — `cd.yml` + +Deploys your app to a configured Twenty server on every push to `main`, and optionally from a pull request when the `deploy` label is applied. + +**What it does:** + +1. Checks out the PR head (for labeled PRs) or the pushed commit. +2. Runs `twentyhq/twenty/.github/actions/deploy-twenty-app@main` — the CI equivalent of `yarn twenty deploy`. +3. Runs `twentyhq/twenty/.github/actions/install-twenty-app@main` so the newly deployed version is installed into the target workspace. + +**Required configuration:** + +| Ayar | Koşul | Amaç | +| ----------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `TWENTY_DEPLOY_URL` | `env` in `cd.yml` (defaults to `http://localhost:3000`) | The Twenty server to deploy to. Change this to your real server URL before first use. | +| `TWENTY_DEPLOY_API_KEY` | GitHub repo **Settings → Secrets and variables → Actions** | API key with deploy permission on the target server. | + + +The default `TWENTY_DEPLOY_URL` of `http://localhost:3000` is a placeholder — it will not reach anything from a GitHub-hosted runner. Update it to your server's public URL (or use a self-hosted runner with network access) before enabling CD. + + +**Triggering a preview deploy from a PR:** + +Add the `deploy` label to a pull request. The `if:` guard in `cd.yml` will run the job for that PR using the PR's head commit, letting you validate a change on the target server before merging. + +### Pinning the reusable actions + +Both workflows reference reusable actions at `@main`, so action updates in the `twentyhq/twenty` repo are picked up automatically. If you want deterministic builds, replace `@main` with a commit SHA or release tag on each `uses:` line. + ## npm’ye yayımlama npm’ye yayımlamak, uygulamanızın Twenty pazaryerinde keşfedilebilir olmasını sağlar. Herhangi bir Twenty çalışma alanı, pazaryeri uygulamalarına doğrudan arayüzden göz atabilir, yükleyebilir ve güncelleyebilir.