Skip to content

Update dev instructions to use breeze command directly with short package ids to build docs #35080

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

Jump to bottom
Merged
jedcunningham merged 5 commits into from
Oct 25, 2023
Merged

Update dev instructions to use breeze command directly with short package ids to build docs #35080

jedcunningham merged 5 commits into from
Oct 25, 2023

Conversation

@anudeep-pv
Copy link
Contributor

@anudeep-pv anudeep-pv commented Oct 20, 2023 •
edited
Loading

Update dev instructions to use breeze command directly with short package ids to build docs

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

@boring-cyborg
Copy link

boring-cyborg bot commented Oct 20, 2023

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

amoghrajesh
amoghrajesh reviewed Oct 20, 2023
View reviewed changes
dev/provider_packages/build_provider_documentation.py Outdated
Comment on lines 43 to 48
try:
subprocess.run([".breeze", "build-docs", "--clean-build"] + provider_filters, check=True)
except subprocess.CalledProcessError as e:
raise Exception(f"Failed to build provider docs with .breeze: {e}")

os.chdir(os.environ["AIRFLOW_SITE_DIRECTORY"])
Copy link
Contributor

@amoghrajesh amoghrajesh Oct 20, 2023

Choose a reason for hiding this comment

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

Instead of using subprocess, can we call the functions that the breeze build-docs calls?

potiuk
potiuk requested changes Oct 20, 2023
View reviewed changes
Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

Actually.. This might be a bit sad news for you @anudeep-pv but we do not need this script any more. And rather than converting it to python we should change the instructions to use breeze build-docs amazon apache.beam google .... - after I completed it in #35068

The only reason we had this script in the first place was that we already had list of providers during the release step in the form of amazon apache.beam google and we wanted to conver it to --package-filter apache-airlfow-providers-amazon --package-filter-providers-apache-beam --package-filter apache-airflow-providers-google

The #35068 and earlier steps made it possible to use the short form of provider ids directly so this script can be simply removed and breeze build-docs command can be used directly.

@anudeep-pv
Copy link
Contributor Author

anudeep-pv commented Oct 25, 2023

Actually.. This might be a bit sad news for you @anudeep-pv but we do not need this script any more. And rather than converting it to python we should change the instructions to use breeze build-docs amazon apache.beam google .... - after I completed it in #35068

The only reason we had this script in the first place was that we already had list of providers during the release step in the form of amazon apache.beam google and we wanted to conver it to --package-filter apache-airlfow-providers-amazon --package-filter-providers-apache-beam --package-filter apache-airflow-providers-google

The #35068 and earlier steps made it possible to use the short form of provider ids directly so this script can be simply removed and breeze build-docs command can be used directly.

Thanks for the detailed comment. I've updated PR by removing the script and changing the command in dev documentation.

@anudeep-pv anudeep-pv changed the title Rewrite build_provider_documentation in python Update dev instructions to use breeze command directly with short package ids for to builds docs Oct 25, 2023
@anudeep-pv anudeep-pv changed the title Update dev instructions to use breeze command directly with short package ids for to builds docs Update dev instructions to use breeze command directly with short package ids to build docs Oct 25, 2023
@jedcunningham jedcunningham merged commit f1f5560 into apache:main Oct 25, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 25, 2023

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@jedcunningham
Copy link
Member

jedcunningham commented Oct 25, 2023

Thanks @anudeep-pv! Congrats on your first commit!

potiuk pushed a commit that referenced this pull request Oct 29, 2023
@anudeep-pv @potiuk
Update dev instructions to use breeze command directly with short pac…
53791bb 
…kage ids to build docs (#35080)

(cherry picked from commit f1f5560)
@potiuk potiuk added the changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) label Oct 29, 2023
@potiuk potiuk added this to the Airflow 2.7.3 milestone Oct 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@amoghrajesh amoghrajesh amoghrajesh left review comments

@potiuk potiuk potiuk approved these changes

@jedcunningham jedcunningham jedcunningham approved these changes

@kaxil kaxil Awaiting requested review from kaxil kaxil is a code owner

@pierrejeambrun pierrejeambrun Awaiting requested review from pierrejeambrun

@ashb ashb Awaiting requested review from ashb ashb is a code owner

Assignees

No one assigned

Labels

area:dev-tools changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..)

Projects

None yet

Milestone

Airflow 2.7.3

Development

Successfully merging this pull request may close these issues.

4 participants

@anudeep-pv @jedcunningham @potiuk @amoghrajesh