chore(docs): remove comment styling

This commit is contained in:
Stijnvandenbroek
2026-03-05 10:41:44 +00:00
parent ca5cb9e777
commit c6f5adf621
5 changed files with 21 additions and 22 deletions

View File

@@ -1,16 +1,16 @@
# ── PostgreSQL ─────────────────────────────────────────────────────────────── # PostgreSQL
POSTGRES_HOST=postgres POSTGRES_HOST=postgres
POSTGRES_PORT=5432 POSTGRES_PORT=5432
POSTGRES_USER=dagster POSTGRES_USER=dagster
POSTGRES_PASSWORD=changeme POSTGRES_PASSWORD=changeme
POSTGRES_DB=dagster POSTGRES_DB=dagster
# ── Dagster metadata storage (uses the same postgres instance) ─────────────── # Dagster metadata storage (same postgres instance)
DAGSTER_POSTGRES_URL=postgresql://dagster:changeme@postgres:5432/dagster DAGSTER_POSTGRES_URL=postgresql://dagster:changeme@postgres:5432/dagster
# ── dbt profile target (overrides profiles.yml env_var defaults) ───────────── # dbt profile target
DBT_TARGET=dev DBT_TARGET=dev
# ── pgAdmin ────────────────────────────────────────────────────────────────── # pgAdmin
PGADMIN_EMAIL=admin@example.com PGADMIN_EMAIL=admin@example.com
PGADMIN_PASSWORD=changeme PGADMIN_PASSWORD=changeme

View File

@@ -7,7 +7,7 @@ on:
branches: [main] branches: [main]
jobs: jobs:
# ── Lint ──────────────────────────────────────────────────────────────── # Lint
lint-python: lint-python:
name: Ruff (lint + format) name: Ruff (lint + format)
runs-on: ubuntu-latest runs-on: ubuntu-latest
@@ -67,7 +67,7 @@ jobs:
"**/*.yml" "**/*.yaml" "**/*.md" \ "**/*.yml" "**/*.yaml" "**/*.md" \
--ignore-path .prettierignore --ignore-path .prettierignore
# ── Tests ──────────────────────────────────────────────────────────────── # Tests
test: test:
name: Pytest name: Pytest
runs-on: ubuntu-latest runs-on: ubuntu-latest

View File

@@ -1,5 +1,5 @@
repos: repos:
# ── Local hooks (use uv-managed tool versions from uv.lock) ────────────── # Local hooks using uv-managed tool versions
- repo: local - repo: local
hooks: hooks:
- id: ruff-lint - id: ruff-lint
@@ -19,7 +19,7 @@ repos:
entry: uv run sqlfluff lint --dialect postgres entry: uv run sqlfluff lint --dialect postgres
language: system language: system
types: [sql] types: [sql]
files: ^(dbt/models/|data_platform/assets/ingestion/) files: ^dbt/models/
- id: prettier - id: prettier
name: prettier name: prettier
@@ -34,7 +34,7 @@ repos:
\.pytest_cache/ \.pytest_cache/
) )
# ── General hygiene ─────────────────────────────────────────────────────── # General hygiene
- repo: https://github.com/pre-commit/pre-commit-hooks - repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0 rev: v5.0.0
hooks: hooks:

View File

@@ -1,4 +1,4 @@
# ── Usercode: full application (gRPC server) ───────────────────────── # Usercode: full application (gRPC server)
FROM python:3.12-slim AS usercode FROM python:3.12-slim AS usercode
WORKDIR /app WORKDIR /app
@@ -21,15 +21,14 @@ ENV DAGSTER_HOME=/app/dagster_home
RUN chmod +x /app/entrypoint.sh RUN chmod +x /app/entrypoint.sh
ENTRYPOINT ["/app/entrypoint.sh"] ENTRYPOINT ["/app/entrypoint.sh"]
# ── Infrastructure: webserver / daemon (no user code) ──────────────── # Infrastructure: webserver / daemon (no user code)
FROM python:3.12-slim AS dagster-infra FROM python:3.12-slim AS dagster-infra
WORKDIR /app WORKDIR /app
COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
# Only the Dagster packages needed to run webserver / daemon and reach # No application code, only dagster packages for webserver/daemon
# the metadata store. No application code is installed.
RUN uv pip install --system dagster dagster-webserver dagster-postgres RUN uv pip install --system dagster dagster-webserver dagster-postgres
COPY dagster_home/ ./dagster_home/ COPY dagster_home/ ./dagster_home/

View File

