Skip to content
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.

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

Fix upgrade docs to reflect true cli flags available #37231

Merged
merged 3 commits into from Feb 7, 2024
Merged

Conversation

jdistler
Copy link
Contributor

@jdistler jdistler commented Feb 7, 2024

The upgrade docs section concerning Offline SQL migration scripts are incorrect and reference cli flags which are not supported by the latest release of airflow -

Screenshot 2024-02-07 at 1 12 31 PM

The flags -r and --revision-range are dead code with no references (to be cleaned up in a subsequent PR). These flags are not used by the airflow db migrate command. The true set of flags are these.

I have updated the documentation to reflect that users should actually be using the flags --show-sql-only and --from-version.

Copy link

boring-cyborg bot commented Feb 7, 2024

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 Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.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

@jdistler jdistler changed the title Fix upgrade docs to reflect true cli arguments available Fix upgrade docs to reflect true cli flags available Feb 7, 2024
@potiuk potiuk merged commit 4778c49 into apache:main Feb 7, 2024
54 checks passed
Copy link

boring-cyborg bot commented Feb 7, 2024

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

@ephraimbuddy ephraimbuddy added this to the Airflow 2.8.2 milestone Feb 19, 2024
@ephraimbuddy ephraimbuddy added the type:doc-only Changelog: Doc Only label Feb 19, 2024
ephraimbuddy pushed a commit that referenced this pull request Feb 20, 2024
* Fix upgrade docs to reflect true cli arguments available

* Add in to version for parity

* Use shortened flag in first example

(cherry picked from commit 4778c49)
ephraimbuddy pushed a commit that referenced this pull request Feb 20, 2024
* Fix upgrade docs to reflect true cli arguments available

* Add in to version for parity

* Use shortened flag in first example

(cherry picked from commit 4778c49)
ephraimbuddy pushed a commit that referenced this pull request Feb 22, 2024
* Fix upgrade docs to reflect true cli arguments available

* Add in to version for parity

* Use shortened flag in first example

(cherry picked from commit 4778c49)
abhishekbhakat pushed a commit to abhishekbhakat/my_airflow that referenced this pull request Mar 5, 2024
* Fix upgrade docs to reflect true cli arguments available

* Add in to version for parity

* Use shortened flag in first example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants