Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .fastflowtransform/target/catalog.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"metadata": {
"generated_at": "2025-10-28T19:05:15+00:00",
"tool": "fastflowtransform"
},
"relations": {
"failing": {
"columns": []
}
}
}
20 changes: 20 additions & 0 deletions .fastflowtransform/target/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"macros": {
"snake": "text.py"
},
"metadata": {
"generated_at": "2025-10-28T19:05:15+00:00",
"tool": "fastflowtransform"
},
"nodes": {
"failing": {
"deps": [],
"kind": "sql",
"materialized": "table",
"name": "failing",
"path": "",
"relation": "failing"
}
},
"sources": {}
}
19 changes: 19 additions & 0 deletions .fastflowtransform/target/run_results.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"metadata": {
"generated_at": "2025-10-28T19:05:15+00:00",
"tool": "fastflowtransform"
},
"results": [
{
"duration_ms": 0,
"finished_at": "2025-10-28T19:05:15+00:00",
"http": null,
"message": "'boom'",
"name": "failing",
"started_at": "2025-10-28T19:05:15+00:00",
"status": "error"
}
],
"run_finished_at": "2025-10-28T19:05:15+00:00",
"run_started_at": "2025-10-28T19:05:15+00:00"
}
50 changes: 50 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Build & Deploy MkDocs to GitHub Pages

on:
push:
branches: [ main ]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
cache: 'pip'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt

- name: Build site
run: mkdocs build --strict

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./site

deploy:
needs: build
runs-on: ubuntu-latest
steps:
- name: Configure Pages
uses: actions/configure-pages@v5
- name: Deploy to Pages
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,5 @@ dist/
# Docs Output
examples/**/docs/
tickets/**
site/dag/**
cache/**
6 changes: 3 additions & 3 deletions Makefile.pipeline
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,17 @@ dag:
# Opens the generated DAG HTML on macOS/Linux; Windows users open it manually.
demo-open:
@if [ -f "$(FF_PROJECT)/site/dag/index.html" ]; then \
$(OPENER) "$(FF_PROJECT)/site/dag/index.html" 2>/dev/null || echo "Öffne manuell: $(FF_PROJECT)/site/dag/index.html"; \
$(OPENER) "$(FF_PROJECT)/site/dag/index.html" 2>/dev/null || echo "Oopen at: $(FF_PROJECT)/site/dag/index.html"; \
else \
echo "Keine HTML-Datei gefunden: $(FF_PROJECT)/site/dag/index.html"; \
echo "No HTML found: $(FF_PROJECT)/site/dag/index.html"; \
fi

test:
$(FFT) test "$(FF_PROJECT)" --env "$(FF_ENV)" --select batch

# End-to-end showcase: Seed → Run → DAG → Open → Tests
demo: seed run dag demo-open test
@echo "\n✓ Demo fertig: Tabellen gebaut, DAG generiert, Tests gelaufen."
@echo "\n✓ Demo done."

clean:
rm -rf .local "$(FF_PROJECT)/docs" dist build *.egg-info
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ make install # upgrades pip + installs FastFlowTransform in editable mode
## Quickstart

> 📚 **Mehr lesen … CLI-Details**
> Für Flag-Referenzen, Automatisierung und Hintergründe siehe [`docs/Technical_Overview.md`](docs/Technical_Overview.md#cli-flows).
> For flag referencees, automatization and backgrounds see [`docs/Technical_Overview.md`](docs/Technical_Overview.md#cli-flows).

Run the end-to-end DuckDB demo (seed → run → docs → tests) in under a minute:

Expand Down Expand Up @@ -188,8 +188,11 @@ Examples:

- **Documentation hub:** choose your path (operators vs contributors) — see [`docs/index.md`](docs/index.md).
- **User & operator guide:** project layout, CLI usage, troubleshooting tips — see [`docs/Technical_Overview.md`](docs/Technical_Overview.md).
- **Docgen shortcut:** append `--open-source` to `fft docgen ...` to launch the freshly rendered `index.html` immediately; use `--no-schema` when column introspection should be skipped.
- **Modeling reference:** configuration, Jinja helpers, macros — see [`docs/Config_and_Macros.md`](docs/Config_and_Macros.md).
- **Examples:** runnable demo projects live under `examples/`; each README covers engine-specific setup.
- **API calls in Python models:** [`docs/API_Models.md`](docs/API_Models.md)
- **Database comments sync:** preview database comment updates with `fft sync-db-comments . --env dev --dry-run` before applying them to Postgres or Snowflake.
- **Examples:** runnable demo projects live under `examples/`;

---

Expand Down
Loading