Skip to content

Revising instructions to run back referencing scripts #32613

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 2 commits into from
Jul 15, 2023
Merged

Revising instructions to run back referencing scripts #32613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ff1305
Revising instructions to run back referencing scripts
amoghrajesh Jul 14, 2023
49d09a4
removing the values
amoghrajesh Jul 14, 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
5 changes: 1 addition & 4 deletions dev/README_RELEASE_AIRFLOW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -805,10 +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
cd "${AIRFLOW_SITE_DIRECTORY}"
cd post-docs
python add-back-references.py airflow
cd ..
breeze release-management add-back-references --airflow-site-directory --gen-type airflow
git add .
git commit -m "Add documentation for Apache Airflow ${VERSION}"
git push
Expand Down
3 changes: 1 addition & 2 deletions dev/README_RELEASE_HELM_CHART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,8 +634,7 @@ between the two repositories to be able to build the documentation.

```shell
cd "${AIRFLOW_SITE_DIRECTORY}"
cd post-docs
python add-back-references.py helm
breeze release-management add-back-references --airflow-site-directory --gen-type helm
cd ..
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 .
Expand Down
3 changes: 1 addition & 2 deletions dev/README_RELEASE_PROVIDER_PACKAGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,8 +393,7 @@ breeze release-management publish-docs \
--override-versioned

cd "${AIRFLOW_SITE_DIRECTORY}"
cd post-docs
python add-back-references.py providers
breeze release-management add-back-references --airflow-site-directory --gen-type providers
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.

this doesn't work for me

➜  airflow-site git:(main) ✗ breeze release-management add-back-references --airflow-site-directory --gen-type providers
                                                                                                                                                                                     
 Usage: breeze release-management add-back-references [OPTIONS]                                                                                                                      
                                                                                                                                                                                     
                                                                                                                                                                                     
 Try running the '--help' flag for more information.                                                                                                                                 
                                                                                                                                                                                     
╭─ Error ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Missing option '-g' / '--gen-type'.                                                                                                                                               │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
                                                                                                                                                                                     
                                                                                                                                                                                     
 To find out more, visit https://github.com/apache/airflow/blob/main/BREEZE.rst

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 reporting
I will have a look at it and fix it soon if there's an issue

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.

Can you try without the --airflow-directory? What does it complain?

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.

Yes --airflow-site-directory is a clear problem. It treats --gen-dir as value of the --airflow-site-directory

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.

Yeah, i have fixed this in a follow up PR

cd ..

```
Expand Down