Публикация

Documentation Index

Fetch the complete documentation index at: https://docs.twenty.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Обзор

• Разверните tar-архив — загрузите своё приложение напрямую на конкретный сервер Twenty для внутреннего или частного использования.
• Опубликовать в npm — разместите ваше приложение в маркетплейсе Twenty, чтобы любое рабочее пространство могло его найти и установить.

​

Сборка вашего приложения

yarn twenty build

​

Развертывание на сервер (tarball)

​

Требования

yarn twenty remote add --api-url https://your-twenty-server.com --as production

​

Развертывание

yarn twenty deploy
# To deploy to a specific remote:
# yarn twenty deploy --remote production

​

Общий доступ к развернутому приложению

1. Перейдите в Настройки > Приложения > Регистрации и откройте ваше приложение
2. На вкладке Распространение нажмите Копировать ссылку для общего доступа
3. Поделитесь этой ссылкой с пользователями в других рабочих пространствах — она ведёт их прямо на страницу установки приложения

​

Управление версиями

1. Увеличьте значение поля version в вашем package.json (например: 1.2.3 → 1.2.4, 1.3.0 или 2.0.0).
2. Выполните yarn twenty deploy (или yarn twenty deploy --remote production)
3. Рабочие пространства, в которых установлено приложение, увидят доступное обновление в своих настройках

​

Автоматизированный CI/CD (рабочие процессы, сгенерированные шаблоном)

​

CI — ci.yml

1. Извлекает исходный код вашего приложения.
2. Запускает изолированный тестовый экземпляр Twenty с помощью составного действия twentyhq/twenty/.github/actions/spawn-twenty-app-dev-test@main (эквивалент для CI yarn twenty server start --test).
3. Включает Corepack, настраивает Node.js на основе вашего .nvmrc и устанавливает зависимости с помощью yarn install --immutable.
4. Запускает yarn test, передавая TWENTY_API_URL и TWENTY_API_KEY из запущенного экземпляра, чтобы ваши тесты могли взаимодействовать с реальным сервером.

• TWENTY_VERSION (переменная окружения, по умолчанию latest) — зафиксируйте версию сервера Twenty, используемую в CI, отредактировав это значение в ci.yml.
• Параллельные запуски группируются по github.ref и отменяют выполняющиеся прогоны при новых пушах.

​

CD — cd.yml

1. Извлекает head-коммит PR (для PR с меткой) или запушенный коммит.
2. Запускает twentyhq/twenty/.github/actions/deploy-twenty-app@main — эквивалент для CI yarn twenty deploy.
3. Запускает twentyhq/twenty/.github/actions/install-twenty-app@main, чтобы новая развернутая версия была установлена в целевое рабочее пространство.

​

Закрепление версий повторно используемых действий

​

Публикация в npm

​

Требования

• Учётная запись npm
• Ключевое слово twenty-app в массиве keywords вашего package.json (добавьте его вручную — по умолчанию оно не включено в шаблон create-twenty-app)

{
  "name": "twenty-app-postcard-sender",
  "version": "1.0.0",
  "keywords": ["twenty-app"]
}

​

Метаданные маркетплейса

export default defineApplication({
  universalIdentifier: '...',
  displayName: 'My App',
  description: 'A great app',
  defaultRoleUniversalIdentifier: DEFAULT_ROLE_UNIVERSAL_IDENTIFIER,
  logoUrl: 'public/logo.png',
  screenshots: [
    'public/screenshot-1.png',
    'public/screenshot-2.png',
  ],
});

​

Публикация

yarn twenty publish

yarn twenty publish --tag beta

​

Как работает обнаружение приложений в маркетплейсе

yarn twenty catalog-sync
# To target a specific remote:
# yarn twenty catalog-sync --remote production

​

Публикация через CI

name: Publish
on:
  release:
    types: [published]

permissions:
  contents: read
  id-token: write

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: "24"
          registry-url: https://registry.npmjs.org
      - run: yarn install --immutable
      - run: npx twenty build
      - run: npm publish --provenance --access public
        working-directory: .twenty/output

​

Установка приложений

yarn twenty install