mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-07 07:16:54 +00:00
b10455b51f
# 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
68 lines
2.7 KiB
YAML
68 lines
2.7 KiB
YAML
name: Quality
|
|
on:
|
|
pull_request:
|
|
workflow_dispatch:
|
|
inputs:
|
|
ignore-run-cache:
|
|
description: 'Whether to ignore the run cache'
|
|
required: false
|
|
default: true
|
|
ref-tag:
|
|
description: 'overwrite the DOCKER_METADATA_OUTPUT_VERSION environment variable used by the make file'
|
|
required: false
|
|
default: ''
|
|
jobs:
|
|
quality:
|
|
name: Ensure Quality
|
|
if: github.event_name == 'workflow_dispatch' ||
|
|
(github.event_name == 'pull_request' && github.repository_id != '622995060')
|
|
runs-on: ubuntu-22.04
|
|
timeout-minutes: 30
|
|
permissions:
|
|
contents: read # We only need read access to the repository contents
|
|
actions: write # We need write access to the actions cache
|
|
env:
|
|
CACHE_DIR: /tmp/login-run-caches
|
|
# Only run this job on workflow_dispatch or pushes to forks
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- name: Docker meta
|
|
id: meta
|
|
uses: docker/metadata-action@v5
|
|
with:
|
|
images: |
|
|
ghcr.io/zitadel/login
|
|
tags: |
|
|
type=raw,value=latest,enable={{is_default_branch}}
|
|
type=ref,event=branch
|
|
type=ref,event=pr
|
|
type=semver,pattern={{version}}
|
|
type=semver,pattern={{major}}.{{minor}}
|
|
type=semver,pattern={{major}}
|
|
- name: Set up Buildx
|
|
uses: docker/setup-buildx-action@v3
|
|
# Only with correctly restored build cache layers, the run caches work as expected.
|
|
# To restore docker build layer caches, extend the docker-bake.hcl to use the cache-from and cache-to options.
|
|
# https://docs.docker.com/build/ci/github-actions/cache/
|
|
# Alternatively, you can use a self-hosted runner or a third-party builder that restores build layer caches out-of-the-box, like https://depot.dev/
|
|
- 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-
|
|
- run: make login_quality
|
|
env:
|
|
IGNORE_RUN_CACHE: ${{ github.event.inputs.ignore-run-cache == 'true' }}
|
|
DOCKER_METADATA_OUTPUT_VERSION: ${{ github.event.inputs.ref-tag || env.DOCKER_METADATA_OUTPUT_VERSION || steps.meta.outputs.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()
|