collinmcnulty opened a new pull request, #41558:
URL: https://github.com/apache/airflow/pull/41558
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
The first run behavior for cron based DAGs (and most DAGs really) is quite
unintuitive. It is very common for users to want to run a DAG for the first
time either immediately, with a logical date of the past run that would have
occurred most recently, or to wait until the next run time and then begin. The
former is only possible is you set catchup to False and the latter is not
possible without knowing ahead of time when that next run would be and
hardcoding the start time for the DAG (which is not feasible when doing
dev/text/prod environment promotion of the same DAG file).
It is also very common to set the start_date to a dynamic function that
calculates a date in the recent past, such as days_ago(1), which can bite you
if you're used to doing that (or have coded it into a DAG factory pattern) and
then you set up your first monthly DAG. The existing timetables behavior is to
silently miss the run, which makes it even worse.
This PR adds the ability to set start_date to `None` and get the intuitive
behavior of running the last run if that run would have happened in the very
recent past (10% of the distance between DAG runs) or to wait for the next run
otherwise. It also allows using the `run_immediately` parameter to specify
always running the last run, always waiting for the next run, or passing a
timedelta to exactly control what "recent past" means for this particular DAG.
Setting start_date to `None` is a much more accurate and clear indication of
author intent that `days_ago(x)`.
I hope that if this is widely adopted, we can stop seeing users miss DAG
runs or using dynamic start dates.
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]