feat(adrs): Add ADR selecting Airflow as an orchestration tool#317
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis pull request introduces a new Architecture Decision Record that formalises the selection of Apache Airflow as the job orchestration tool, documenting the platform context, decision criteria, and anticipated consequences of moving away from the current cron-based ingestion system. ChangesApache Airflow Adoption Decision
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs-devel/system-architecture/adrs/0009-use-apache-airflow-as-job-orchestration-tool.md (1)
19-31: ⚡ Quick winAdd an explicit alternatives comparison to make the decision auditable.
The ADR records the choice, but it does not show why Airflow was selected over the options in Issue
#114(Dagster, Prefect, Kestra, Luigi). A short “Options considered” table mapped to the MVP criteria would make this decision easier to revisit and defend.[recommend adding a small matrix with columns like
Tool,Python tasks,Cron scheduling,REST trigger,Manual one-off,Web UI,Container deployment,Notes.]🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs-devel/system-architecture/adrs/0009-use-apache-airflow-as-job-orchestration-tool.md` around lines 19 - 31, Add a new "Options considered" section in the ADR (docs-devel/system-architecture/adrs/0009-use-apache-airflow-as-job-orchestration-tool.md) immediately after the "Our requirements are simple" list: create a small comparison matrix with columns Tool, Python tasks, Cron scheduling, REST trigger, Manual one-off, Web UI, Container deployment, Notes and rows for Airflow, Dagster, Prefect, Kestra, and Luigi; populate each cell against the MVP criteria and add a short Notes cell summarising key trade-offs and any blockers from Issue `#114`, then add a final line stating why Airflow best meets the criteria to make the decision auditable.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@docs-devel/system-architecture/adrs/0009-use-apache-airflow-as-job-orchestration-tool.md`:
- Around line 22-31: The ADR text uses inconsistent terminology and grammar in
several bullet points and a sentence: change "python" to "Python", "REST api" to
"REST API", and rephrase the sentence "We therefore include that Airflow is a
natural choice as an orchestration tool." to a clearer form such as "Therefore,
Airflow is a natural choice for orchestration." Update the bullets "Tasks to be
defined as python code/packages.", "Allows a cron-like timed schedule to be
created.", "A REST api to trigger jobs.", "Allows one-off jobs triggered
manually on request.", "A web-based UI.", and the concluding sentence so casing
and phrasing are consistent and grammatically correct across the ADR.
---
Nitpick comments:
In
`@docs-devel/system-architecture/adrs/0009-use-apache-airflow-as-job-orchestration-tool.md`:
- Around line 19-31: Add a new "Options considered" section in the ADR
(docs-devel/system-architecture/adrs/0009-use-apache-airflow-as-job-orchestration-tool.md)
immediately after the "Our requirements are simple" list: create a small
comparison matrix with columns Tool, Python tasks, Cron scheduling, REST
trigger, Manual one-off, Web UI, Container deployment, Notes and rows for
Airflow, Dagster, Prefect, Kestra, and Luigi; populate each cell against the MVP
criteria and add a short Notes cell summarising key trade-offs and any blockers
from Issue `#114`, then add a final line stating why Airflow best meets the
criteria to make the decision auditable.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: a0a0028a-3738-4d29-acda-271b435f4b2d
📒 Files selected for processing (1)
docs-devel/system-architecture/adrs/0009-use-apache-airflow-as-job-orchestration-tool.md
3f86e89 to
32cdb5e
Compare
Add an ADR choosing Apache Airflow as an orchestration tool.
Fixes #114
Summary by CodeRabbit