-
Notifications
You must be signed in to change notification settings - Fork 14.8k
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
Add automated version replacement in example dag indexes #28090
Add automated version replacement in example dag indexes #28090
Conversation
a894eec
to
a242ab9
Compare
a242ab9
to
6b69950
Compare
5c1ad30
to
1971363
Compare
Also including fix to the tool correcting example_dag links |
cc: @Taragolis |
1971363
to
583d3e8
Compare
@Taragolis - I already corrected all the historical links in apache/airflow-site#706 - so the current documentation published should already have (I hope all) example_dags links properly linked to the right example versions. This one should fix generating the documentation in the first place. |
Despite earlier attempts to fix the links there were still many places where the links were pointing to wrong versions of examples. It has been Noticed in: apache#27774 (comment) This change addresses it in three ways: * updated tool to fix the linx in historically released documentation (applied already in apache/airflow-site#706) * replaced hard-coded version with `|version|` everywhere and added sphinx extension to convert those to actual provider versions (though due to sphinx limitation it has to be done with post-processing of the generated .html rather than replacing during generation) * added pre-commit that detects any use of example_dags links to main/master/hard-coded version.
583d3e8
to
f2e2416
Compare
I added pre-commit preventing hard-coded example dags to be part of the documentation and found few more places which i missed thanks to that :). I also added better description for the commit - describing the context of the change and decribing that the fix really addresses 3 problems:
|
cc: @Taragolis :) |
This was a race of merging PR apache#26974 and apache#28090
Despite earlier attempts to fix the links there were still many places where the links were pointing to wrong versions of examples. It has been Noticed in: #27774 (comment) This change addresses it in three ways: * updated tool to fix the linx in historically released documentation (applied already in apache/airflow-site#706) * replaced hard-coded version with `|version|` everywhere and added sphinx extension to convert those to actual provider versions (though due to sphinx limitation it has to be done with post-processing of the generated .html rather than replacing during generation) * added pre-commit that detects any use of example_dags links to main/master/hard-coded version. (cherry picked from commit c8e348d)
Despite earlier attempts to fix the links there were still many places
where the links were pointing to wrong versions of examples.
It has been Noticed in:
#27774 (comment)
This change addresses it in three ways:
(applied already in Fix all example DAG links airflow-site#706)
|version|
everywhere and addedsphinx extension to convert those to actual provider versions (though
due to sphinx limitation it has to be done with post-processing of the
generated .html rather than replacing during generation)
main/master/hard-coded version.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an 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 a newsfragment file, named
{pr_number}.significant.rst
or{issue_number}.significant.rst
, in newsfragments.