mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-02 14:22:21 +00:00
37acd2a9d9
# Which Problems Are Solved
Replaces Turbo by Nx and lays the foundation for the next CI
improvements. It enables using Nx Cloud to speed the up the pipelines
that affect any node package.
It streamlines the dev experience for frontend and backend developers by
providing the following commands:
| Task | Command | Notes |
|------|---------|--------|
| **Production** | `nx run PROJECT:prod` | Production server |
| **Develop** | `nx run PROJECT:dev` | Hot reloading development server
|
| **Test** | `nx run PROJECT:test` | Run all tests |
| **Lint** | `nx run PROJECT:lint` | Check code style |
| **Lint Fix** | `nx run PROJECT:lint-fix` | Auto-fix style issues |
The following values can be used for PROJECT:
- @zitadel/zitadel (root commands)
- @zitadel/api,
- @zitadel/login,
- @zitadel/console,
- @zitadel/docs,
- @zitadel/client
- @zitadel/proto
The project names and folders are streamlined:
| Old Folder | New Folder |
| --- | --- |
| ./e2e | ./tests/functional-ui |
| ./load-test | ./benchmark |
| ./build/zitadel | ./apps/api |
| ./console | ./apps/console (postponed so the PR is reviewable) |
Also, all references to the TypeScript repo are removed so we can
archive it.
# How the Problems Are Solved
- Ran `npx nx@latest init`
- Replaced all turbo.json by project.json and fixed the target configs
- Removed Turbo dependency
- All JavaScript related code affected by a PRs changes is
quality-checked using the `nx affected` command
- We move PR checks that are runnable using Nx into the `check`
workflow. For workflows where we don't use Nx, yet, we restore
previously built dependency artifacts from Nx.
- We only use a single and easy to understand dev container
- The CONTRIBUTING.md is streamlined
- The setup with a generated client pat is orchestrated with Nx
- Everything related to the TypeScript repo is updated or removed. A
**Deploy with Vercel** button is added to the docs and the
CONTRIBUTING.md.
# Additional Changes
- NPM package names have a consistent pattern.
- Docker bake is removed. The login container is built and released like
the core container.
- The integration tests build the login container before running, so
they don't rely on the login container action anymore. This fixes
consistently failing checks on PRs from forks.
- The docs build in GitHub actions is removed, as we already build on
Vercel.
# Additional Context
- Internal discussion:
https://zitadel.slack.com/archives/C087ADF8LRX/p1756277884928169
- Workflow dispatch test:
https://github.com/zitadel/zitadel/actions/runs/17760122959
---------
Co-authored-by: Florian Forster <florian@zitadel.com>
Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
(cherry picked from commit f69a6ed4f3)
# Conflicts:
# .github/workflows/build.yml
# .github/workflows/console.yml
# .github/workflows/core.yml
# CONTRIBUTING.md
# Makefile
# backend/v3/storage/database/events_testing/events_test.go
# backend/v3/storage/database/events_testing/id_provider_instance_test.go
# backend/v3/storage/database/events_testing/instance_test.go
# console/README.md
# console/package.json
# internal/api/grpc/group/v2/integration_test/query_test.go
# pnpm-lock.yaml
56 lines
1.9 KiB
JSON
56 lines
1.9 KiB
JSON
{
|
|
"$schema": "../../node_modules/nx/schemas/project-schema.json",
|
|
"targets": {
|
|
"run-db": {
|
|
"continuous": true,
|
|
"description": "Runs a local ephemeral Postgres database for functional UI (Console) tests.",
|
|
"command": "nx run @zitadel/devcontainer:compose up --force-recreate --renew-anon-volumes db-functional-ui"
|
|
},
|
|
"run-api": {
|
|
"description": "Sets up and runs the Zitadel API with the embedded Console against which the functional UI tests are run.",
|
|
"continuous": true,
|
|
"dependsOn": [
|
|
"@zitadel/api:build"
|
|
],
|
|
"executor": "nx:run-commands",
|
|
"options": {
|
|
"command": "nx run @zitadel/api:prod:test-functional-ui --excludeTaskDependencies"
|
|
}
|
|
},
|
|
"open": {
|
|
"description": "Opens the Cypress Test Runner for interactive testing.",
|
|
"continuous": true,
|
|
"dependsOn": [
|
|
"@zitadel/console:dev",
|
|
"run-db",
|
|
"run-api"
|
|
]
|
|
},
|
|
"test": {
|
|
"description": "Runs the functional UI (Console) tests against a Zitadel API and a specified browser. Pass an installed browser as an argument, like --browser electron. The 'electron' browser should always be available.",
|
|
"dependsOn": [
|
|
"run-db",
|
|
"run-api"
|
|
],
|
|
"executor": "nx:run-commands",
|
|
"options": {
|
|
"parallel": false,
|
|
"cwd": "{projectRoot}",
|
|
"commands": [
|
|
"cypress install",
|
|
"wait-on --verbose --interval 2000 --simultaneous 1 --timeout 30m \"${CYPRESS_BACKEND_URL}/debug/ready\"",
|
|
"DISPLAY='' cypress run",
|
|
"nx run @zitadel/functional-ui:stop"
|
|
]
|
|
},
|
|
"cache": true,
|
|
"inputs": [
|
|
"default"
|
|
]
|
|
},
|
|
"stop": {
|
|
"description": "Stops the local Postgres database used for functional UI (Console) tests.",
|
|
"command": "nx run @zitadel/devcontainer:compose down --volumes db-functional-ui"
|
|
}
|
|
}
|
|
} |