You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "jscheffl (via GitHub)" <gi...@apache.org> on 2025/06/29 17:38:13 UTC
[I] Automated checks where possible for example dags [airflow]
jscheffl opened a new issue, #52477:
URL: https://github.com/apache/airflow/issues/52477
### Description
As described in https://cwiki.apache.org/confluence/display/AIRFLOW/Examples+Refurbish
For all checks that are possible to be automated (e.g. enforcing proper pydoc per example dag) checks are implemented.
This ticket might be splitted and does not define a fixed list but candidates might be:
- Check for pydoc on module as well as function/task level
- Check that display names are attached to all dags and tasks
- Check that doc_md is provided
- Check that tasks are properly typed (via mypy strict mode and ruff?)
- Check that tag "example" is added for all examples, tag according to provider and if testing then the tag "testing"
- No deprecated functions being used (via ruff?)
### Use case/motivation
Airflow Examples have been grown in number and focus over the past years. They purpose multiple things:
Serve as tutorials to learn Airflow DAG implementation
Serve with code snippets for documentation
Serve for testing the setup
(some) service for CI integration testing
Some example DAGs are in a good quality, some are not following best practices. Current examples do not follow a structure.
There are example DAGs contained in the Airflow core (currently pushed to standard provider/example_dags) as well as there are more examples in other providers. But examples from other providers are lot loaded automatically.
So in the [Airflow 3 Dev Calls](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+3+Dev+call%3A+Meeting+Notes#Airflow3Devcall:MeetingNotes-22May2025) there was a demand named to clean-up and optimize example DAGs.
### Related issues
_No response_
### Are you willing to submit a PR?
- [ ] Yes I am willing to submit a PR!
### Code of Conduct
- [x] I agree to follow this project's [Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Automated checks where possible for example dags [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on issue #52477:
URL: https://github.com/apache/airflow/issues/52477#issuecomment-3219416216
Per [Slack thread](https://apache-airflow.slack.com/archives/C07813CNKA8/p1755500006993699), targeting “example DAGs” won’t be possible in 3.1, so we’re moving this to Airflow 3.1+
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org