-
Notifications
You must be signed in to change notification settings - Fork 14.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[AIRFLOW-6436] Create & Automate docs on Airflow Configs #7015
Conversation
This PR needs a bit of polishing but its overall logic or structure would remain same. |
fb9f21c
to
fee36d3
Compare
fee36d3
to
ef62156
Compare
Codecov Report
@@ Coverage Diff @@
## master #7015 +/- ##
==========================================
- Coverage 84.85% 84.42% -0.43%
==========================================
Files 679 680 +1
Lines 38536 38725 +189
==========================================
- Hits 32698 32692 -6
- Misses 5838 6033 +195
Continue to review full report at Codecov.
|
Love it. I will take a look latere. Akls @dimberman -> i think we might want to merge your PR #6983 with this one. |
This is fantastic. 10/10 @kaxil! |
Going to follow this up with some polishing up PRs. So, please feel free to add comments on this PR, I will take care of all the comments and fix them in the follow-up PR |
Very nice :) |
""" | ||
|
||
|
||
def default_config_yaml() -> dict: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we really do this when loading this module? Maybe you can create a function that will only be called in specific cases? If it is an executable file then it should have the following code at the end of the file
if __name__ == '__main__':
do_some_magic();
Should it also be in the airflow
directory? In my opinion, it looks better in the tests
or scripts
directory.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree, updating it in #7036
Hi! |
This PR aims to automate the creation of Config docs and add pre-commit hooks that would also serve as tests.
Preview:
Also, add a structure to the documentation by adding the following sections:
for each config
A user would only need to modify at a single place: config.yml, changes in
default_airflow.cfg
would be auto-generated using the pre-commit hook.Link to JIRA issue: https://issues.apache.org/jira/browse/AIRFLOW-6436
[AIRFLOW-NNNN]
, where AIRFLOW-NNNN = JIRA ID*(*) For document-only changes, no JIRA issue is needed. Commit message starts
[AIRFLOW-XXXX]
.In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.
Read the Pull Request Guidelines for more information.