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 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

• I agree to follow this project's Code of Conduct