@@ -13,18 +13,18 @@ DBT := uv run dbt
# Container(s) that carry user code # Container(s) that carry user code
CODE_SERVICES := dagster-usercode CODE_SERVICES := dagster-usercode
## —— Help —————————————————————————————————————————————————————— ## Help
help: ## Show this help help: ## Show this help
@grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | \ @grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | \
awk 'BEGIN {FS = ":.*## "}; {printf " \033[36m%-18s\033[0m %s\n", $$1, $$2}' awk 'BEGIN {FS = ":.*## "}; {printf " \033[36m%-18s\033[0m %s\n", $$1, $$2}'
## —— Python / uv —————————————————————————————————————————————— ## Python / uv
install: ## Install all dependencies (including dev) with uv install: ## Install all dependencies (including dev) with uv
uv sync uv sync
sync: install ## Alias for install sync: install ## Alias for install
## —— Docker Compose ——————————————————————————————————————————— ## Docker Compose
build: ## Build all Docker images build: ## Build all Docker images
$(COMPOSE) build $(COMPOSE) build
@@ -43,7 +43,7 @@ logs: ## Tail logs for all services (ctrl-c to quit)
ps: ## Show running containers ps: ## Show running containers
$(COMPOSE) ps $(COMPOSE) ps
## —— User-code container shortcuts ———————————————————————————— ## User-code container shortcuts
build-code: ## Rebuild only the user-code containers build-code: ## Rebuild only the user-code containers
$(COMPOSE) build $(CODE_SERVICES) $(COMPOSE) build $(CODE_SERVICES)
@@ -55,7 +55,7 @@ reload-usercode: ## Rebuild and restart only the gRPC usercode server
$(COMPOSE) build dagster-usercode $(COMPOSE) build dagster-usercode
$(COMPOSE) up -d --no-deps --force-recreate dagster-usercode $(COMPOSE) up -d --no-deps --force-recreate dagster-usercode
## —— dbt (local, via uv) ————————————————————————————————————— ## dbt (local, via uv)
dbt-parse: ## Parse the dbt project and generate manifest.json dbt-parse: ## Parse the dbt project and generate manifest.json
$(DBT) parse --project-dir $(DBT_DIR) --profiles-dir $(DBT_DIR) $(DBT) parse --project-dir $(DBT_DIR) --profiles-dir $(DBT_DIR)
@@ -81,11 +81,11 @@ dbt-docs: ## Generate and serve dbt docs
$(DBT) docs generate --project-dir $(DBT_DIR) --profiles-dir $(DBT_DIR) $(DBT) docs generate --project-dir $(DBT_DIR) --profiles-dir $(DBT_DIR)
$(DBT) docs serve --project-dir $(DBT_DIR) --profiles-dir $(DBT_DIR) $(DBT) docs serve --project-dir $(DBT_DIR) --profiles-dir $(DBT_DIR)
## —— Dagster (local dev) ————————————————————————————————————— ## Dagster (local dev)
dagster-dev: ## Start Dagster webserver locally for development dagster-dev: ## Start Dagster webserver locally for development
uv run dagster dev uv run dagster dev
## —— Quality ────────────────────────────────────────────────── ## Quality
lint: lint-python lint-sql lint-format ## Run all linters (ruff + sqlfluff + prettier) lint: lint-python lint-sql lint-format ## Run all linters (ruff + sqlfluff + prettier)
lint-python: ## Ruff lint + format check lint-python: ## Ruff lint + format check
@@ -106,7 +106,7 @@ lint-fix: ## Auto-fix all linters (ruff + sqlfluff + prettier)
npx --yes prettier --write "**/*.yml" "**/*.yaml" "**/*.md" \ npx --yes prettier --write "**/*.yml" "**/*.yaml" "**/*.md" \
--ignore-path .prettierignore --ignore-path .prettierignore
## —— Pre-commit ──────────────────────────────────────────────── ## Pre-commit
pre-commit-install: ## Install pre-commit hooks into .git/hooks pre-commit-install: ## Install pre-commit hooks into .git/hooks
uv run pre-commit install uv run pre-commit install
@@ -119,7 +119,7 @@ validate: ## Validate Dagster definitions load without errors
test: ## Run pytest test: ## Run pytest
uv run pytest uv run pytest
## —— Misc ————————————————————————————————————————————————————— ## Misc
clean: ## Remove Python caches and build artefacts clean: ## Remove Python caches and build artefacts
find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
rm -rf .pytest_cache dist *.egg-info rm -rf .pytest_cache dist *.egg-info