Skip to content

Add scheduling docs for Airflow 3 #424

Merged
pankajastro merged 7 commits into
mainfrom
purpose_consitent_scheduling
Jun 27, 2025
Merged

Add scheduling docs for Airflow 3 #424
pankajastro merged 7 commits into
mainfrom
purpose_consitent_scheduling

Conversation

@pankajastro

@pankajastro pankajastro commented Jun 17, 2025

Copy link
Copy Markdown
Contributor

While working on PR #413, I noticed that the schedule parameter is currently inconsistent and lacks clear documentation. It's difficult to determine what formats are supported without diving into the codebase.

This PR proposes changes to make the schedule configuration more predictable, consistent, and easier to understand for users.

@codecov-commenter

codecov-commenter commented Jun 17, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.85%. Comparing base (b8c45e8) to head (200b6e3).
⚠️ Report is 115 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #424   +/-   ##
=======================================
  Coverage   94.85%   94.85%           
=======================================
  Files          11       11           
  Lines        1011     1011           
=======================================
  Hits          959      959           
  Misses         52       52           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread docs/configuration/schedule.md
Comment thread docs/configuration/schedule.md
Comment thread docs/configuration/schedule.md
@pankajastro pankajastro marked this pull request as ready for review June 19, 2025 06:41
@pankajastro pankajastro requested a review from a team as a code owner June 19, 2025 06:41
@tatiana tatiana changed the title Purpose scheduling changes for DAG-Facotry 1.0 Purpose scheduling changes for DAG-Factory 1.0 Jun 20, 2025
@pankajastro pankajastro force-pushed the purpose_consitent_scheduling branch from dee18ff to 48c87ed Compare June 23, 2025 08:15
Comment thread docs/configuration/schedule.md

@tatiana tatiana left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, @pankajastro , minor feedback inline.

Comment thread docs/configuration/schedule.md
@pankajastro pankajastro force-pushed the purpose_consitent_scheduling branch from 48c87ed to d3bda96 Compare June 26, 2025 08:42
pankajastro added a commit that referenced this pull request Jun 27, 2025
Closes: #399
Documentation PR: #424

This PR adds support for handling the schedule parameter across various
types of scheduling formats in DAG configuration. The changes in this PR
is only apply to Airflow 3 users.

For detailed usage examples and documentation, please refer to:
#424
@pankajastro pankajastro force-pushed the purpose_consitent_scheduling branch from d0931ac to 9dbfb8c Compare June 27, 2025 12:04
@pankajastro pankajastro merged commit fd0b509 into main Jun 27, 2025
64 checks passed
@pankajastro pankajastro deleted the purpose_consitent_scheduling branch June 27, 2025 13:39
@pankajastro pankajastro mentioned this pull request Jun 27, 2025
@pankajastro pankajastro added this to the DAG Factory 0.23.0 milestone Jun 27, 2025
@pankajastro pankajastro self-assigned this Jun 28, 2025
@pankajastro pankajastro changed the title Purpose scheduling changes for DAG-Factory 1.0 Add scheduling docs for Airflow 3 Jul 8, 2025
pankajastro added a commit that referenced this pull request Jul 14, 2025
## [0.23.0] - 2025-07-14

### Breaking Change

