Skip to content

Run back-reference breeze command as part of our CI builds#33791

Merged
potiuk merged 3 commits intoapache:mainfrom
potiuk:add-test-for-back-reference-in-ci
Aug 27, 2023
Merged

Run back-reference breeze command as part of our CI builds#33791
potiuk merged 3 commits intoapache:mainfrom
potiuk:add-test-for-back-reference-in-ci

Conversation

@potiuk
Copy link
Member

@potiuk potiuk commented 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 #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.


^ 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 `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.
Copy link
Contributor

@amoghrajesh amoghrajesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to add this in the CI. One super nit, which you can feel free to ignore. Looks good +1

@potiuk potiuk requested a review from jedcunningham as a code owner August 27, 2023 05:27
@potiuk
Copy link
Member Author

potiuk commented Aug 27, 2023

Looks good. Added @amoghrajesh suggestion. I also changed print() commands to use get_console() output that should format better the output on CI (the terminal provided by CI by default is not detected as supporting colors and log lines by rich so we have to use our console to force it).

@potiuk potiuk merged commit c96ae2b into apache:main Aug 27, 2023
@potiuk potiuk deleted the add-test-for-back-reference-in-ci branch August 27, 2023 06:13
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.

3 participants

Comments