Skip to content

Fixing breeze add-back-references command with doc #32649

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.

Sign up for GitHub

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

Merged
potiuk merged 5 commits into from
Jul 18, 2023
Merged

Fixing breeze add-back-references command with doc #32649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ad7f02a
Fixing breeze add-back-references command with doc
amoghrajesh Jul 17, 2023
1e60a1b
review comments from potiuk and eladkal
amoghrajesh Jul 17, 2023
4969bcc
review comments from potiuk and eladkal
amoghrajesh Jul 17, 2023
692448e
testing and fixing issues
amoghrajesh Jul 17, 2023
1e6467b
bringing back
amoghrajesh Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dev/README_RELEASE_AIRFLOW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -805,7 +805,7 @@ Documentation for providers can be found in the ``/docs/apache-airflow`` directo

```shell script
breeze release-management publish-docs --package-filter apache-airflow --package-filter docker-stack
breeze release-management add-back-references --airflow-site-directory --gen-type airflow
breeze release-management add-back-references --gen-type airflow
git add .
git commit -m "Add documentation for Apache Airflow ${VERSION}"
git push
Expand Down
4 changes: 1 addition & 3 deletions dev/README_RELEASE_HELM_CHART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -633,9 +633,7 @@ between the two repositories to be able to build the documentation.
Regenerate `index.yaml` so it can be added to the Airflow website to allow: `helm repo add https://airflow.apache.org`.

```shell
cd "${AIRFLOW_SITE_DIRECTORY}"
breeze release-management add-back-references --airflow-site-directory --gen-type helm
cd ..
breeze release-management add-back-references --gen-type helm
curl https://dist.apache.org/repos/dist/dev/airflow/helm-chart/$RC/index.yaml -o index.yaml
cp ${AIRFLOW_SVN_RELEASE_HELM}/${VERSION}/airflow-${VERSION}.tgz .
helm repo index --merge ./index.yaml . --url "https://downloads.apache.org/airflow/helm-chart/$VERSION"
Expand Down
5 changes: 1 addition & 4 deletions dev/README_RELEASE_PROVIDER_PACKAGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,10 +392,7 @@ breeze release-management publish-docs \
--package-filter 'apache-airflow-providers-*' \
--override-versioned

cd "${AIRFLOW_SITE_DIRECTORY}"
Copy link
Contributor

@eladkal eladkal Jul 17, 2023

Choose a reason for hiding this comment

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

If you remove this cd then please remove also the cd .. in line 397

Copy link
Contributor Author

@amoghrajesh amoghrajesh Jul 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Noted. Will keep in mind while updating the PR

Copy link
Member

@potiuk potiuk Jul 17, 2023

Choose a reason for hiding this comment

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

BTW. I think the best thing is to just ... execute the processs... this way is the only way to check if it works @amoghrajesh - and it does not have to be complete. Like pushing the code does not neede to happen, and up to pushing to airflow repo, all steps can be done by you as well.

Copy link
Contributor Author

@amoghrajesh amoghrajesh Jul 17, 2023

Choose a reason for hiding this comment

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

Thanks for that info, @potiuk
I will try it out now and in the future PRs too!

breeze release-management add-back-references --airflow-site-directory --gen-type providers
cd ..

breeze release-management add-back-references --gen-type providers
Copy link
Contributor

@eladkal eladkal Jul 30, 2023

Choose a reason for hiding this comment

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

@aminghadersohi I suspect this doesn't work as expected for redirects between providers like was done in #32306

This caused creation of latest folder in the Google provider:

Screenshot 2023-07-30 at 10 13 15

Which caused failure in doc site build https://github.com/apache/airflow-site/actions/runs/5704523295/job/15458213062

When I removed the latest folder build ran successfully
apache/airflow-site@f8b1460

Copy link
Contributor

@eladkal eladkal Jul 30, 2023

Choose a reason for hiding this comment

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

Ah NVM this is issue in the path #32945
I guess we can work on a pre commit to avoid such cases in the future

```

If you see `ModuleNotFoundError: No module named 'docs'`, set:
Expand Down