mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 12:37:39 +00:00
chore: reproducible pipeline with dev containers (#10305)
# Which Problems Are Solved - The previous monorepo in monorepo structure for the login app and its related packages was fragmented, complicated and buggy. - The process for building and testing the login container was inconsistent between local development and CI. - Lack of clear documentation as well as easy and reliable ways for non-frontend developers to reproduce and fix failing PR checks locally. # How the Problems Are Solved - Consolidated the login app and its related npm packages by moving the main package to `apps/login/apps/login` and merging `apps/login/packages/integration` and `apps/login/packages/acceptance` into the main `apps/login` package. - Migrated from Docker Compose-based test setups to dev container-based setups, adding support for multiple dev container configurations: - `.devcontainer/base` - `.devcontainer/turbo-lint-unit` - `.devcontainer/turbo-lint-unit-debug` - `.devcontainer/login-integration` - `.devcontainer/login-integration-debug` - Added npm scripts to run the new dev container setups, enabling exact reproduction of GitHub PR checks locally, and updated the pipeline to use these containers. - Cleaned up Dockerfiles and docker-bake.hcl files to only build the production image for the login app. - Cleaned up compose files to focus on dev environments in dev containers. - Updated `CONTRIBUTING.md` with guidance on running and debugging PR checks locally using the new dev container approach. - Introduced separate Dockerfiles for the login app to distinguish between using published client packages and building clients from local protos. - Ensured the login container is always built in the pipeline for use in integration and acceptance tests. - Updated Makefile and GitHub Actions workflows to use `--frozen-lockfile` for installing pnpm packages, ensuring reproducible installs. - Disabled GitHub release creation by the changeset action. - Refactored the `/build` directory structure for clarity and maintainability. - Added a `clean` command to `docks/package.json`. - Experimentally added `knip` to the `zitadel-client` package for improved linting of dependencies and exports. # Additional Changes - Fixed Makefile commands for consistency and reliability. - Improved the structure and clarity of the `/build` directory to support seamless integration of the login build. - Enhanced documentation and developer experience for running and debugging CI checks locally. # Additional Context - See updated `CONTRIBUTING.md` for new local development and debugging instructions. - These changes are a prerequisite for further improvements to the CI pipeline and local development workflow. - Closes #10276
This commit is contained in:
Elio Bischof
16
.devcontainer/base/Dockerfile
Normal file
16
.devcontainer/base/Dockerfile
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
FROM mcr.microsoft.com/devcontainers/typescript-node:20-bookworm
|
||||||
|
|
||||||
|
ENV SHELL=/bin/bash \
|
||||||
|
DEBIAN_FRONTEND=noninteractive \
|
||||||
|
LANG=C.UTF-8 \
|
||||||
|
LC_ALL=C.UTF-8 \
|
||||||
|
CI=1 \
|
||||||
|
PNPM_HOME=/home/node/.local/share/pnpm \
|
||||||
|
PATH=/home/node/.local/share/pnpm:$PATH
|
||||||
|
|
||||||
|
|
||||||
|
RUN apt-get update && \
|
||||||
|
apt-get --no-install-recommends install -y \
|
||||||
|
libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libnss3 libxss1 libasound2 libxtst6 xauth xvfb && \
|
||||||
|
apt-get clean && \
|
||||||
|
corepack enable && COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack prepare pnpm@9.1.2 --activate
|
||||||
28
.devcontainer/base/devcontainer.json
Normal file
28
.devcontainer/base/devcontainer.json
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://raw.githubusercontent.com/devcontainers/spec/refs/heads/main/schemas/devContainer.schema.json",
|
||||||
|
"name": "devcontainer",
|
||||||
|
"dockerComposeFile": "docker-compose.yml",
|
||||||
|
"service": "devcontainer",
|
||||||
|
"workspaceFolder": "/workspaces",
|
||||||
|
"features": {
|
||||||
|
"ghcr.io/devcontainers/features/go:1": {
|
||||||
|
"version": "1.24"
|
||||||
|
},
|
||||||
|
"ghcr.io/guiyomh/features/golangci-lint:0": {},
|
||||||
|
"ghcr.io/jungaretti/features/make:1": {}
|
||||||
|
},
|
||||||
|
"forwardPorts": [
|
||||||
|
3000,
|
||||||
|
3001,
|
||||||
|
4200,
|
||||||
|
8080
|
||||||
|
],
|
||||||
|
"onCreateCommand": "pnpm install -g sass@1.64.1",
|
||||||
|
"customizations": {
|
||||||
|
"jetbrains": {
|
||||||
|
"settings": {
|
||||||
|
"com.intellij:app:HttpConfigurable.use_proxy_pac": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
225
.devcontainer/base/docker-compose.yml
Normal file
225
.devcontainer/base/docker-compose.yml
Normal file
@@ -0,0 +1,225 @@
|
|||||||
|
services:
|
||||||
|
|
||||||
|
devcontainer:
|
||||||
|
container_name: devcontainer
|
||||||
|
build:
|
||||||
|
context: .
|
||||||
|
volumes:
|
||||||
|
- ../../:/workspaces:cached
|
||||||
|
- /tmp/.X11-unix:/tmp/.X11-unix:cached
|
||||||
|
- home-dir:/home/node:delegated
|
||||||
|
command: sleep infinity
|
||||||
|
working_dir: /workspaces
|
||||||
|
environment:
|
||||||
|
ZITADEL_DATABASE_POSTGRES_HOST: db
|
||||||
|
ZITADEL_EXTERNALSECURE: false
|
||||||
|
|
||||||
|
db:
|
||||||
|
container_name: db
|
||||||
|
image: postgres:17.0-alpine3.19
|
||||||
|
restart: unless-stopped
|
||||||
|
volumes:
|
||||||
|
- postgres-data:/var/lib/postgresql/data
|
||||||
|
environment:
|
||||||
|
PGUSER: postgres
|
||||||
|
POSTGRES_PASSWORD: postgres
|
||||||
|
healthcheck:
|
||||||
|
test: [ "CMD-SHELL", "pg_isready" ]
|
||||||
|
interval: "10s"
|
||||||
|
timeout: "30s"
|
||||||
|
retries: 5
|
||||||
|
start_period: "20s"
|
||||||
|
ports:
|
||||||
|
- "5432:5432"
|
||||||
|
|
||||||
|
mock-zitadel:
|
||||||
|
container_name: mock-zitadel
|
||||||
|
build:
|
||||||
|
context: ../../apps/login/integration/core-mock
|
||||||
|
ports:
|
||||||
|
- 22220:22220
|
||||||
|
- 22222:22222
|
||||||
|
|
||||||
|
login-integration:
|
||||||
|
container_name: login-integration
|
||||||
|
build:
|
||||||
|
context: ../..
|
||||||
|
dockerfile: build/login/Dockerfile
|
||||||
|
image: "${LOGIN_TAG:-zitadel-login:local}"
|
||||||
|
env_file: ../../apps/login/.env.test
|
||||||
|
network_mode: service:devcontainer
|
||||||
|
environment:
|
||||||
|
NODE_ENV: test
|
||||||
|
PORT: 3001
|
||||||
|
depends_on:
|
||||||
|
mock-zitadel:
|
||||||
|
condition: service_started
|
||||||
|
|
||||||
|
zitadel:
|
||||||
|
image: "${ZITADEL_TAG:-ghcr.io/zitadel/zitadel:v4.0.0-rc.2}"
|
||||||
|
container_name: zitadel
|
||||||
|
command: 'start-from-init --masterkey "MasterkeyNeedsToHave32Characters" --config /zitadel.yaml --steps /zitadel.yaml'
|
||||||
|
volumes:
|
||||||
|
- ../../apps/login/acceptance/pat:/pat:delegated
|
||||||
|
- ../../apps/login/acceptance/zitadel.yaml:/zitadel.yaml:cached
|
||||||
|
network_mode: service:devcontainer
|
||||||
|
healthcheck:
|
||||||
|
test:
|
||||||
|
- CMD
|
||||||
|
- /app/zitadel
|
||||||
|
- ready
|
||||||
|
- --config
|
||||||
|
- /zitadel.yaml
|
||||||
|
depends_on:
|
||||||
|
db:
|
||||||
|
condition: "service_healthy"
|
||||||
|
|
||||||
|
configure-login:
|
||||||
|
container_name: configure-login
|
||||||
|
restart: no
|
||||||
|
build:
|
||||||
|
context: ../../apps/login/acceptance/setup
|
||||||
|
dockerfile: ../go-command.Dockerfile
|
||||||
|
entrypoint: "./setup.sh"
|
||||||
|
network_mode: service:devcontainer
|
||||||
|
environment:
|
||||||
|
PAT_FILE: /pat/zitadel-admin-sa.pat
|
||||||
|
ZITADEL_API_URL: http://localhost:8080
|
||||||
|
WRITE_ENVIRONMENT_FILE: /login-env/.env.test.local
|
||||||
|
SINK_EMAIL_INTERNAL_URL: http://sink:3333/email
|
||||||
|
SINK_SMS_INTERNAL_URL: http://sink:3333/sms
|
||||||
|
SINK_NOTIFICATION_URL: http://sink:3333/notification
|
||||||
|
LOGIN_BASE_URL: http://localhost:3000/ui/v2/login/
|
||||||
|
ZITADEL_API_DOMAIN: localhost
|
||||||
|
ZITADEL_ADMIN_USER: zitadel-admin@zitadel.localhost
|
||||||
|
volumes:
|
||||||
|
- ../../apps/login/acceptance/pat:/pat:cached # Read the PAT file from zitadels setup
|
||||||
|
- ../../apps/login:/login-env:delegated # Write the environment variables file for the login
|
||||||
|
depends_on:
|
||||||
|
zitadel:
|
||||||
|
condition: "service_healthy"
|
||||||
|
|
||||||
|
login-acceptance:
|
||||||
|
container_name: login
|
||||||
|
image: "${LOGIN_TAG:-ghcr.io/zitadel/zitadel-login:v4.0.0-rc.2}"
|
||||||
|
network_mode: service:devcontainer
|
||||||
|
volumes:
|
||||||
|
- ../../apps/login/.env.test.local:/env-files/.env:cached
|
||||||
|
depends_on:
|
||||||
|
configure-login:
|
||||||
|
condition: service_completed_successfully
|
||||||
|
|
||||||
|
mock-notifications:
|
||||||
|
container_name: mock-notifications
|
||||||
|
build:
|
||||||
|
context: ../../apps/login/acceptance/sink
|
||||||
|
dockerfile: ../go-command.Dockerfile
|
||||||
|
args:
|
||||||
|
- LOGIN_TEST_ACCEPTANCE_GOLANG_TAG=${LOGIN_TEST_ACCEPTANCE_GOLANG_TAG:-golang:1.24-alpine}
|
||||||
|
environment:
|
||||||
|
PORT: '3333'
|
||||||
|
command:
|
||||||
|
- -port
|
||||||
|
- '3333'
|
||||||
|
- -email
|
||||||
|
- '/email'
|
||||||
|
- -sms
|
||||||
|
- '/sms'
|
||||||
|
- -notification
|
||||||
|
- '/notification'
|
||||||
|
ports:
|
||||||
|
- "3333:3333"
|
||||||
|
depends_on:
|
||||||
|
configure-login:
|
||||||
|
condition: "service_completed_successfully"
|
||||||
|
|
||||||
|
mock-oidcrp:
|
||||||
|
container_name: mock-oidcrp
|
||||||
|
build:
|
||||||
|
context: ../../apps/login/acceptance/oidcrp
|
||||||
|
dockerfile: ../go-command.Dockerfile
|
||||||
|
args:
|
||||||
|
- LOGIN_TEST_ACCEPTANCE_GOLANG_TAG=${LOGIN_TEST_ACCEPTANCE_GOLANG_TAG:-golang:1.24-alpine}
|
||||||
|
network_mode: service:devcontainer
|
||||||
|
environment:
|
||||||
|
API_URL: 'http://localhost:8080'
|
||||||
|
API_DOMAIN: 'localhost'
|
||||||
|
PAT_FILE: '/pat/zitadel-admin-sa.pat'
|
||||||
|
LOGIN_URL: 'http://localhost:3000/ui/v2/login'
|
||||||
|
ISSUER: 'http://localhost:8000'
|
||||||
|
HOST: 'localhost'
|
||||||
|
PORT: '8000'
|
||||||
|
SCOPES: 'openid profile email'
|
||||||
|
volumes:
|
||||||
|
- ../../apps/login/acceptance/pat:/pat:cached
|
||||||
|
depends_on:
|
||||||
|
configure-login:
|
||||||
|
condition: "service_completed_successfully"
|
||||||
|
|
||||||
|
# mock-oidcop:
|
||||||
|
# container_name: mock-oidcop
|
||||||
|
# build:
|
||||||
|
# context: ../../apps/login/acceptance/idp/oidc
|
||||||
|
# dockerfile: ../../go-command.Dockerfile
|
||||||
|
# args:
|
||||||
|
# - LOGIN_TEST_ACCEPTANCE_GOLANG_TAG=${LOGIN_TEST_ACCEPTANCE_GOLANG_TAG:-golang:1.24-alpine}
|
||||||
|
# network_mode: service:devcontainer
|
||||||
|
# environment:
|
||||||
|
# API_URL: 'http://localhost:8080'
|
||||||
|
# API_DOMAIN: 'localhost'
|
||||||
|
# PAT_FILE: '/pat/zitadel-admin-sa.pat'
|
||||||
|
# SCHEMA: 'http'
|
||||||
|
# HOST: 'localhost'
|
||||||
|
# PORT: "8004"
|
||||||
|
# volumes:
|
||||||
|
# - "../apps/login/packages/acceptance/pat:/pat:cached"
|
||||||
|
# depends_on:
|
||||||
|
# configure-login:
|
||||||
|
# condition: "service_completed_successfully"
|
||||||
|
|
||||||
|
mock-samlsp:
|
||||||
|
container_name: mock-samlsp
|
||||||
|
build:
|
||||||
|
context: ../../apps/login/acceptance/samlsp
|
||||||
|
dockerfile: ../go-command.Dockerfile
|
||||||
|
args:
|
||||||
|
- LOGIN_TEST_ACCEPTANCE_GOLANG_TAG=${LOGIN_TEST_ACCEPTANCE_GOLANG_TAG:-golang:1.24-alpine}
|
||||||
|
network_mode: service:devcontainer
|
||||||
|
environment:
|
||||||
|
API_URL: 'http://localhost:8080'
|
||||||
|
API_DOMAIN: 'localhost'
|
||||||
|
PAT_FILE: '/pat/zitadel-admin-sa.pat'
|
||||||
|
LOGIN_URL: 'http://localhost:3000/ui/v2/login'
|
||||||
|
IDP_URL: 'http://localhost:8080/saml/v2/metadata'
|
||||||
|
HOST: 'http://localhost:8001'
|
||||||
|
PORT: '8001'
|
||||||
|
volumes:
|
||||||
|
- "../apps/login/packages/acceptance/pat:/pat:cached"
|
||||||
|
depends_on:
|
||||||
|
configure-login:
|
||||||
|
condition: "service_completed_successfully"
|
||||||
|
|
||||||
|
# mock-samlidp:
|
||||||
|
# container_name: mock-samlidp
|
||||||
|
# build:
|
||||||
|
# context: ../../apps/login/acceptance/idp/saml
|
||||||
|
# dockerfile: ../../go-command.Dockerfile
|
||||||
|
# args:
|
||||||
|
# - LOGIN_TEST_ACCEPTANCE_GOLANG_TAG=${LOGIN_TEST_ACCEPTANCE_GOLANG_TAG:-golang:1.24-alpine}
|
||||||
|
# network_mode: service:devcontainer
|
||||||
|
# environment:
|
||||||
|
# API_URL: 'http://localhost:8080'
|
||||||
|
# API_DOMAIN: 'localhost'
|
||||||
|
# PAT_FILE: '/pat/zitadel-admin-sa.pat'
|
||||||
|
# SCHEMA: 'http'
|
||||||
|
# HOST: 'localhost'
|
||||||
|
# PORT: "8003"
|
||||||
|
# volumes:
|
||||||
|
# - "../apps/login/packages/acceptance/pat:/pat"
|
||||||
|
# depends_on:
|
||||||
|
# configure-login:
|
||||||
|
# condition: "service_completed_successfully"
|
||||||
|
|
||||||
|
volumes:
|
||||||
|
postgres-data:
|
||||||
|
home-dir:
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "zitadel",
|
|
||||||
"dockerComposeFile": "docker-compose.yml",
|
|
||||||
"service": "devcontainer",
|
|
||||||
"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
|
|
||||||
"features": {
|
|
||||||
"ghcr.io/devcontainers/features/go:1": {
|
|
||||||
"version": "1.22"
|
|
||||||
},
|
|
||||||
"ghcr.io/devcontainers/features/node:1": {},
|
|
||||||
"ghcr.io/guiyomh/features/golangci-lint:0": {},
|
|
||||||
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
|
|
||||||
"ghcr.io/devcontainers/features/github-cli:1": {},
|
|
||||||
"ghcr.io/jungaretti/features/make:1": {}
|
|
||||||
},
|
|
||||||
"forwardPorts": [
|
|
||||||
3000,
|
|
||||||
4200,
|
|
||||||
8080
|
|
||||||
],
|
|
||||||
"onCreateCommand": "npm install -g sass@1.64.1"
|
|
||||||
}
|
|
||||||
@@ -1,31 +0,0 @@
|
|||||||
version: '3.8'
|
|
||||||
services:
|
|
||||||
devcontainer:
|
|
||||||
image: mcr.microsoft.com/devcontainers/base:ubuntu
|
|
||||||
volumes:
|
|
||||||
- ../..:/workspaces:cached
|
|
||||||
- /var/run/docker.sock:/var/run/docker.sock
|
|
||||||
network_mode: service:db
|
|
||||||
command: sleep infinity
|
|
||||||
environment:
|
|
||||||
ZITADEL_DATABASE_POSTGRES_HOST: db
|
|
||||||
ZITADEL_DATABASE_POSTGRES_PORT: 5432
|
|
||||||
ZITADEL_DATABASE_POSTGRES_DATABASE: zitadel
|
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_USERNAME: zitadel
|
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_PASSWORD: zitadel
|
|
||||||
ZITADEL_DATABASE_POSTGRES_USER_SSL_MODE: disable
|
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_USERNAME: postgres
|
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_PASSWORD: postgres
|
|
||||||
ZITADEL_DATABASE_POSTGRES_ADMIN_SSL_MODE: disable
|
|
||||||
ZITADEL_EXTERNALSECURE: false
|
|
||||||
db:
|
|
||||||
image: postgres:latest
|
|
||||||
restart: unless-stopped
|
|
||||||
volumes:
|
|
||||||
- postgres-data:/var/lib/postgresql/data
|
|
||||||
environment:
|
|
||||||
PGUSER: postgres
|
|
||||||
POSTGRES_PASSWORD: postgres
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
postgres-data:
|
|
||||||
21
.devcontainer/login-integration-debug/devcontainer.json
Normal file
21
.devcontainer/login-integration-debug/devcontainer.json
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://raw.githubusercontent.com/devcontainers/spec/refs/heads/main/schemas/devContainer.schema.json",
|
||||||
|
"name": "login-integration-debug",
|
||||||
|
"dockerComposeFile": [
|
||||||
|
"../base/docker-compose.yml",
|
||||||
|
"docker-compose.yml"
|
||||||
|
],
|
||||||
|
"service": "login-integration-debug",
|
||||||
|
"runServices": ["login-integration-debug"],
|
||||||
|
"workspaceFolder": "/workspaces",
|
||||||
|
"forwardPorts": [3001],
|
||||||
|
"onCreateCommand": "pnpm install --recursive",
|
||||||
|
"postAttachCommand": "pnpm turbo daemon clean; pnpm turbo @zitadel/login#dev test:integration:login:debug",
|
||||||
|
"customizations": {
|
||||||
|
"jetbrains": {
|
||||||
|
"settings": {
|
||||||
|
"com.intellij:app:HttpConfigurable.use_proxy_pac": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
9
.devcontainer/login-integration-debug/docker-compose.yml
Normal file
9
.devcontainer/login-integration-debug/docker-compose.yml
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
services:
|
||||||
|
login-integration-debug:
|
||||||
|
extends:
|
||||||
|
file: ../base/docker-compose.yml
|
||||||
|
service: devcontainer
|
||||||
|
container_name: login-integration-debug
|
||||||
|
depends_on:
|
||||||
|
mock-zitadel:
|
||||||
|
condition: service_started
|
||||||
19
.devcontainer/login-integration/devcontainer.json
Normal file
19
.devcontainer/login-integration/devcontainer.json
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://raw.githubusercontent.com/devcontainers/spec/refs/heads/main/schemas/devContainer.schema.json",
|
||||||
|
"name": "login-integration",
|
||||||
|
"dockerComposeFile": [
|
||||||
|
"../base/docker-compose.yml"
|
||||||
|
],
|
||||||
|
"service": "devcontainer",
|
||||||
|
"runServices": ["login-integration"],
|
||||||
|
"workspaceFolder": "/workspaces",
|
||||||
|
"forwardPorts": [3001],
|
||||||
|
"onCreateCommand": "pnpm install --frozen-lockfile --recursive && cd apps/login/packages/integration && pnpm cypress install && pnpm test:integration:login",
|
||||||
|
"customizations": {
|
||||||
|
"jetbrains": {
|
||||||
|
"settings": {
|
||||||
|
"com.intellij:app:HttpConfigurable.use_proxy_pac": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
21
.devcontainer/turbo-lint-unit-debug/devcontainer.json
Normal file
21
.devcontainer/turbo-lint-unit-debug/devcontainer.json
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://raw.githubusercontent.com/devcontainers/spec/refs/heads/main/schemas/devContainer.schema.json",
|
||||||
|
"name": "turbo-lint-unit-debug",
|
||||||
|
"dockerComposeFile": [
|
||||||
|
"../base/docker-compose.yml",
|
||||||
|
"docker-compose.yml"
|
||||||
|
],
|
||||||
|
"service": "turbo-lint-unit-debug",
|
||||||
|
"runServices": ["turbo-lint-unit-debug"],
|
||||||
|
"workspaceFolder": "/workspaces",
|
||||||
|
"forwardPorts": [3001],
|
||||||
|
"onCreateCommand": "pnpm install --recursive",
|
||||||
|
"postAttachCommand": "pnpm turbo daemon clean; pnpm turbo watch lint test:unit",
|
||||||
|
"customizations": {
|
||||||
|
"jetbrains": {
|
||||||
|
"settings": {
|
||||||
|
"com.intellij:app:HttpConfigurable.use_proxy_pac": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
6
.devcontainer/turbo-lint-unit-debug/docker-compose.yml
Normal file
6
.devcontainer/turbo-lint-unit-debug/docker-compose.yml
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
services:
|
||||||
|
turbo-lint-unit-debug:
|
||||||
|
extends:
|
||||||
|
file: ../base/docker-compose.yml
|
||||||
|
service: devcontainer
|
||||||
|
container_name: turbo-lint-unit-debug
|
||||||
18
.devcontainer/turbo-lint-unit/devcontainer.json
Normal file
18
.devcontainer/turbo-lint-unit/devcontainer.json
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://raw.githubusercontent.com/devcontainers/spec/refs/heads/main/schemas/devContainer.schema.json",
|
||||||
|
"name": "turbo-lint-unit",
|
||||||
|
"dockerComposeFile": [
|
||||||
|
"../base/docker-compose.yml"
|
||||||
|
],
|
||||||
|
"service": "devcontainer",
|
||||||
|
"runServices": ["devcontainer"],
|
||||||
|
"workspaceFolder": "/workspaces",
|
||||||
|
"postStartCommand": "pnpm install --frozen-lockfile --recursive && pnpm turbo lint test:unit",
|
||||||
|
"customizations": {
|
||||||
|
"jetbrains": {
|
||||||
|
"settings": {
|
||||||
|
"com.intellij:app:HttpConfigurable.use_proxy_pac": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
14
.github/workflows/build.yml
vendored
14
.github/workflows/build.yml
vendored
@@ -86,18 +86,6 @@ jobs:
|
|||||||
core_cache_key: ${{ needs.core.outputs.cache_key }}
|
core_cache_key: ${{ needs.core.outputs.cache_key }}
|
||||||
core_cache_path: ${{ needs.core.outputs.cache_path }}
|
core_cache_path: ${{ needs.core.outputs.cache_path }}
|
||||||
|
|
||||||
login-quality:
|
|
||||||
needs: [compile]
|
|
||||||
uses: ./.github/workflows/login-quality.yml
|
|
||||||
permissions:
|
|
||||||
actions: write
|
|
||||||
id-token: write
|
|
||||||
with:
|
|
||||||
ignore-run-cache: ${{ github.event_name == 'workflow_dispatch' || fromJSON(github.run_attempt) > 1 }}
|
|
||||||
node_version: "20"
|
|
||||||
secrets:
|
|
||||||
DEPOT_TOKEN: ${{ secrets.DEPOT_TOKEN }}
|
|
||||||
|
|
||||||
container:
|
container:
|
||||||
needs: [compile]
|
needs: [compile]
|
||||||
uses: ./.github/workflows/container.yml
|
uses: ./.github/workflows/container.yml
|
||||||
@@ -110,7 +98,6 @@ jobs:
|
|||||||
|
|
||||||
login-container:
|
login-container:
|
||||||
uses: ./.github/workflows/login-container.yml
|
uses: ./.github/workflows/login-container.yml
|
||||||
if: ${{ github.event_name == 'workflow_dispatch' }}
|
|
||||||
permissions:
|
permissions:
|
||||||
packages: write
|
packages: write
|
||||||
id-token: write
|
id-token: write
|
||||||
@@ -139,7 +126,6 @@ jobs:
|
|||||||
lint,
|
lint,
|
||||||
container,
|
container,
|
||||||
login-container,
|
login-container,
|
||||||
login-quality,
|
|
||||||
e2e,
|
e2e,
|
||||||
]
|
]
|
||||||
if: ${{ github.event_name == 'workflow_dispatch' }}
|
if: ${{ github.event_name == 'workflow_dispatch' }}
|
||||||
|
|||||||
2
.github/workflows/console.yml
vendored
2
.github/workflows/console.yml
vendored
@@ -50,7 +50,7 @@ jobs:
|
|||||||
cache-dependency-path: pnpm-lock.yaml
|
cache-dependency-path: pnpm-lock.yaml
|
||||||
- if: ${{ steps.cache.outputs.cache-hit != 'true' }}
|
- if: ${{ steps.cache.outputs.cache-hit != 'true' }}
|
||||||
name: Install dependencies
|
name: Install dependencies
|
||||||
run: pnpm install
|
run: pnpm install --frozen-lockfile
|
||||||
- if: ${{ steps.cache.outputs.cache-hit != 'true' }}
|
- if: ${{ steps.cache.outputs.cache-hit != 'true' }}
|
||||||
name: Build console with Turbo
|
name: Build console with Turbo
|
||||||
run: pnpm turbo build --filter=./console
|
run: pnpm turbo build --filter=./console
|
||||||
|
|||||||
4
.github/workflows/container.yml
vendored
4
.github/workflows/container.yml
vendored
@@ -79,7 +79,7 @@ jobs:
|
|||||||
context: .
|
context: .
|
||||||
cache-from: type=gha
|
cache-from: type=gha
|
||||||
cache-to: type=gha,mode=max
|
cache-to: type=gha,mode=max
|
||||||
file: build/Dockerfile
|
file: build/zitadel/Dockerfile
|
||||||
target: artifact
|
target: artifact
|
||||||
platforms: linux/${{ matrix.arch }}
|
platforms: linux/${{ matrix.arch }}
|
||||||
push: true
|
push: true
|
||||||
@@ -94,7 +94,7 @@ jobs:
|
|||||||
context: .
|
context: .
|
||||||
cache-from: type=gha
|
cache-from: type=gha
|
||||||
cache-to: type=gha,mode=max
|
cache-to: type=gha,mode=max
|
||||||
file: build/Dockerfile
|
file: build/zitadel/Dockerfile
|
||||||
target: final
|
target: final
|
||||||
platforms: linux/${{ matrix.arch }}
|
platforms: linux/${{ matrix.arch }}
|
||||||
push: true
|
push: true
|
||||||
|
|||||||
19
.github/workflows/lint.yml
vendored
19
.github/workflows/lint.yml
vendored
@@ -46,22 +46,19 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
against: "https://github.com/${{ github.repository }}.git#branch=${{ github.base_ref }}"
|
against: "https://github.com/${{ github.repository }}.git#branch=${{ github.base_ref }}"
|
||||||
|
|
||||||
console:
|
turbo-lint-unit:
|
||||||
if: ${{ github.event_name == 'pull_request' }}
|
if: ${{ github.event_name == 'pull_request' }}
|
||||||
name: console
|
name: turbo-lint-unit
|
||||||
runs-on: ubuntu-latest
|
runs-on: depot-ubuntu-22.04-8
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
- uses: pnpm/action-setup@v4
|
- name: Run lint and unit tests in dev container
|
||||||
- uses: actions/setup-node@v4
|
uses: devcontainers/ci@v0.3
|
||||||
with:
|
with:
|
||||||
node-version: ${{ inputs.node_version }}
|
push: never
|
||||||
cache: "pnpm"
|
configFile: .devcontainer/turbo-lint-unit/devcontainer.json
|
||||||
cache-dependency-path: pnpm-lock.yaml
|
runCmd: echo "Successfully ran lint and unit tests in dev container postStartCommand"
|
||||||
- run: pnpm install --filter=console
|
|
||||||
- name: lint
|
|
||||||
run: make console_lint
|
|
||||||
|
|
||||||
core:
|
core:
|
||||||
name: core
|
name: core
|
||||||
|
|||||||
5
.github/workflows/login-container.yml
vendored
5
.github/workflows/login-container.yml
vendored
@@ -62,10 +62,9 @@ jobs:
|
|||||||
provenance: true
|
provenance: true
|
||||||
sbom: true
|
sbom: true
|
||||||
targets: login-standalone
|
targets: login-standalone
|
||||||
set: login-*.context=./login/
|
|
||||||
project: w47wkxzdtw
|
project: w47wkxzdtw
|
||||||
files: |
|
files: |
|
||||||
./login/docker-bake.hcl
|
./apps/login/docker-bake.hcl
|
||||||
./login/docker-bake-release.hcl
|
./apps/login/docker-bake-release.hcl
|
||||||
./docker-bake.hcl
|
./docker-bake.hcl
|
||||||
cwd://${{ steps.login-meta.outputs.bake-file }}
|
cwd://${{ steps.login-meta.outputs.bake-file }}
|
||||||
|
|||||||
69
.github/workflows/login-quality.yml
vendored
69
.github/workflows/login-quality.yml
vendored
@@ -1,69 +0,0 @@
|
|||||||
name: Login Quality
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_call:
|
|
||||||
inputs:
|
|
||||||
ignore-run-cache:
|
|
||||||
description: "Ignore run caches"
|
|
||||||
type: boolean
|
|
||||||
required: true
|
|
||||||
node_version:
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
secrets:
|
|
||||||
DEPOT_TOKEN:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
quality:
|
|
||||||
name: Ensure Quality
|
|
||||||
runs-on: depot-ubuntu-22.04-8
|
|
||||||
timeout-minutes: 30
|
|
||||||
permissions:
|
|
||||||
actions: write
|
|
||||||
env:
|
|
||||||
CACHE_DIR: /tmp/login-run-caches
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: depot/setup-action@v1
|
|
||||||
- name: Restore Run Caches
|
|
||||||
uses: actions/cache/restore@v4
|
|
||||||
id: run-caches-restore
|
|
||||||
with:
|
|
||||||
path: ${{ env.CACHE_DIR }}
|
|
||||||
key: ${{ runner.os }}-login-run-caches-${{github.ref_name}}-${{ github.sha }}-${{github.run_attempt}}
|
|
||||||
restore-keys: |
|
|
||||||
${{ runner.os }}-login-run-caches-${{github.ref_name}}-${{ github.sha }}-
|
|
||||||
${{ runner.os }}-login-run-caches-${{github.ref_name}}-
|
|
||||||
${{ runner.os }}-login-run-caches-
|
|
||||||
- uses: actions/download-artifact@v4
|
|
||||||
with:
|
|
||||||
path: .artifacts
|
|
||||||
name: zitadel-linux-amd64
|
|
||||||
- name: Unpack executable
|
|
||||||
run: |
|
|
||||||
tar -xvf .artifacts/zitadel-linux-amd64.tar.gz
|
|
||||||
mv zitadel-linux-amd64/zitadel ./zitadel
|
|
||||||
- uses: pnpm/action-setup@v4
|
|
||||||
- uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: ${{ inputs.node_version }}
|
|
||||||
cache: "pnpm"
|
|
||||||
cache-dependency-path: pnpm-lock.yaml
|
|
||||||
- name: Install dependencies
|
|
||||||
run: pnpm install
|
|
||||||
- name: Run login quality checks with Turbo
|
|
||||||
run: pnpm turbo test:unit --filter=@zitadel/login
|
|
||||||
env:
|
|
||||||
DEPOT_TOKEN: ${{ secrets.DEPOT_TOKEN }}
|
|
||||||
LOGIN_BAKE_CLI: depot bake
|
|
||||||
DEPOT_PROJECT_ID: w47wkxzdtw
|
|
||||||
IGNORE_RUN_CACHE: ${{ github.event.inputs.ignore-run-cache }}
|
|
||||||
NODE_VERSION: ${{ inputs.node_version }}
|
|
||||||
|
|
||||||
- name: Save Run Caches
|
|
||||||
uses: actions/cache/save@v4
|
|
||||||
with:
|
|
||||||
path: ${{ env.CACHE_DIR }}
|
|
||||||
key: ${{ steps.run-caches-restore.outputs.cache-primary-key }}
|
|
||||||
if: always()
|
|
||||||
9
.github/workflows/release.yml
vendored
9
.github/workflows/release.yml
vendored
@@ -165,7 +165,7 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
gh workflow -R zitadel/zitadel-charts run bump.yml
|
gh workflow -R zitadel/zitadel-charts run bump.yml
|
||||||
|
|
||||||
typescript-packages:
|
npm-packages:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: version
|
needs: version
|
||||||
if: ${{ github.ref_name == 'next' }}
|
if: ${{ github.ref_name == 'next' }}
|
||||||
@@ -184,7 +184,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
working-directory: login
|
working-directory: login
|
||||||
run: pnpm install
|
run: pnpm install --frozen-lockfile
|
||||||
|
|
||||||
- name: Create Release Pull Request
|
- name: Create Release Pull Request
|
||||||
uses: changesets/action@v1
|
uses: changesets/action@v1
|
||||||
@@ -192,9 +192,10 @@ jobs:
|
|||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
with:
|
with:
|
||||||
version: ${{ needs.version.outputs.version }}
|
version: ${{ needs.version.outputs.version }}
|
||||||
cwd: login
|
cwd: packages
|
||||||
|
createGithubReleases: false
|
||||||
|
|
||||||
typescript-repo:
|
login-repo:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: version
|
needs: version
|
||||||
if: ${{ github.ref_name == 'next' }}
|
if: ${{ github.ref_name == 'next' }}
|
||||||
|
|||||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -7,6 +7,7 @@
|
|||||||
|
|
||||||
# Test binary, build with `go test -c`
|
# Test binary, build with `go test -c`
|
||||||
*.test
|
*.test
|
||||||
|
!/**/.env.test
|
||||||
|
|
||||||
# Coverage
|
# Coverage
|
||||||
coverage.txt
|
coverage.txt
|
||||||
@@ -68,6 +69,7 @@ docs/docs/apis/proto
|
|||||||
/internal/api/ui/login/static/resources/themes/zitadel/css/zitadel.css
|
/internal/api/ui/login/static/resources/themes/zitadel/css/zitadel.css
|
||||||
/internal/api/ui/login/static/resources/themes/zitadel/css/zitadel.css.map
|
/internal/api/ui/login/static/resources/themes/zitadel/css/zitadel.css.map
|
||||||
zitadel-*-*
|
zitadel-*-*
|
||||||
|
!apps/**/zitadel-*-*
|
||||||
|
|
||||||
# local
|
# local
|
||||||
build/local/*.env
|
build/local/*.env
|
||||||
@@ -92,3 +94,6 @@ load-test/output/*
|
|||||||
# Turbo
|
# Turbo
|
||||||
.turbo/
|
.turbo/
|
||||||
**/.turbo/
|
**/.turbo/
|
||||||
|
|
||||||
|
# PNPM
|
||||||
|
.pnpm-store
|
||||||
576
CONTRIBUTING.md
576
CONTRIBUTING.md
@@ -1,4 +1,5 @@
|
|||||||
# Contributing to ZITADEL
|
# Contributing to Zitadel
|
||||||
|
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
@@ -12,84 +13,28 @@ If you want to give an answer or be part of discussions please be kind. Treat ot
|
|||||||
|
|
||||||
## What can I contribute?
|
## What can I contribute?
|
||||||
|
|
||||||
For people who are new to ZITADEL: We flag issues which are a good starting point to start contributing. You find them [here](https://github.com/zitadel/zitadel/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
For people who are new to Zitadel: We flag issues which are a good starting point to start contributing.
|
||||||
|
You find them [here](https://github.com/zitadel/zitadel/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
||||||
|
We add the label "good first issue" for problems we think are a good starting point to contribute to Zitadel.
|
||||||
|
|
||||||
Make ZITADEL more popular and give it a ⭐
|
- [Issues for first time contributors](https://github.com/zitadel/zitadel/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
||||||
|
- [All issues](https://github.com/zitadel/zitadel/issues)
|
||||||
|
|
||||||
Help shaping the future of ZITADEL:
|
Help shaping the future of Zitadel:
|
||||||
|
|
||||||
- Join our [chat](https://zitadel.com/chat) and discuss with us or others.
|
- Join our [chat](https://zitadel.com/chat) and discuss with us or others.
|
||||||
- Ask or answer questions in the [issues section](https://github.com/zitadel/zitadel/issues)
|
- Ask or answer questions in the [issues section](https://github.com/zitadel/zitadel/issues)
|
||||||
- Share your thoughts and ideas in the [discussions section](https://github.com/zitadel/zitadel/discussions)
|
- Share your thoughts and ideas in the [discussions section](https://github.com/zitadel/zitadel/discussions)
|
||||||
|
|
||||||
[Contribute](#how-to-contribute)
|
Make Zitadel more popular and give it a ⭐
|
||||||
|
|
||||||
- [Contribute code](#contribute)
|
|
||||||
- If you found a mistake on our [docs page](https://zitadel.com/docs) or something is missing please read [the docs section](#contribute-docs)
|
|
||||||
- [Translate](#contribute-internationalization) and improve texts
|
|
||||||
|
|
||||||
Follow [@zitadel](https://twitter.com/zitadel) on twitter
|
Follow [@zitadel](https://twitter.com/zitadel) on twitter
|
||||||
|
|
||||||
## Quick Start for Contributors
|
[Contribute](#how-to-contribute)
|
||||||
|
|
||||||
ZITADEL uses **pnpm** as package manager and **Turbo** for build orchestration across the monorepo. Here are the most common commands you'll need:
|
- [Contribute code](#contribute)
|
||||||
|
- If you found a mistake on our [docs page](https://zitadel.com/docs) or something is missing please read [the docs section](contribute-docs)
|
||||||
### Prerequisites
|
- [Translate](#contribute-internationalization) and improve texts
|
||||||
|
|
||||||
- [Node version v20.x](https://nodejs.org/en/download/)
|
|
||||||
- [pnpm version 9.x](https://pnpm.io/installation)
|
|
||||||
- [Docker](https://docs.docker.com/engine/install/) for running databases and services
|
|
||||||
|
|
||||||
### Common Development Commands
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install all dependencies across the monorepo
|
|
||||||
pnpm install
|
|
||||||
|
|
||||||
# Start the backend database and ZITADEL server
|
|
||||||
docker compose --file ./e2e/docker-compose.yaml up --detach zitadel
|
|
||||||
|
|
||||||
# Develop the Console (Angular app)
|
|
||||||
pnpm turbo dev --filter=console
|
|
||||||
|
|
||||||
# Develop the Login UI (Next.js app)
|
|
||||||
pnpm turbo dev --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Develop the Documentation (Docusaurus)
|
|
||||||
pnpm turbo dev --filter=zitadel-docs
|
|
||||||
|
|
||||||
# Build everything
|
|
||||||
pnpm turbo build
|
|
||||||
|
|
||||||
# Lint and fix code across all packages
|
|
||||||
pnpm turbo lint
|
|
||||||
|
|
||||||
# Run tests
|
|
||||||
pnpm turbo test
|
|
||||||
|
|
||||||
# Clean up
|
|
||||||
docker compose --file ./e2e/docker-compose.yaml down
|
|
||||||
```
|
|
||||||
|
|
||||||
### Monorepo Structure
|
|
||||||
|
|
||||||
The repository is organized as follows:
|
|
||||||
|
|
||||||
| Package | Description | Technology | Development Command |
|
|
||||||
| ----------------- | --------------------------- | ------------------- | --------------------------------------------- |
|
|
||||||
| `console` | Management UI (post-login) | Angular, TypeScript | `pnpm turbo dev --filter=console` |
|
|
||||||
| `@zitadel/login` | Authentication UI | Next.js, React | `pnpm turbo dev --filter=@zitadel/login` |
|
|
||||||
| `zitadel-docs` | Documentation site | Docusaurus | `pnpm turbo dev --filter=zitadel-docs` |
|
|
||||||
| `@zitadel/client` | TypeScript client library | TypeScript | `pnpm turbo build --filter=@zitadel/client` |
|
|
||||||
| `@zitadel/proto` | Protocol buffer definitions | Protobuf | `pnpm turbo generate --filter=@zitadel/proto` |
|
|
||||||
|
|
||||||
### Development Workflow
|
|
||||||
|
|
||||||
1. **Start the backend**: `docker compose --file ./e2e/docker-compose.yaml up --detach zitadel`
|
|
||||||
2. **Choose your focus**: Run one of the development commands above
|
|
||||||
3. **Make changes**: Edit code with live reload feedback
|
|
||||||
4. **Test your changes**: Use the appropriate test commands
|
|
||||||
5. **Cleanup**: `docker compose --file ./e2e/docker-compose.yaml down`
|
|
||||||
|
|
||||||
## How to contribute
|
## How to contribute
|
||||||
|
|
||||||
@@ -101,6 +46,21 @@ If you are unfamiliar with git have a look at Github's documentation on [creatin
|
|||||||
Please draft the pull request as soon as possible.
|
Please draft the pull request as soon as possible.
|
||||||
Go through the following checklist before you submit the final pull request:
|
Go through the following checklist before you submit the final pull request:
|
||||||
|
|
||||||
|
### Components
|
||||||
|
|
||||||
|
The code consists of the following parts:
|
||||||
|
|
||||||
|
| name | description | language | where to find | Development Guide |
|
||||||
|
| --------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------- |
|
||||||
|
| backend | Service that serves the grpc(-web) and RESTful API | [go](https://go.dev) | [API implementation](./internal/api/grpc) | [Contribute to Backend](contribute-backend) |
|
||||||
|
| API definitions | Specifications of the API | [Protobuf](https://developers.google.com/protocol-buffers) | [./proto/zitadel](./proto/zitadel) | [Contribute to Backend](contribute-backend) |
|
||||||
|
| console | Frontend the user interacts with after log in | [Angular](https://angular.io), [Typescript](https://www.typescriptlang.org) | [./console](./console) | [Contribute to Frontend](contribute-frontend) |
|
||||||
|
| login | Modern authentication UI built with Next.js | [Next.js](https://nextjs.org), [React](https://reactjs.org), [TypeScript](https://www.typescriptlang.org) | [./login](./login) | [Contribute to Frontend](contribute-frontend) |
|
||||||
|
| docs | Project documentation made with docusaurus | [Docusaurus](https://docusaurus.io/) | [./docs](./docs) | [Contribute to Frontend](contribute-frontend) |
|
||||||
|
| translations | Internationalization files for default languages | YAML | [./console](./console) and [./internal](./internal) | [Contribute Translations](contribute-translations) |
|
||||||
|
|
||||||
|
Please follow the guides to validate and test the code before you contribute.
|
||||||
|
|
||||||
### Submit a pull request (PR)
|
### Submit a pull request (PR)
|
||||||
|
|
||||||
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [zitadel/zitadel](https://github.com/zitadel/zitadel) repository on GitHub
|
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [zitadel/zitadel](https://github.com/zitadel/zitadel) repository on GitHub
|
||||||
@@ -165,27 +125,6 @@ Please make sure you cover your changes with tests before marking a Pull Request
|
|||||||
- [ ] Integration tests ensure that certain commands emit expected events that trigger notifications.
|
- [ ] Integration tests ensure that certain commands emit expected events that trigger notifications.
|
||||||
- [ ] Integration tests ensure that certain events trigger expected notifications.
|
- [ ] Integration tests ensure that certain events trigger expected notifications.
|
||||||
|
|
||||||
## Contribute
|
|
||||||
|
|
||||||
The code consists of the following parts:
|
|
||||||
|
|
||||||
| name | description | language | where to find |
|
|
||||||
| --------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
|
|
||||||
| backend | Service that serves the grpc(-web) and RESTful API | [go](https://go.dev) | [API implementation](./internal/api/grpc) |
|
|
||||||
| console | Frontend the user interacts with after log in | [Angular](https://angular.io), [Typescript](https://www.typescriptlang.org) | [./console](./console) |
|
|
||||||
| login | Modern authentication UI built with Next.js | [Next.js](https://nextjs.org), [React](https://reactjs.org), [TypeScript](https://www.typescriptlang.org) | [./login](./login) |
|
|
||||||
| API definitions | Specifications of the API | [Protobuf](https://developers.google.com/protocol-buffers) | [./proto/zitadel](./proto/zitadel) |
|
|
||||||
| docs | Project documentation made with docusaurus | [Docusaurus](https://docusaurus.io/) | [./docs](./docs) |
|
|
||||||
|
|
||||||
**Important**: This repository uses **pnpm** as package manager and **Turbo** for build orchestration. All frontend packages (console, login, docs) are managed as a monorepo with shared dependencies and optimized builds.
|
|
||||||
|
|
||||||
Please validate and test the code before you contribute.
|
|
||||||
|
|
||||||
We add the label "good first issue" for problems we think are a good starting point to contribute to ZITADEL.
|
|
||||||
|
|
||||||
- [Issues for first time contributors](https://github.com/zitadel/zitadel/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
|
||||||
- [All issues](https://github.com/zitadel/zitadel/issues)
|
|
||||||
|
|
||||||
### General Guidelines
|
### General Guidelines
|
||||||
|
|
||||||
#### Gender Neutrality and Inclusive Language
|
#### Gender Neutrality and Inclusive Language
|
||||||
@@ -206,34 +145,62 @@ Choose alternative words depending on the context.
|
|||||||
|
|
||||||
### API
|
### API
|
||||||
|
|
||||||
ZITADEL follows an API first approach. This means all features can not only be accessed via the UI but also via the API.
|
Zitadel follows an API first approach. This means all features can not only be accessed via the UI but also via the API.
|
||||||
The API is designed to be used by different clients, such as web applications, mobile applications, and other services.
|
The API is designed to be used by different clients, such as web applications, mobile applications, and other services.
|
||||||
Therefore, the API is designed to be easy to use, consistent, and reliable.
|
Therefore, the API is designed to be easy to use, consistent, and reliable.
|
||||||
Please check out the dedicated [API guidelines](./API_DESIGN.md) page when contributing to the API.
|
Please check out the dedicated [API guidelines](./API_DESIGN.md) page when contributing to the API.
|
||||||
|
|
||||||
### Developing ZITADEL with Dev Containers
|
|
||||||
|
|
||||||
Follow the instructions provided by your code editor/IDE to initiate the development container. This typically involves opening the "Command Palette" or similar functionality and searching for commands related to "Dev Containers" or "Remote Containers". The quick start guide for VS Code can found [here](https://code.visualstudio.com/docs/devcontainers/containers#_quick-start-open-an-existing-folder-in-a-container)
|
#### <a name="dev-containers"></>Developing Zitadel with Dev Containers
|
||||||
|
|
||||||
When you are connected to the container run the following commands to start ZITADEL.
|
You can use dev containers if you'd like to make sure you have the same development environment like the corresponding GitHub PR checks use.
|
||||||
|
The following dev containers are available:
|
||||||
|
|
||||||
|
- **.devcontainer/base/devcontainer.json**: Contains everything you need to run whatever you want.
|
||||||
|
- **.devcontainer/turbo-lint-unit/devcontainer.json**: Runs a dev container that executes frontent linting and unit tests and then exits. This is useful to reproduce the corresponding GitHub PR check.
|
||||||
|
- **.devcontainer/turbo-lint-unit-debug/devcontainer.json**: Runs a dev container that executes frontent linting and unit tests in watch mode. You can fix the errors right away and have immediate feedback.
|
||||||
|
- **.devcontainer/login-integration/devcontainer.json**: Runs a dev container that executes login integration tests and then exits. This is useful to reproduce the corresponding GitHub PR check.
|
||||||
|
- **.devcontainer/login-integration-debug/devcontainer.json**: Runs a dev container that spins up the login in a hot-reloading dev server and executes login integration tests interactively. You can fix the errors right away and have immediate feedback.
|
||||||
|
|
||||||
|
You can also run the GitHub PR checks locally in dev containers without having to connect to a dev container.
|
||||||
|
|
||||||
|
|
||||||
|
The following pnpm commands use the [devcontainer CLI](https://github.com/devcontainers/cli/) and exit when the checks are done.
|
||||||
|
The minimal system requirements are having Docker and the devcontainers CLI installed.
|
||||||
|
If you don't have the node_modules installed already, you need to install the devcontainers CLI manually. Run `npm i -g @devcontainers/cli`. Alternatively, the [official Microsoft VS Code extension for Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) offers a command `Dev Containers: Install devcontainer CLI`
|
||||||
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run devcontainer:lint-unit
|
||||||
|
npm run devcontainer:integration:login
|
||||||
|
```
|
||||||
|
|
||||||
|
If you don't have NPM installed, copy and execute the scripts from the package.json directly.
|
||||||
|
|
||||||
|
To connect to a dev container to have full IDE support, follow the instructions provided by your code editor/IDE to initiate the dev container.
|
||||||
|
This typically involves opening the "Command Palette" or similar functionality and searching for commands related to "Dev Containers" or "Remote Containers".
|
||||||
|
The quick start guide for VS Code can found [here](https://code.visualstudio.com/docs/devcontainers/containers#_quick-start-open-an-existing-folder-in-a-container)
|
||||||
|
|
||||||
|
For example, to build and run the Zitadel binary in a dev container, connect your IDE to the dev container described in .devcontainer/base/devcontainer.json.
|
||||||
|
Run the following commands inside the container to start Zitadel.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make compile && ./zitadel start-from-init --masterkey MasterkeyNeedsToHave32Characters --tlsMode disabled
|
make compile && ./zitadel start-from-init --masterkey MasterkeyNeedsToHave32Characters --tlsMode disabled
|
||||||
```
|
```
|
||||||
|
|
||||||
ZITADEL serves traffic as soon as you can see the following log line:
|
Zitadel serves traffic as soon as you can see the following log line:
|
||||||
|
|
||||||
`INFO[0001] server is listening on [::]:8080`
|
`INFO[0001] server is listening on [::]:8080`
|
||||||
|
|
||||||
### Backend/login
|
## <a name="backend"></a>Contribute Backend Code
|
||||||
|
|
||||||
By executing the commands from this section, you run everything you need to develop the ZITADEL backend locally.
|
By executing the commands from this section, you run everything you need to develop the Zitadel backend locally.
|
||||||
Using [Docker Compose](https://docs.docker.com/compose/), you run a [PostgreSQL](https://www.postgresql.org/download/) on your local machine.
|
Using [Docker Compose](https://docs.docker.com/compose/), you run a [PostgreSQL](https://www.postgresql.org/download/) on your local machine.
|
||||||
With [make](https://www.gnu.org/software/make/), you build a debuggable ZITADEL binary and run it using [delve](https://github.com/go-delve/delve).
|
With [make](https://www.gnu.org/software/make/), you build a debuggable Zitadel binary and run it using [delve](https://github.com/go-delve/delve).
|
||||||
Then, you test your changes via the console your binary is serving at http://<span because="breaks the link"></span>localhost:8080 and by verifying the database.
|
Then, you test your changes via the console your binary is serving at http://<span because="breaks the link"></span>localhost:8080 and by verifying the database.
|
||||||
Once you are happy with your changes, you run end-to-end tests and tear everything down.
|
Once you are happy with your changes, you run end-to-end tests and tear everything down.
|
||||||
|
|
||||||
ZITADEL uses [golangci-lint](https://golangci-lint.run) for code quality checks. Please use [this configuration](.golangci.yaml) when running `golangci-lint`. We recommend to set golangci-lint as linter in your IDE.
|
Zitadel uses [golangci-lint](https://golangci-lint.run) for code quality checks. Please use [this configuration](.golangci.yaml) when running `golangci-lint`. We recommend to set golangci-lint as linter in your IDE.
|
||||||
|
|
||||||
The commands in this section are tested against the following software versions:
|
The commands in this section are tested against the following software versions:
|
||||||
|
|
||||||
@@ -262,10 +229,10 @@ make compile
|
|||||||
> Build the binary: `make compile`
|
> Build the binary: `make compile`
|
||||||
|
|
||||||
You can now run and debug the binary in .artifacts/zitadel/zitadel using your favourite IDE, for example GoLand.
|
You can now run and debug the binary in .artifacts/zitadel/zitadel using your favourite IDE, for example GoLand.
|
||||||
You can test if ZITADEL does what you expect by using the UI at http://localhost:8080/ui/console.
|
You can test if Zitadel does what you expect by using the UI at http://localhost:8080/ui/console.
|
||||||
Also, you can verify the data by running `psql "host=localhost dbname=zitadel sslmode=disable"` and running SQL queries.
|
Also, you can verify the data by running `psql "host=localhost dbname=zitadel sslmode=disable"` and running SQL queries.
|
||||||
|
|
||||||
#### Run Local Unit Tests
|
### Run Local Unit Tests
|
||||||
|
|
||||||
To test the code without dependencies, run the unit tests:
|
To test the code without dependencies, run the unit tests:
|
||||||
|
|
||||||
@@ -273,11 +240,11 @@ To test the code without dependencies, run the unit tests:
|
|||||||
make core_unit_test
|
make core_unit_test
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Run Local Integration Tests
|
### Run Local Integration Tests
|
||||||
|
|
||||||
Integration tests are run as gRPC clients against a running ZITADEL server binary.
|
Integration tests are run as gRPC clients against a running Zitadel server binary.
|
||||||
The server binary is typically [build with coverage enabled](https://go.dev/doc/build-cover).
|
The server binary is typically [build with coverage enabled](https://go.dev/doc/build-cover).
|
||||||
It is also possible to run a ZITADEL sever in a debugger and run the integrations tests like that. In order to run the server, a database is required.
|
It is also possible to run a Zitadel sever in a debugger and run the integrations tests like that. In order to run the server, a database is required.
|
||||||
|
|
||||||
In order to prepare the local system, the following will bring up the database, builds a coverage binary, initializes the database and starts the sever.
|
In order to prepare the local system, the following will bring up the database, builds a coverage binary, initializes the database and starts the sever.
|
||||||
|
|
||||||
@@ -300,7 +267,7 @@ To run all available integration tests:
|
|||||||
make core_integration_test_packages
|
make core_integration_test_packages
|
||||||
```
|
```
|
||||||
|
|
||||||
When you change any ZITADEL server code, be sure to rebuild and restart the server before the next test run.
|
When you change any Zitadel server code, be sure to rebuild and restart the server before the next test run.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make core_integration_server_stop core_integration_server_start
|
make core_integration_server_stop core_integration_server_start
|
||||||
@@ -314,17 +281,17 @@ make core_integration_server_stop core_integration_db_down
|
|||||||
|
|
||||||
The test binary has the race detector enabled. `core_core_integration_server_stop` checks for any race logs reported by Go and will print them along a `66` exit code when found. Note that the actual race condition may have happened anywhere during the server lifetime, including start, stop or serving gRPC requests during tests.
|
The test binary has the race detector enabled. `core_core_integration_server_stop` checks for any race logs reported by Go and will print them along a `66` exit code when found. Note that the actual race condition may have happened anywhere during the server lifetime, including start, stop or serving gRPC requests during tests.
|
||||||
|
|
||||||
#### Run Local End-to-End Tests
|
### Run Local End-to-End Tests
|
||||||
|
|
||||||
To test the whole system, including the console UI and the login UI, run the E2E tests.
|
To test the whole system, including the console UI and the login UI, run the E2E tests.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Build the production docker image
|
# Build the production docker image
|
||||||
export ZITADEL_IMAGE=zitadel:local GOOS=linux
|
export Zitadel_IMAGE=zitadel:local GOOS=linux
|
||||||
make docker_image
|
make docker_image
|
||||||
|
|
||||||
# If you made changes in the e2e directory, make sure you reformat the files
|
# If you made changes in the e2e directory, make sure you reformat the files
|
||||||
pnpm turbo lint --filter=e2e
|
pnpm turbo lint:fix --filter=e2e
|
||||||
|
|
||||||
# Run the tests
|
# Run the tests
|
||||||
docker compose --file ./e2e/docker-compose.yaml run --service-ports e2e
|
docker compose --file ./e2e/docker-compose.yaml run --service-ports e2e
|
||||||
@@ -337,7 +304,7 @@ When you are happy with your changes, you can cleanup your environment.
|
|||||||
docker compose --file ./e2e/docker-compose.yaml down
|
docker compose --file ./e2e/docker-compose.yaml down
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Run Local End-to-End Tests Against Your Dev Server Console
|
### Run Local End-to-End Tests Against Your Dev Server Console
|
||||||
|
|
||||||
If you also make [changes to the console](#console), you can run the test suite against your locally built backend code and frontend server.
|
If you also make [changes to the console](#console), you can run the test suite against your locally built backend code and frontend server.
|
||||||
|
|
||||||
@@ -346,10 +313,10 @@ If you also make [changes to the console](#console), you can run the test suite
|
|||||||
pnpm install
|
pnpm install
|
||||||
|
|
||||||
# Run the tests interactively
|
# Run the tests interactively
|
||||||
cd ./e2e && pnpm run open:golangangular
|
pnpm run open:golangangular
|
||||||
|
|
||||||
# Run the tests non-interactively
|
# Run the tests non-interactively
|
||||||
cd ./e2e && pnpm run e2e:golangangular
|
pnpm run e2e:golangangular
|
||||||
```
|
```
|
||||||
|
|
||||||
When you are happy with your changes, you can cleanup your environment.
|
When you are happy with your changes, you can cleanup your environment.
|
||||||
@@ -359,23 +326,38 @@ When you are happy with your changes, you can cleanup your environment.
|
|||||||
docker compose --file ./e2e/docker-compose.yaml down
|
docker compose --file ./e2e/docker-compose.yaml down
|
||||||
```
|
```
|
||||||
|
|
||||||
### Console
|
## Contribute Frontend Code
|
||||||
|
|
||||||
By executing the commands from this section, you run everything you need to develop the console locally.
|
This repository uses **pnpm** as package manager and **Turbo** for build orchestration.
|
||||||
Using [Docker Compose](https://docs.docker.com/compose/), you run [PostgreSQL](https://www.postgresql.org/download/) and the [latest release of ZITADEL](https://github.com/zitadel/zitadel/releases/latest) on your local machine.
|
All frontend packages are managed as a monorepo with shared dependencies and optimized builds:
|
||||||
You use the ZITADEL container as backend for your console.
|
|
||||||
The console is run in your [Node](https://nodejs.org/en/about/) environment using [a local development server for Angular](https://angular.io/cli/serve#ng-serve), so you have fast feedback about your changes.
|
|
||||||
|
|
||||||
We use **pnpm** as package manager and **Turbo** for build orchestration. Use angular-eslint/Prettier for linting/formatting, so please run `pnpm turbo lint --filter=console` before committing. (VSCode users, check out [this ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [this Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to fix lint and formatting issues in development)
|
- [apps/login](contribute-login) (depends on packages/zitadel-client and packages/zitadel-proto)
|
||||||
|
- apps/login/integration
|
||||||
|
- apps/login/acceptance
|
||||||
|
- [console](contribute-console) (depends on packages/zitadel-client)
|
||||||
|
- packages/zitadel-client
|
||||||
|
- packages/zitadel-proto
|
||||||
|
- [docs](contribute-docs)
|
||||||
|
|
||||||
Once you are happy with your changes, you run end-to-end tests and tear everything down.
|
### <a name="frontend-dev-requirements"></a>Frontend Development Requirements
|
||||||
|
|
||||||
|
The frontend components are run in a [Node](https://nodejs.org/en/about/) environment and are managed using the pnpm package manager and the Turborepo orchestrator.
|
||||||
|
|
||||||
|
> [!INFO]
|
||||||
|
> Some [dev containers are available](dev-containers) for remote development with docker and pipeline debugging in isolated environments.
|
||||||
|
> If you don't want to use one of the dev containers, you can develop the frontend components directly on your local machine.
|
||||||
|
> To do so, proceed with installing the necessary dependencies.
|
||||||
|
|
||||||
|
We use **pnpm** as package manager and **Turbo** for build orchestration. Use angular-eslint/Prettier for linting/formatting.
|
||||||
|
VSCode users, check out [this ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [this Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to fix lint and formatting issues during development.
|
||||||
|
|
||||||
The commands in this section are tested against the following software versions:
|
The commands in this section are tested against the following software versions:
|
||||||
|
|
||||||
- [Docker version 20.10.17](https://docs.docker.com/engine/install/)
|
- [Docker version 20.10.17](https://docs.docker.com/engine/install/)
|
||||||
- [Node version v20.x](https://nodejs.org/en/download/)
|
- [Node version v20.x](https://nodejs.org/en/download/)
|
||||||
- [pnpm version 9.x](https://pnpm.io/installation)
|
- [pnpm version 9.x](https://pnpm.io/installation)
|
||||||
- [Cypress runtime dependencies](https://docs.cypress.io/guides/continuous-integration/introduction#Dependencies)
|
|
||||||
|
To run tests with Cypress, ensure you have installed the required [Cypress runtime dependencies](https://docs.cypress.io/guides/continuous-integration/introduction#Dependencies)
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Note for WSL2 on Windows 10</summary>
|
<summary>Note for WSL2 on Windows 10</summary>
|
||||||
@@ -387,131 +369,19 @@ The commands in this section are tested against the following software versions:
|
|||||||
4. When starting XLaunch, make sure to disable access control
|
4. When starting XLaunch, make sure to disable access control
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
Run the database and the latest backend locally.
|
### <a name="contribute-login"></a>Contribute to Login
|
||||||
|
|
||||||
```bash
|
The Login UI is a Next.js application that provides the user interface for authentication flows.
|
||||||
# Start from the root of the repository
|
It's located in the `apps/login` directory and uses pnpm and Turbo for development.
|
||||||
# You just need the db and the zitadel services to develop the console against.
|
|
||||||
docker compose --file ./e2e/docker-compose.yaml up --detach zitadel
|
|
||||||
```
|
|
||||||
|
|
||||||
When the backend is ready, you have the latest zitadel exposed at http://localhost:8080.
|
To start developing the login, make sure your system has the [required system dependencies](frontend-dev-requirements) installed.
|
||||||
You can now run a local development server with live code reloading at http://localhost:4200.
|
|
||||||
To allow console access via http://localhost:4200, you have to configure the ZITADEL backend.
|
|
||||||
|
|
||||||
1. Navigate to <http://localhost:8080/ui/console/projects>.
|
|
||||||
2. When prompted, login with _zitadel-admin@<span because="breaks the mailto"></span>zitadel.localhost_ and _Password1!_
|
|
||||||
3. Select the _ZITADEL_ project.
|
|
||||||
4. Select the _Console_ application.
|
|
||||||
5. Select _Redirect Settings_
|
|
||||||
6. Add _http://<span because="breaks the link"></span>localhost:4200/auth/callback_ to the _Redirect URIs_
|
|
||||||
7. Add _http://<span because="breaks the link"></span>localhost:4200/signedout_ to the _Post Logout URIs_
|
|
||||||
8. Select the _Save_ button
|
|
||||||
|
|
||||||
You can run the local console development server now.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Install dependencies (from repository root)
|
|
||||||
pnpm install
|
|
||||||
|
|
||||||
# Option 1: Run console development server with Turbo (recommended)
|
|
||||||
pnpm turbo dev --filter=console
|
|
||||||
|
|
||||||
# Option 2: Run console development server directly
|
|
||||||
cd ./console && pnpm start
|
|
||||||
|
|
||||||
# Option 3: Build and serve console (production build)
|
|
||||||
pnpm turbo build --filter=console
|
|
||||||
cd ./console && pnpm serve
|
|
||||||
|
|
||||||
# If you don't want to develop against http://localhost:8080, you can use another environment
|
|
||||||
ENVIRONMENT_JSON_URL=https://my-cloud-instance-abcdef.zitadel.cloud/ui/console/assets/environment.json pnpm turbo dev --filter=console
|
|
||||||
```
|
|
||||||
|
|
||||||
Navigate to http://localhost:4200/.
|
|
||||||
Make some changes to the source code and see how the browser is automatically updated.
|
|
||||||
|
|
||||||
#### Console Development Scripts
|
|
||||||
|
|
||||||
Here are the most useful scripts for console development:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Generate protobuf files (happens automatically with Turbo dependencies)
|
|
||||||
pnpm turbo generate --filter=console
|
|
||||||
|
|
||||||
# Run development server with live reload
|
|
||||||
pnpm turbo dev --filter=console
|
|
||||||
|
|
||||||
# Build for production
|
|
||||||
pnpm turbo build --filter=console
|
|
||||||
|
|
||||||
# Lint and fix code
|
|
||||||
pnpm turbo lint --filter=console
|
|
||||||
|
|
||||||
# Run unit tests
|
|
||||||
pnpm turbo test --filter=console
|
|
||||||
|
|
||||||
# Run all console-related tasks
|
|
||||||
pnpm turbo dev lint test --filter=console
|
|
||||||
```
|
|
||||||
|
|
||||||
After making changes to the code, you should run the end-to-end-tests.
|
|
||||||
Open another shell.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Reformat your console code using Turbo
|
|
||||||
pnpm turbo lint --filter=console
|
|
||||||
|
|
||||||
# Change to the e2e directory
|
|
||||||
cd ./e2e
|
|
||||||
|
|
||||||
# If you made changes in the e2e directory, make sure you reformat the files here too
|
|
||||||
pnpm run lint:fix
|
|
||||||
|
|
||||||
# Install pnpm dependencies
|
|
||||||
pnpm install
|
|
||||||
|
|
||||||
# Run all e2e tests
|
|
||||||
pnpm run e2e:angular -- --headed
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also open the test suite interactively for fast feedback on specific tests.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run tests interactively
|
|
||||||
pnpm run open:angular
|
|
||||||
```
|
|
||||||
|
|
||||||
If you also make [changes to the backend code](#backend--login), you can run the test against your locally built backend code and frontend server
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pnpm run open:golangangular
|
|
||||||
pnpm run e2e:golangangular
|
|
||||||
```
|
|
||||||
|
|
||||||
When you are happy with your changes, you can format your code and cleanup your environment
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Stop and remove the docker containers for zitadel and the database
|
|
||||||
docker compose --file ./e2e/docker-compose.yaml down
|
|
||||||
```
|
|
||||||
|
|
||||||
### Login UI
|
|
||||||
|
|
||||||
The Login UI is a Next.js application that provides the user interface for authentication flows. It's located in the `./login` directory and uses pnpm and Turbo for development.
|
|
||||||
|
|
||||||
#### Prerequisites
|
|
||||||
|
|
||||||
- [Node version v20.x](https://nodejs.org/en/download/)
|
|
||||||
- [pnpm version 9.x](https://pnpm.io/installation)
|
|
||||||
- [Docker](https://docs.docker.com/engine/install/) for running the backend
|
|
||||||
|
|
||||||
#### Development Setup
|
#### Development Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Start from the root of the repository
|
# Start from the root of the repository
|
||||||
# Start the database and ZITADEL backend
|
# Start the database and Zitadel backend
|
||||||
docker compose --file ./e2e/docker-compose.yaml up --detach zitadel
|
docker compose --file ./apps/login/acceptance/docker-compose.yaml up --detach zitadel
|
||||||
|
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
pnpm install
|
pnpm install
|
||||||
@@ -519,52 +389,19 @@ pnpm install
|
|||||||
# Option 1: Run login development server with Turbo (recommended)
|
# Option 1: Run login development server with Turbo (recommended)
|
||||||
pnpm turbo dev --filter=@zitadel/login
|
pnpm turbo dev --filter=@zitadel/login
|
||||||
|
|
||||||
# Option 2: Run login development server directly
|
# Option 2: Build and serve login (production build)
|
||||||
cd ./login && pnpm dev
|
|
||||||
|
|
||||||
# Option 3: Build and serve login (production build)
|
|
||||||
pnpm turbo build --filter=@zitadel/login
|
pnpm turbo build --filter=@zitadel/login
|
||||||
cd ./login && pnpm start
|
cd ./login && pnpm start
|
||||||
```
|
```
|
||||||
|
|
||||||
The login UI will be available at http://localhost:3000.
|
The login UI is available at http://localhost:3000.
|
||||||
|
|
||||||
#### Login Development Scripts
|
|
||||||
|
|
||||||
Here are the most useful scripts for login development:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Generate protobuf files (happens automatically with Turbo dependencies)
|
|
||||||
pnpm turbo generate --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Run development server with live reload
|
|
||||||
pnpm turbo dev --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Build for production
|
|
||||||
pnpm turbo build --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Lint and fix code
|
|
||||||
pnpm turbo lint --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Run unit tests
|
|
||||||
pnpm turbo test:unit --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Run integration tests
|
|
||||||
pnpm turbo test:integration --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Run acceptance tests
|
|
||||||
pnpm turbo test:acceptance --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Run all login-related tasks
|
|
||||||
pnpm turbo dev lint test:unit --filter=@zitadel/login
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Login Architecture
|
#### Login Architecture
|
||||||
|
|
||||||
The login application consists of multiple packages:
|
The login application consists of multiple packages:
|
||||||
|
|
||||||
- `@zitadel/login` - Main Next.js application
|
- `@zitadel/login` - Main Next.js application
|
||||||
- `@zitadel/client` - TypeScript client library for ZITADEL APIs
|
- `@zitadel/client` - TypeScript client library for Zitadel APIs
|
||||||
- `@zitadel/proto` - Protocol buffer definitions and generated code
|
- `@zitadel/proto` - Protocol buffer definitions and generated code
|
||||||
|
|
||||||
The build process uses Turbo to orchestrate dependencies:
|
The build process uses Turbo to orchestrate dependencies:
|
||||||
@@ -573,34 +410,98 @@ The build process uses Turbo to orchestrate dependencies:
|
|||||||
2. Client library build (`@zitadel/client#build`)
|
2. Client library build (`@zitadel/client#build`)
|
||||||
3. Login application build (`@zitadel/login#build`)
|
3. Login application build (`@zitadel/login#build`)
|
||||||
|
|
||||||
#### Testing the Login UI
|
#### Pass Quality Checks
|
||||||
|
|
||||||
|
Reproduce the pipelines linting and testing for the login.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run unit tests
|
pnpm turbo quality --filter=./apps/login/* --filter=./packages/*
|
||||||
pnpm turbo test:unit --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Run integration tests (requires running backend)
|
|
||||||
pnpm turbo test:integration --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Run acceptance tests
|
|
||||||
pnpm turbo test:acceptance --filter=@zitadel/login
|
|
||||||
|
|
||||||
# Run all tests
|
|
||||||
pnpm turbo test:unit test:integration test:acceptance --filter=@zitadel/login
|
|
||||||
```
|
```
|
||||||
|
|
||||||
When you are happy with your changes, cleanup your environment:
|
Fix the [quality checks](troubleshoot-frontend), add new checks that cover your changes and mark your pull request as ready for review when the pipeline checks pass.
|
||||||
|
|
||||||
|
### <a name="contribute-console"></a>Contribute to Console
|
||||||
|
|
||||||
|
To start developing the console, make sure your system has the [required system dependencies](frontend-dev-requirements) installed.
|
||||||
|
Then, you need to decide which Zitadel instance you would like to target.
|
||||||
|
- The easiest starting point is to [configure your environment](console-dev-existing-zitadel) to use a [Zitadel cloud](https://zitadel.com) instance.
|
||||||
|
- Alternatively, you can [start a local Zitadel instance from scratch and develop against it](console-dev-local-zitadel).
|
||||||
|
|
||||||
|
#### <a name="console-dev-existing-zitadel"></a>Develop against an already running Zitadel instance
|
||||||
|
|
||||||
|
By default, `pnpm dev --filter=console` targets a Zitadel API running at http://localhost:8080.
|
||||||
|
To change this, export the link to your environment.json in your environment variables.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Stop and remove the docker containers
|
export ENVIRONMENT_JSON_URL=https://my-cloud-instance-abcdef.us1.zitadel.cloud/ui/console/assets/environment.json
|
||||||
docker compose --file ./e2e/docker-compose.yaml down
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Contribute docs
|
Proceed [with configuring your console redirect URIs](console-redirect).
|
||||||
|
|
||||||
|
#### <a name="console-dev-local-zitadel"></a>Develop against a local Zitadel instance from scratch
|
||||||
|
|
||||||
|
By executing the commands from this section, you run everything you need to develop the console locally.
|
||||||
|
Using [Docker Compose](https://docs.docker.com/compose/), you run [PostgreSQL](https://www.postgresql.org/download/) and the [latest release of Zitadel](https://github.com/zitadel/zitadel/releases/latest) on your local machine.
|
||||||
|
You use the Zitadel container as backend for your console.
|
||||||
|
|
||||||
|
Run the database and the latest backend locally.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Start from the root of the repository
|
||||||
|
# You just need the db and the zitadel services to develop the console against.
|
||||||
|
docker compose --file ./e2e/docker-compose.yaml up --detach zitadel
|
||||||
|
```
|
||||||
|
|
||||||
|
When Zitadel accepts traffic, navigate to http://localhost:8080/ui/console/projects?login_hint=zitadel-admin@zitadel.localhost and log in with _Password1!_.
|
||||||
|
|
||||||
|
Proceed [with configuring your console redirect URIs](console-redirect).
|
||||||
|
|
||||||
|
#### <a name="console-redirect"></a> Configure Console redirect URI
|
||||||
|
|
||||||
|
To allow console access via http://localhost:4200, you have to configure the Zitadel backend.
|
||||||
|
|
||||||
|
1. Navigate to /ui/console/projects in your target Zitadel instance.
|
||||||
|
3. Select the _Zitadel_ project.
|
||||||
|
4. Select the _Console_ application.
|
||||||
|
5. Select _Redirect Settings_
|
||||||
|
6. Add _http://<span because="breaks the link"></span>localhost:4200/auth/callback_ to the _Redirect URIs_
|
||||||
|
7. Add _http://<span because="breaks the link"></span>localhost:4200/signedout_ to the _Post Logout URIs_
|
||||||
|
8. Select the _Save_ button
|
||||||
|
|
||||||
|
#### Develop
|
||||||
|
|
||||||
|
Run the local console development server.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install dependencies (from repository root)
|
||||||
|
pnpm install
|
||||||
|
|
||||||
|
# Option 1: Run console development server with live reloading and dependency rebuilds
|
||||||
|
pnpm turbo dev --filter=console
|
||||||
|
|
||||||
|
# Option 2: Build and serve console (production build)
|
||||||
|
pnpm turbo build --filter=console
|
||||||
|
pnpm turbo serve --filter=console
|
||||||
|
```
|
||||||
|
|
||||||
|
Navigate to http://localhost:4200/.
|
||||||
|
Make some changes to the source code and see how the browser is automatically updated.
|
||||||
|
|
||||||
|
#### Pass Quality Checks
|
||||||
|
|
||||||
|
Reproduce the pipelines linting and testing for the console.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm turbo quality --filter=console --filter=e2e
|
||||||
|
```
|
||||||
|
|
||||||
|
Fix the [quality checks](troubleshoot-frontend), add new checks that cover your changes and mark your pull request as ready for review when the pipeline checks pass.
|
||||||
|
|
||||||
|
### <a name="contribute-docs"></a>Contribute to Docs
|
||||||
|
|
||||||
Project documentation is made with Docusaurus and is located under [./docs](./docs). The documentation uses **pnpm** and **Turbo** for development and build processes.
|
Project documentation is made with Docusaurus and is located under [./docs](./docs). The documentation uses **pnpm** and **Turbo** for development and build processes.
|
||||||
|
|
||||||
### Local Development
|
#### Local Development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install dependencies (from repository root)
|
# Install dependencies (from repository root)
|
||||||
@@ -609,35 +510,11 @@ pnpm install
|
|||||||
# Option 1: Run docs development server with Turbo (recommended)
|
# Option 1: Run docs development server with Turbo (recommended)
|
||||||
pnpm turbo dev --filter=zitadel-docs
|
pnpm turbo dev --filter=zitadel-docs
|
||||||
|
|
||||||
# Option 2: Run docs development server directly
|
# Option 2: Build and serve docs (production build)
|
||||||
cd ./docs && pnpm start
|
|
||||||
|
|
||||||
# Option 3: Build and serve docs (production build)
|
|
||||||
pnpm turbo build --filter=zitadel-docs
|
pnpm turbo build --filter=zitadel-docs
|
||||||
cd ./docs && pnpm serve
|
cd ./docs && pnpm serve
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Docs Development Scripts
|
|
||||||
|
|
||||||
Here are the most useful scripts for docs development:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Generate API documentation and configuration docs
|
|
||||||
pnpm turbo generate --filter=zitadel-docs
|
|
||||||
|
|
||||||
# Run development server with live reload
|
|
||||||
pnpm turbo dev --filter=zitadel-docs
|
|
||||||
|
|
||||||
# Build for production
|
|
||||||
pnpm turbo build --filter=zitadel-docs
|
|
||||||
|
|
||||||
# Lint and fix code
|
|
||||||
pnpm turbo lint --filter=zitadel-docs
|
|
||||||
|
|
||||||
# Run all docs-related tasks
|
|
||||||
pnpm turbo dev lint build --filter=zitadel-docs
|
|
||||||
```
|
|
||||||
|
|
||||||
The docs build process automatically:
|
The docs build process automatically:
|
||||||
|
|
||||||
1. Downloads required protoc plugins
|
1. Downloads required protoc plugins
|
||||||
@@ -646,11 +523,11 @@ The docs build process automatically:
|
|||||||
4. Copies configuration files
|
4. Copies configuration files
|
||||||
5. Builds the Docusaurus site
|
5. Builds the Docusaurus site
|
||||||
|
|
||||||
### Local testing
|
#### Local testing
|
||||||
|
|
||||||
The documentation server will be available at http://localhost:3000 with live reload for fast development feedback.
|
The documentation server will be available at http://localhost:3000 with live reload for fast development feedback.
|
||||||
|
|
||||||
### Style guide
|
#### Style guide
|
||||||
|
|
||||||
- **Code with variables**: Make sure that code snippets can be used by setting environment variables, instead of manually replacing a placeholder.
|
- **Code with variables**: Make sure that code snippets can be used by setting environment variables, instead of manually replacing a placeholder.
|
||||||
- **Embedded files**: When embedding mdx files, make sure the template ist prefixed by "\_" (lowdash). The content will be rendered inside the parent page, but is not accessible individually (eg, by search).
|
- **Embedded files**: When embedding mdx files, make sure the template ist prefixed by "\_" (lowdash). The content will be rendered inside the parent page, but is not accessible individually (eg, by search).
|
||||||
@@ -666,14 +543,54 @@ The style guide covers a lot of material, so their [highlights](https://develope
|
|||||||
- Use active voice: make clear who's performing the action.
|
- Use active voice: make clear who's performing the action.
|
||||||
- Use descriptive link text.
|
- Use descriptive link text.
|
||||||
|
|
||||||
### Docs pull request
|
#### Docs pull request
|
||||||
|
|
||||||
When making a pull request use `docs(<scope>): <short summary>` as title for the semantic release.
|
When making a pull request use `docs(<scope>): <short summary>` as title for the semantic release.
|
||||||
Scope can be left empty (omit the brackets) or refer to the top navigation sections.
|
Scope can be left empty (omit the brackets) or refer to the top navigation sections.
|
||||||
|
|
||||||
## Contribute internationalization
|
#### Pass Quality Checks
|
||||||
|
|
||||||
ZITADEL loads translations from four files:
|
Reproduce the pipelines linting checks for the docs.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pnpm turbo quality --filter=docs
|
||||||
|
```
|
||||||
|
|
||||||
|
Fix the [quality checks](troubleshoot-frontend), add new checks that cover your changes and mark your pull request as ready for review when the pipeline checks pass.
|
||||||
|
|
||||||
|
### <a name="troubleshoot-frontend"></a>Troubleshoot Frontend Quality Checks
|
||||||
|
|
||||||
|
To debug and fix failing tasks, execute them individually using the `--filter` flag.
|
||||||
|
|
||||||
|
We recommend to use [one of the dev containers](dev-containers) to reproduce pipeline issues.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# to reproduce linting error in the console:
|
||||||
|
pnpm lint --filter=console
|
||||||
|
# To fix them:
|
||||||
|
pnpm lint:fix --filter=console
|
||||||
|
```
|
||||||
|
|
||||||
|
More tasks that are runnable on-demand.
|
||||||
|
Some tasks have variants like `pnpm test:e2e:angulargolang`,
|
||||||
|
others support arguments and flags like `pnpm test:integration run --spec apps/login/integration/integration/login.cy.ts`.
|
||||||
|
For the turbo commands, check your options with `pnpm turbo --help`
|
||||||
|
|
||||||
|
| Command | Description | Example |
|
||||||
|
| ------------------------- | -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
| `pnpm turbo run generate` | Generate stubs from Proto files | Generate API docs: `pnpm turbo run generate --filter zitadel-docs` |
|
||||||
|
| `pnpm turbo build` | Build runnable JavaScript code | Regenerate the proto stubs and build the @zitadel/client package: `pnpm turbo build --filter @zitadel/client` |
|
||||||
|
| `pnpm turbo quality` | Reproduce the pipeline quality checks | Run login-related quality checks `pnpm turbo quality --filter './apps/login/*' --filter './packages/*'` |
|
||||||
|
| `pnpm turbo lint` | Check linting issues | Check login-related linting issues for differences with main `pnpm turbo lint --filter=[main...HEAD] --filter .'/apps/login/**/*' --filter './packages/*'` |
|
||||||
|
| `pnpm turbo lint:fix` | Fix linting issues | Fix console-relevant linting issues `pnpm turbo lint:fix --filter console --filter './packages/*' --filter zitadel-e2e` |
|
||||||
|
| `pnpm turbo test:unit` | Run unit tests. Rerun on file changes | Run unit tests in all packages in and watch for file changes `pnpm turbo watch test:unit` |
|
||||||
|
| `pnpm turbo test:e2e` | Run the Cypress CLI for console e2e tests | Test interactively against the console in a local dev server and Zitadel in a container: `pnpm turbo test:e2e:angular open` |
|
||||||
|
| `pnpm turbo down` | Remove containers and volumes | Shut down containers from the integration test setup `pnpm turbo down` |
|
||||||
|
| `pnpm turbo clean` | Remove downloaded dependencies and other generated files | Remove generated docs `pnpm turbo clean --filter zitadel-docs` |
|
||||||
|
|
||||||
|
## <a name="contribute-translations"></a>Contribute Translations
|
||||||
|
|
||||||
|
Zitadel loads translations from four files:
|
||||||
|
|
||||||
- [Console texts](./console/src/assets/i18n)
|
- [Console texts](./console/src/assets/i18n)
|
||||||
- [Login interface](./internal/api/ui/login/static/i18n)
|
- [Login interface](./internal/api/ui/login/static/i18n)
|
||||||
@@ -691,7 +608,7 @@ You also have to add some changes to the following files:
|
|||||||
- [Customized Text Docs](./docs/docs/guides/manage/customize/texts.md)
|
- [Customized Text Docs](./docs/docs/guides/manage/customize/texts.md)
|
||||||
- [Add language option](./internal/api/ui/login/static/templates/external_not_found_option.html)
|
- [Add language option](./internal/api/ui/login/static/templates/external_not_found_option.html)
|
||||||
|
|
||||||
## Want to start ZITADEL?
|
## Want to start Zitadel?
|
||||||
|
|
||||||
You can find an installation guide for all the different environments here:
|
You can find an installation guide for all the different environments here:
|
||||||
[https://zitadel.com/docs/self-hosting/deploy/overview](https://zitadel.com/docs/self-hosting/deploy/overview)
|
[https://zitadel.com/docs/self-hosting/deploy/overview](https://zitadel.com/docs/self-hosting/deploy/overview)
|
||||||
@@ -702,14 +619,14 @@ You can find an installation guide for all the different environments here:
|
|||||||
|
|
||||||
## Product management
|
## Product management
|
||||||
|
|
||||||
The ZITADEL Team works with an agile product management methodology.
|
The Zitadel Team works with an agile product management methodology.
|
||||||
You can find all the issues prioritized and ordered in the [product board](https://github.com/orgs/zitadel/projects/2/views/1).
|
You can find all the issues prioritized and ordered in the [product board](https://github.com/orgs/zitadel/projects/2/views/1).
|
||||||
|
|
||||||
### Sprint
|
### Sprint
|
||||||
|
|
||||||
We want to deliver a new release every second week. So we plan everything in two-week sprints.
|
We want to deliver a new release every second week. So we plan everything in two-week sprints.
|
||||||
Each Tuesday we estimate new issues and on Wednesday the last sprint will be reviewed and the next one will be planned.
|
Each Tuesday we estimate new issues and on Wednesday the last sprint will be reviewed and the next one will be planned.
|
||||||
After a sprint ends a new version of ZITADEL will be released, and publish to [ZITADEL Cloud](https://zitadel.cloud) the following Monday.
|
After a sprint ends a new version of Zitadel will be released, and publish to [Zitadel Cloud](https://zitadel.cloud) the following Monday.
|
||||||
|
|
||||||
If there are some critical or urgent issues we will have a look at it earlier, than the two weeks.
|
If there are some critical or urgent issues we will have a look at it earlier, than the two weeks.
|
||||||
To show the community the needed information, each issue gets attributes and labels.
|
To show the community the needed information, each issue gets attributes and labels.
|
||||||
@@ -729,15 +646,16 @@ The state should reflect the progress of the issue and what is going on right no
|
|||||||
- **🔖 Ready**: The issue is ready to take into a sprint. Difference to "prioritized..." is that the complexity is defined by the team.
|
- **🔖 Ready**: The issue is ready to take into a sprint. Difference to "prioritized..." is that the complexity is defined by the team.
|
||||||
- **📋 Sprint backlog**: The issue is scheduled for the current sprint.
|
- **📋 Sprint backlog**: The issue is scheduled for the current sprint.
|
||||||
- **🏗 In progress**: Someone is working on this issue right now. The issue will get an assignee as soon as it is in progress.
|
- **🏗 In progress**: Someone is working on this issue right now. The issue will get an assignee as soon as it is in progress.
|
||||||
|
- **❌ Blocked**: The issue is blocked until another issue is resolved/done.
|
||||||
- **👀 In review**: The issue is in review. Please add someone to review your issue or let us know that it is ready to review with a comment on your pull request.
|
- **👀 In review**: The issue is in review. Please add someone to review your issue or let us know that it is ready to review with a comment on your pull request.
|
||||||
- **✅ Done**: The issue is implemented and merged to main.
|
- **✅ Done**: The issue is implemented and merged to main.
|
||||||
|
|
||||||
#### Priority
|
#### Priority
|
||||||
|
|
||||||
Priority shows you the priority the ZITADEL team has given this issue. In general the higher the demand from customers and community for the feature, the higher the priority.
|
Priority shows you the priority the Zitadel team has given this issue. In general the higher the demand from customers and community for the feature, the higher the priority.
|
||||||
|
|
||||||
- **🌋 Critical**: This is a security issue or something that has to be fixed urgently, because the software is not usable or highly vulnerable.
|
- **🌋 Critical**: This is a security issue or something that has to be fixed urgently, because the software is not usable or highly vulnerable.
|
||||||
- **🏔 High**: These are the issues the ZITADEL team is currently focusing on and will be implemented as soon as possible.
|
- **🏔 High**: These are the issues the Zitadel team is currently focusing on and will be implemented as soon as possible.
|
||||||
- **🏕 Medium**: After all the high issues are done these will be next.
|
- **🏕 Medium**: After all the high issues are done these will be next.
|
||||||
- **🏝 Low**: This is low in priority and will probably not be implemented in the next time or just if someone has some time in between.
|
- **🏝 Low**: This is low in priority and will probably not be implemented in the next time or just if someone has some time in between.
|
||||||
|
|
||||||
@@ -752,18 +670,18 @@ Everything that is higher than 8 should be split in smaller parts.
|
|||||||
|
|
||||||
There are a few general labels that don't belong to a specific category.
|
There are a few general labels that don't belong to a specific category.
|
||||||
|
|
||||||
- **good first issue**: This label shows contributors, that it is an easy entry point to start developing on ZITADEL.
|
- **good first issue**: This label shows contributors, that it is an easy entry point to start developing on Zitadel.
|
||||||
- **help wanted**: The author is seeking help on this topic, this may be from an internal ZITADEL team member or external contributors.
|
- **help wanted**: The author is seeking help on this topic, this may be from an internal Zitadel team member or external contributors.
|
||||||
|
|
||||||
#### Category
|
#### Category
|
||||||
|
|
||||||
The category shows which part of ZITADEL is affected.
|
The category shows which part of Zitadel is affected.
|
||||||
|
|
||||||
- **category: backend**: The backend includes the APIs, event store, command and query side. This is developed in golang.
|
- **category: backend**: The backend includes the APIs, event store, command and query side. This is developed in golang.
|
||||||
- **category: ci**: ci is all about continues integration and pipelines.
|
- **category: ci**: ci is all about continues integration and pipelines.
|
||||||
- **category: design**: All about the ux/ui of ZITADEL
|
- **category: design**: All about the ux/ui of Zitadel
|
||||||
- **category: docs**: Adjustments or new documentations, this can be found in the docs folder.
|
- **category: docs**: Adjustments or new documentations, this can be found in the docs folder.
|
||||||
- **category: frontend**: The frontend concerns on the one hand the ZITADEL management console (Angular) and on the other hand the login (gohtml)
|
- **category: frontend**: The frontend concerns on the one hand the Zitadel management console (Angular) and on the other hand the login (gohtml)
|
||||||
- **category: infra**: Infrastructure does include many different parts. E.g Terraform-provider, docker, metrics, etc.
|
- **category: infra**: Infrastructure does include many different parts. E.g Terraform-provider, docker, metrics, etc.
|
||||||
- **category: translation**: Everything concerning translations or new languages
|
- **category: translation**: Everything concerning translations or new languages
|
||||||
|
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ The following files and directories, including their subdirectories, are license
|
|||||||
|
|
||||||
```
|
```
|
||||||
login/
|
login/
|
||||||
|
clients/
|
||||||
```
|
```
|
||||||
|
|
||||||
## Community Contributions
|
## Community Contributions
|
||||||
|
|||||||
35
Makefile
35
Makefile
@@ -27,7 +27,7 @@ docker_image:
|
|||||||
else \
|
else \
|
||||||
echo "Reusing precompiled zitadel binary"; \
|
echo "Reusing precompiled zitadel binary"; \
|
||||||
fi
|
fi
|
||||||
DOCKER_BUILDKIT=1 docker build -f build/Dockerfile -t $(ZITADEL_IMAGE) .
|
DOCKER_BUILDKIT=1 docker build -f build/zitadel/Dockerfile -t $(ZITADEL_IMAGE) .
|
||||||
|
|
||||||
.PHONY: compile_pipeline
|
.PHONY: compile_pipeline
|
||||||
compile_pipeline: console_move
|
compile_pipeline: console_move
|
||||||
@@ -97,17 +97,11 @@ console_move:
|
|||||||
|
|
||||||
.PHONY: console_dependencies
|
.PHONY: console_dependencies
|
||||||
console_dependencies:
|
console_dependencies:
|
||||||
pnpm install
|
npx pnpm install --frozen-lockfile --filter=./console
|
||||||
|
|
||||||
.PHONY: console_client
|
|
||||||
console_client:
|
|
||||||
cd console && \
|
|
||||||
pnpm generate
|
|
||||||
|
|
||||||
.PHONY: console_build
|
.PHONY: console_build
|
||||||
console_build: console_dependencies console_client
|
console_build: console_dependencies
|
||||||
cd console && \
|
npx pnpm turbo build --filter=./console
|
||||||
pnpm build
|
|
||||||
|
|
||||||
.PHONY: clean
|
.PHONY: clean
|
||||||
clean:
|
clean:
|
||||||
@@ -165,7 +159,7 @@ core_integration_test: core_integration_server_start core_integration_test_packa
|
|||||||
|
|
||||||
.PHONY: console_lint
|
.PHONY: console_lint
|
||||||
console_lint:
|
console_lint:
|
||||||
pnpm turbo lint --filter=./console
|
npx pnpm turbo lint --filter=./console
|
||||||
|
|
||||||
.PHONY: core_lint
|
.PHONY: core_lint
|
||||||
core_lint:
|
core_lint:
|
||||||
@@ -177,15 +171,15 @@ core_lint:
|
|||||||
|
|
||||||
.PHONY: login_pull
|
.PHONY: login_pull
|
||||||
login_pull: login_ensure_remote
|
login_pull: login_ensure_remote
|
||||||
@echo "Pulling changes from the 'login' subtree on remote $(LOGIN_REMOTE_NAME) branch $(LOGIN_REMOTE_BRANCH)"
|
@echo "Pulling changes from the 'apps/login' subtree on remote $(LOGIN_REMOTE_NAME) branch $(LOGIN_REMOTE_BRANCH)"
|
||||||
git fetch $(LOGIN_REMOTE_NAME) $(LOGIN_REMOTE_BRANCH)
|
git fetch $(LOGIN_REMOTE_NAME) $(LOGIN_REMOTE_BRANCH)
|
||||||
git merge -s ours --allow-unrelated-histories $(LOGIN_REMOTE_NAME)/$(LOGIN_REMOTE_BRANCH) -m "Synthetic merge to align histories"
|
git merge -s ours --allow-unrelated-histories $(LOGIN_REMOTE_NAME)/$(LOGIN_REMOTE_BRANCH) -m "Synthetic merge to align histories"
|
||||||
git push
|
git push
|
||||||
|
|
||||||
.PHONY: login_push
|
.PHONY: login_push
|
||||||
login_push: login_ensure_remote
|
login_push: login_ensure_remote
|
||||||
@echo "Pushing changes to the 'login' subtree on remote $(LOGIN_REMOTE_NAME) branch $(LOGIN_REMOTE_BRANCH)"
|
@echo "Pushing changes to the 'apps/login' subtree on remote $(LOGIN_REMOTE_NAME) branch $(LOGIN_REMOTE_BRANCH)"
|
||||||
git subtree split --prefix=login -b login-sync-tmp
|
git subtree split --prefix=apps/login -b login-sync-tmp
|
||||||
git checkout login-sync-tmp
|
git checkout login-sync-tmp
|
||||||
git fetch $(LOGIN_REMOTE_NAME) main
|
git fetch $(LOGIN_REMOTE_NAME) main
|
||||||
git merge -s ours --allow-unrelated-histories $(LOGIN_REMOTE_NAME)/main -m "Synthetic merge to align histories"
|
git merge -s ours --allow-unrelated-histories $(LOGIN_REMOTE_NAME)/main -m "Synthetic merge to align histories"
|
||||||
@@ -200,16 +194,3 @@ login_ensure_remote:
|
|||||||
else \
|
else \
|
||||||
echo "Remote $(LOGIN_REMOTE_NAME) already exists."; \
|
echo "Remote $(LOGIN_REMOTE_NAME) already exists."; \
|
||||||
fi
|
fi
|
||||||
|
|
||||||
export LOGIN_DIR := ./login/
|
|
||||||
export LOGIN_BAKE_CLI_ADDITIONAL_ARGS := --set login-*.context=./login/ --file ./docker-bake.hcl
|
|
||||||
export ZITADEL_TAG ?= $(ZITADEL_IMAGE)
|
|
||||||
include login/Makefile
|
|
||||||
|
|
||||||
# Intentional override of login_test_acceptance_build
|
|
||||||
login_test_acceptance_build: docker_image
|
|
||||||
@echo "Building login test acceptance environment with the local zitadel image"
|
|
||||||
$(MAKE) login_test_acceptance_build_compose login_test_acceptance_build_bake
|
|
||||||
|
|
||||||
login_dev: docker_image typescript_generate login_test_acceptance_build_compose login_test_acceptance_cleanup login_test_acceptance_setup_dev
|
|
||||||
@echo "Starting login test environment with the local zitadel image"
|
|
||||||
|
|||||||
21
apps/login/.dockerignore
Normal file
21
apps/login/.dockerignore
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
*
|
||||||
|
|
||||||
|
!constants
|
||||||
|
!scripts
|
||||||
|
!src
|
||||||
|
!public
|
||||||
|
!locales
|
||||||
|
!next.config.mjs
|
||||||
|
!next-env-vars.d.ts
|
||||||
|
!next-env.d.ts
|
||||||
|
!tailwind.config.js
|
||||||
|
!tsconfig.json
|
||||||
|
!package.json
|
||||||
|
!pnpm-lock.yaml
|
||||||
|
|
||||||
|
**/*.md
|
||||||
|
**/*.png
|
||||||
|
**/node_modules
|
||||||
|
**/.turbo
|
||||||
|
**/*.test.ts
|
||||||
|
**/*.test.tsx
|
||||||
5
apps/login/.env.test
Normal file
5
apps/login/.env.test
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
NEXT_PUBLIC_BASE_PATH="/ui/v2/login"
|
||||||
|
ZITADEL_API_URL=http://mock-zitadel:22222
|
||||||
|
ZITADEL_SERVICE_USER_TOKEN="yolo"
|
||||||
|
EMAIL_VERIFICATION=true
|
||||||
|
DEBUG=true
|
||||||
@@ -7,7 +7,10 @@ module.exports = {
|
|||||||
"@next/next/no-img-element": "off",
|
"@next/next/no-img-element": "off",
|
||||||
"react/no-unescaped-entities": "off",
|
"react/no-unescaped-entities": "off",
|
||||||
"no-unused-vars": "off",
|
"no-unused-vars": "off",
|
||||||
"@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
|
"@typescript-eslint/no-unused-vars": ["error", {
|
||||||
|
argsIgnorePattern: "^_" ,
|
||||||
|
varsIgnorePattern: "^_" ,
|
||||||
|
}],
|
||||||
"no-undef": "off",
|
"no-undef": "off",
|
||||||
},
|
},
|
||||||
parserOptions: {
|
parserOptions: {
|
||||||
|
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 83 KiB |
12
login/.gitignore → apps/login/.gitignore
vendored
12
login/.gitignore → apps/login/.gitignore
vendored
@@ -1,3 +1,8 @@
|
|||||||
|
custom-config.js
|
||||||
|
.env*.local
|
||||||
|
standalone
|
||||||
|
tsconfig.tsbuildinfo
|
||||||
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
node_modules
|
node_modules
|
||||||
.turbo
|
.turbo
|
||||||
@@ -7,12 +12,5 @@ dist
|
|||||||
dist-ssr
|
dist-ssr
|
||||||
*.local
|
*.local
|
||||||
.env
|
.env
|
||||||
server/dist
|
|
||||||
public/dist
|
|
||||||
.vscode
|
.vscode
|
||||||
.idea
|
|
||||||
.vercel
|
|
||||||
.env*.local
|
|
||||||
/blob-report/
|
/blob-report/
|
||||||
/out
|
|
||||||
/docker
|
|
||||||
5
apps/login/.prettierignore
Normal file
5
apps/login/.prettierignore
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
*
|
||||||
|
!constants
|
||||||
|
!src
|
||||||
|
!locales
|
||||||
|
!scripts/healthcheck.js
|
||||||
36
apps/login/Dockerfile
Normal file
36
apps/login/Dockerfile
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
FROM node:20-alpine AS base
|
||||||
|
|
||||||
|
FROM base AS build
|
||||||
|
ENV PNPM_HOME="/pnpm"
|
||||||
|
ENV PATH="$PNPM_HOME:$PATH"
|
||||||
|
RUN corepack enable && COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack prepare pnpm@9.1.2 --activate && \
|
||||||
|
apk update && apk add --no-cache && \
|
||||||
|
rm -rf /var/cache/apk/*
|
||||||
|
WORKDIR /app
|
||||||
|
COPY pnpm-lock.yaml ./
|
||||||
|
RUN --mount=type=cache,id=pnpm,target=/root/.local/share/pnpm/store pnpm fetch --frozen-lockfile
|
||||||
|
COPY package.json ./
|
||||||
|
RUN --mount=type=cache,id=pnpm,target=/root/.local/share/pnpm/store pnpm install --frozen-lockfile --prod
|
||||||
|
COPY . .
|
||||||
|
RUN pnpm build:login:standalone
|
||||||
|
|
||||||
|
FROM scratch AS build-out
|
||||||
|
COPY --from=build /app/.next/standalone /
|
||||||
|
COPY --from=build /app/.next/static /.next/static
|
||||||
|
COPY --from=build /app/public /public
|
||||||
|
|
||||||
|
FROM base AS login-standalone
|
||||||
|
WORKDIR /runtime
|
||||||
|
RUN addgroup --system --gid 1001 nodejs && \
|
||||||
|
adduser --system --uid 1001 nextjs
|
||||||
|
# If /.env-file/.env is mounted into the container, its variables are made available to the server before it starts up.
|
||||||
|
RUN mkdir -p /.env-file && touch /.env-file/.env && chown -R nextjs:nodejs /.env-file
|
||||||
|
COPY ./scripts/ ./
|
||||||
|
COPY --chown=nextjs:nodejs --from=build-out / ./
|
||||||
|
USER nextjs
|
||||||
|
ENV HOSTNAME="0.0.0.0"
|
||||||
|
ENV PORT=3000
|
||||||
|
# TODO: Check healthy, not ready
|
||||||
|
HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
|
||||||
|
CMD ["/bin/sh", "-c", "node ./healthcheck.js http://localhost:${PORT}/ui/v2/login/healthy"]
|
||||||
|
ENTRYPOINT ["./entrypoint.sh"]
|
||||||
@@ -2,8 +2,8 @@
|
|||||||
"name": "login-test-acceptance",
|
"name": "login-test-acceptance",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test:acceptance": "dotenv -e ../login/.env.test.local pnpm exec playwright",
|
"test:acceptance": "dotenv -e ../login/.env.test.local playwright",
|
||||||
"test:acceptance:setup": "cd ../.. && make login_test_acceptance_setup_env && NODE_ENV=test pnpm exec turbo run test:acceptance:setup:dev",
|
"test:acceptance:setup": "cd ../.. && make login_test_acceptance_setup_env && NODE_ENV=test turbo run test:acceptance:setup:dev",
|
||||||
"test:acceptance:setup:dev": "cd ../.. && make login_test_acceptance_setup_dev"
|
"test:acceptance:setup:dev": "cd ../.. && make login_test_acceptance_setup_dev"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
@@ -12,6 +12,7 @@
|
|||||||
"@otplib/plugin-crypto": "^12.0.0",
|
"@otplib/plugin-crypto": "^12.0.0",
|
||||||
"@otplib/plugin-thirty-two": "^12.0.0",
|
"@otplib/plugin-thirty-two": "^12.0.0",
|
||||||
"@playwright/test": "^1.52.0",
|
"@playwright/test": "^1.52.0",
|
||||||
|
"dotenv-cli": "^8.0.0",
|
||||||
"gaxios": "^7.1.0",
|
"gaxios": "^7.1.0",
|
||||||
"typescript": "^5.8.3"
|
"typescript": "^5.8.3"
|
||||||
}
|
}
|
||||||
@@ -1,2 +1,3 @@
|
|||||||
*
|
*
|
||||||
|
!.gitignore
|
||||||
!.gitkeep
|
!.gitkeep
|
||||||
@@ -1,2 +1,3 @@
|
|||||||
*
|
*
|
||||||
|
!.gitignore
|
||||||
!.gitkeep
|
!.gitkeep
|
||||||
@@ -1,2 +1,3 @@
|
|||||||
*
|
*
|
||||||
|
!.gitignore
|
||||||
!.gitkeep
|
!.gitkeep
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user