mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 16:47:32 +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:
5
packages/zitadel-proto/.gitignore
vendored
Normal file
5
packages/zitadel-proto/.gitignore
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
zitadel
|
||||
google
|
||||
protoc-gen-openapiv2
|
||||
validate
|
||||
node_modules
|
47
packages/zitadel-proto/CHANGELOG.md
Normal file
47
packages/zitadel-proto/CHANGELOG.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# @zitadel/proto
|
||||
|
||||
## 1.2.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 62ad388: revert CJS support
|
||||
|
||||
## 1.1.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- 9692297: add CJS and ESM support
|
||||
|
||||
## 1.0.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 97b0332: bind @zitadel/proto version to zitadel tag
|
||||
|
||||
## 1.0.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 90fbdd1: use node16/nodenext module resolution
|
||||
|
||||
## 1.0.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- include validate, google and protoc-gen-openapiv2
|
||||
|
||||
## 1.0.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- README updates
|
||||
|
||||
## 1.0.0
|
||||
|
||||
### Major Changes
|
||||
|
||||
- 32e1199: Initial Release
|
||||
|
||||
### Minor Changes
|
||||
|
||||
- f32ab7f: Initial release
|
35
packages/zitadel-proto/README.md
Normal file
35
packages/zitadel-proto/README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# ZITADEL Proto
|
||||
|
||||
This package provides the Protocol Buffers (proto) definitions used by ZITADEL projects. It includes the proto files and generated code for interacting with ZITADEL's gRPC APIs.
|
||||
|
||||
## Installation
|
||||
|
||||
To install the package, use npm or yarn:
|
||||
|
||||
```sh
|
||||
npm install @zitadel/proto
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
yarn add @zitadel/proto
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
To use the proto definitions in your project, import the generated code:
|
||||
|
||||
```ts
|
||||
import { Organization } from "@zitadel/proto/zitadel/org/v2/org_pb";
|
||||
|
||||
const org: Organization | null = await getDefaultOrg();
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
For detailed documentation and API references, please visit the [ZITADEL documentation](https://zitadel.com/docs).
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! Please read the contributing guidelines before getting started.
|
10
packages/zitadel-proto/buf.gen.yaml
Normal file
10
packages/zitadel-proto/buf.gen.yaml
Normal file
@@ -0,0 +1,10 @@
|
||||
version: v2
|
||||
managed:
|
||||
enabled: true
|
||||
plugins:
|
||||
- remote: buf.build/bufbuild/es:v2.2.0
|
||||
out: .
|
||||
include_imports: true
|
||||
opt:
|
||||
- json_types=true
|
||||
- import_extension=js
|
26
packages/zitadel-proto/package.json
Normal file
26
packages/zitadel-proto/package.json
Normal file
@@ -0,0 +1,26 @@
|
||||
{
|
||||
"name": "@zitadel/proto",
|
||||
"version": "1.2.0",
|
||||
"license": "MIT",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"type": "module",
|
||||
"files": [
|
||||
"zitadel/**",
|
||||
"validate/**",
|
||||
"google/**",
|
||||
"protoc-gen-openapiv2/**"
|
||||
],
|
||||
"sideEffects": false,
|
||||
"scripts": {
|
||||
"generate": "buf generate ../../proto --path ../../proto/zitadel",
|
||||
"clean": "rm -rf zitadel .turbo node_modules google protoc-gen-openapiv2 validate"
|
||||
},
|
||||
"dependencies": {
|
||||
"@bufbuild/protobuf": "^2.2.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@bufbuild/buf": "^1.53.0"
|
||||
}
|
||||
}
|
8
packages/zitadel-proto/turbo.json
Normal file
8
packages/zitadel-proto/turbo.json
Normal file
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"extends": ["//"],
|
||||
"tasks": {
|
||||
"generate": {
|
||||
"outputs": ["zitadel/**"]
|
||||
}
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user