- Drop Airflow 2.2 Support by @pankajastro in
[#388](#388)
- Drop Python 3.8 support by @pankajastro in
[#435](#435)
- Drop Airflow 2.3 Support by @pankajastro in
[#456](#456)

### Airflow 3 Support

- Add tools for Dag-factory Airflow3 testing by @pankajastro in
[#395](#395)
- Fix schedule args for Airflow 3 by @pankajastro in
[#413](#413)
- Fix import path for BranchPythonOperator, PythonOperator and
PythonSensor by @pankajastro in
[#414](#414)
- Add scheduling docs for Airflow 3 by @pankajastro in
[#424](#424)
- Enable Airflow 3 tests in CI by @pankajastro in
[#436](#436)
- Add env AUTO_CONVERT_TO_AF3 in Dockerfile by @pankajastro in
[#455](#455)
- Validate DAG's on Airflow 3 by @pankajastro in
[#457](#457)
- Refactor schedule to use the Python object @pankajastro in
[#458](#458)
- Fix CI and import issues for Airflow 3 compatibility @pankajastro in
[#463](#463)

### Added

- Add support for defining inlets by @IvanSviridov in
[#380](#380)
- Add HttpOperator JSON serialization support with tests by @a-chumagin
in [#382](#382)
- Add support for custom Python object by @pankajastro in
[#444](#444)
- Support env var in default by @gyli in
[#452](#452)
- Pass default arguments via dictionary in .py file by @jroachgolf84 in
[#465](#465)

### Fixed

- Remediated ``default`` behavior, added documentation by @jroachgolf84
in [#378](#378)
- Upgrade `apache-airflow-providers-cncf-kubernetes` provider by
@pankajastro in
[#407](#407)
- Include error message trace in exception by @pankajastro in
[#408](#408)

### Docs

- Remove Unreleased heading section from the CHANGELOG.md by @pankajkoti
in [#365](#365)
- Add Documentation for Conditional Dataset Scheduling with dag-factory
by @ErickSeo in
[#367](#367)
- Add copy right in docs footer by @pankajastro in
[#371](#371)
- Updating docs for callbacks by @jroachgolf84 in
[#375](#375)
- Add stable/latest version in docs by @pankajastro in
[#391](#391)
- Migrate old content to new documentation structure by @pankajastro in
[#393](#393)
- Update Airflow supported version 2.3+ in docs by @pankajastro in
[#412](#412)
- Doc: Add step to fork repo in contributing guide by @pankajastro in
[#427](#427)
- Add setting CONFIG_ROOT_DIR in the contribution doc by @gyli in
[#432](#432)
- Add DAG example showcasing runtime params usage by @pankajastro in
[#449](#449)
- Add jinja2 template example by @pankajastro in
[#450](#450)

### Others

- Add Scraf Pixels for telemetry by @pankajastro in
[#373](#373)
- feat: bumped http provider versions to 2.0+ by @a-chumagin in
[#389](#389)
- Add --verbosity debug in astro-cli cmd by @pankajastro in
[#390](#390)
- Add missing Python file for dynamic task example by @pankajastro in
[#392](#392)
- Pin apache-airflow-providers-cncf-kubernetes<10.4.2 by @pankajastro in
[#400](#400)
- Add script to check version and tag by @pankajastro in
[#395](#394)
- Assert DagRunState in integration test by @pankajastro in
[#415](#415)
- Move to uv for package management by @jlaneve in
[#419](#419)
- Install uv in CI by @jlaneve in
[#421](#421)
- Bump astral-sh/setup-uv from 5 to 6 by @dependabot in
[#423](#423)
- Add Airflow 2.11 in test matrix by @pankajastro in
[#425](#425)
- fix example_dag_factory.yml typo causing catchup: false to not be
respected by @RNHTTR in
[#431](#431)
- Remove expandvars in utils.get_python_callable by @gyli in
[#440](#440)
- Delete unused img folder by @pankajastro in
[#446](#446)
- Clean print statement by @pankajastro
[#447](#447)
- Add hatch to uv dev dependencies by @gyli in
[#453](#453)
- Add Authorize Job in CI by @pankajastro in
[#460](#460)
- Remove PyPI token for releasing packages by @tatiana in
[#461](#461)
- Change CI on trigger event to pull_request from pull_request_target by
@pankajkoti in
[#464](#464)
- Update cicd.yaml: Use pull_request for authorize as we don't have
pull_request_target event configured by @pankajkoti in
[#466](#466)
- Add environment for pypi publish job by @pankajastro in
[#478](#478)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants