Add automated version replacement in example dag indexes #28090
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boring-cyborg
bot
added
area:providers
kind:documentation
provider:amazon-aws
potiuk
force-pushed
the
fix-version-generated-in-example-dags-pages
branch
from
a894eec
to
a242ab9
Compare
potiuk
changed the title
potiuk
force-pushed
the
fix-version-generated-in-example-dags-pages
branch
from
a242ab9
to
6b69950
Compare
potiuk
force-pushed
the
fix-version-generated-in-example-dags-pages
branch
3 times, most recently
from
5c1ad30
to
1971363
Compare
|
Also including fix to the tool correcting example_dag links |
|
cc: @Taragolis |
potiuk
force-pushed
the
fix-version-generated-in-example-dags-pages
branch
from
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. |
|
Looks like it handles all cases (including references to the example DAGs from random pages like in yandex case (see the links at the bottom of the screen):
|
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.
potiuk
force-pushed
the
fix-version-generated-in-example-dags-pages
branch
from
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 :) |
kaxil
approved these changes
Dec 5, 2022
potiuk
added a commit
to potiuk/airflow
that referenced
this pull request
Dec 6, 2022
This was a race of merging PR apache#26974 and apache#28090
jedcunningham
pushed a commit
that referenced
this pull request
Dec 6, 2022
pierrejeambrun
added
the
type:misc/internal
pierrejeambrun
pushed a commit
that referenced
this pull request
Jan 12, 2023
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)
84 tasks
86 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.rstor{issue_number}.significant.rst, in newsfragments.