Skip to content

Fix an edge case after refactoring back-reference breeze command#33790

Merged
potiuk merged 1 commit intoapache:mainfrom
potiuk:fix-back-reference-command-after-refactor
Aug 27, 2023
Merged

Fix an edge case after refactoring back-reference breeze command#33790
potiuk merged 1 commit intoapache:mainfrom
potiuk:fix-back-reference-command-after-refactor

Conversation

@potiuk
Copy link
Member

@potiuk potiuk commented Aug 27, 2023

The #33626 change missed an edge case where back reference new link was in the top-level folder and crashed with ValueError.

Unfortunately back-reference command is one that we do not run (yet) in CI to verify if it works, because we need a checked-out airflow-site for it, so such errors might go unnoticed. However this error is an indication that we likely should add it to CI - in order to avoid situation when the command is expected to be working at release time.


^ 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.

The apache#33626 change missed an edge case where back reference new
link was in the top-level folder and crashed with ValueError.

Unfortunately back-reference command is one that we do not run (yet)
in CI to verify if it works, because we need a checked-out airflow-site
for it, so such errors might go unnoticed. However this error is an
indication that we likely should add it to CI - in order to avoid
situation when the command is expected to be working at release
time.
@potiuk potiuk merged commit badcf24 into apache:main Aug 27, 2023
@potiuk potiuk deleted the fix-back-reference-command-after-refactor branch August 27, 2023 04:32
potiuk added a commit to potiuk/airflow that referenced this pull request Aug 27, 2023
The `back-reference` command post-processes our docuementation to
add redirections for new pages in the old documentation, so that
user browsing the page can change version without hittin 404 error.

This command was not run in CI and some refactorings could break
it (as it already happened in apache#33626 - fixed by apache#33790).

Most other breeze commands are already run in CI, so this one should
be no different.

This PR adds back-reference generation as part of our regular
documentation building step.
potiuk added a commit that referenced this pull request Aug 27, 2023
* Run back-reference breeze command as part of our CI builds

The `back-reference` command post-processes our docuementation to
add redirections for new pages in the old documentation, so that
user browsing the page can change version without hittin 404 error.

This command was not run in CI and some refactorings could break
it (as it already happened in #33626 - fixed by #33790).

Most other breeze commands are already run in CI, so this one should
be no different.

This PR adds back-reference generation as part of our regular
documentation building step.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments