You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "RNHTTR (via GitHub)" <gi...@apache.org> on 2023/10/19 02:43:30 UTC
[PR] Update README.rst [airflow]
RNHTTR opened a new pull request, #35045:
URL: https://github.com/apache/airflow/pull/35045
Make the --package-filter flag a bit more clear, and demonstrate that it can be used for multiple packages.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]
Posted by "RNHTTR (via GitHub)" <gi...@apache.org>.
RNHTTR closed pull request #35045: Update docs README.rst to clarify --package-filter usage
URL: https://github.com/apache/airflow/pull/35045
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #35045:
URL: https://github.com/apache/airflow/pull/35045#issuecomment-1848965491
Approved - proposed one NIT: improvement (`--package-filter` allows glob pattern matching), you will akso need to apply static checks to include the description in the help screenshots.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]
Posted by "utkarsharma2 (via GitHub)" <gi...@apache.org>.
utkarsharma2 commented on code in PR #35045:
URL: https://github.com/apache/airflow/pull/35045#discussion_r1365849239
##########
docs/README.rst:
##########
@@ -53,11 +53,11 @@ or just to run documentation building
breeze build-docs --docs-only
-Also, you can only build one documentation via ``--package-filter``.
+Also, you can only build documentation for a subset of packages via ``--package-filter``. For example, to build documentation only for the main Airflow package and the Kubernetes provider package, you can run the following command:
.. code-block:: bash
- breeze build-docs --package-filter <PACKAGE-NAME>
+ breeze build-docs --package-filter apache-airflow --package-filter apache-airflow-providers-cncf-kubernetes
Review Comment:
You may want to update here as well - https://github.com/apache/airflow/blob/e6f445129a998eab62d71bd91b4a5f46cd77c1de/dev/breeze/src/airflow_breeze/commands/developer_commands.py#L370
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #35045:
URL: https://github.com/apache/airflow/pull/35045#discussion_r1421750483
##########
dev/breeze/src/airflow_breeze/commands/developer_commands.py:
##########
@@ -480,7 +480,9 @@ def start_airflow(
"--package-filter",
help="List of packages to consider. You can use the full names like apache-airflow-providers-<provider>, "
"the short hand names or the glob pattern matching the full package name. "
- "The list of short hand names can be found in --help output",
+ "The list of short hand names can be found in --help output "
+ "Multiple package filters can be applied by passing the flag multiple times. "
+ "For example --package-filter apache-airflow --package-filter apache-airflow-providers-<provider>",
Review Comment:
```suggestion
"The list of short hand names can be found in --help output "
"Multiple package filters can be applied by passing the flag multiple times. "
"For example --package-filter apache-airflow --package-filter apache-airflow-providers-<provider>. "
"You can also specify glob-pattern. For example --package-filter *providers*. " ,
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]
Posted by "utkarsharma2 (via GitHub)" <gi...@apache.org>.
utkarsharma2 commented on code in PR #35045:
URL: https://github.com/apache/airflow/pull/35045#discussion_r1365844502
##########
docs/README.rst:
##########
@@ -53,11 +53,11 @@ or just to run documentation building
breeze build-docs --docs-only
-Also, you can only build one documentation via ``--package-filter``.
+Also, you can only build documentation for a subset of packages via ``--package-filter``. For example, to build documentation only for the main Airflow package and the Kubernetes provider package, you can run the following command:
.. code-block:: bash
- breeze build-docs --package-filter <PACKAGE-NAME>
+ breeze build-docs --package-filter apache-airflow --package-filter apache-airflow-providers-cncf-kubernetes
Review Comment:
This example was much needed :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #35045:
URL: https://github.com/apache/airflow/pull/35045#issuecomment-1771799206
Just realized @RNHTTR @utkarsharma2 @Taragolis : We have not finished switching from `--package-filter` to command parameters, it used to be that `--package-fllter had autocompletion and list of packages but before Summit with @amoghrajesh we moved it command option - see #35067
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #35045:
URL: https://github.com/apache/airflow/pull/35045#discussion_r1421750483
##########
dev/breeze/src/airflow_breeze/commands/developer_commands.py:
##########
@@ -480,7 +480,9 @@ def start_airflow(
"--package-filter",
help="List of packages to consider. You can use the full names like apache-airflow-providers-<provider>, "
"the short hand names or the glob pattern matching the full package name. "
- "The list of short hand names can be found in --help output",
+ "The list of short hand names can be found in --help output "
+ "Multiple package filters can be applied by passing the flag multiple times. "
+ "For example --package-filter apache-airflow --package-filter apache-airflow-providers-<provider>",
Review Comment:
```suggestion
"The list of short hand names can be found in --help output "
"Multiple package filters can be applied by passing the flag multiple times. "
"For example --package-filter apache-airflow --package-filter apache-airflow-providers-<provider>. "
"You can also specify glob-pattern. For example --package-filter '*providers*'." ,
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #35045:
URL: https://github.com/apache/airflow/pull/35045#issuecomment-1837652809
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Update docs README.rst to clarify --package-filter usage [airflow]
Posted by "RNHTTR (via GitHub)" <gi...@apache.org>.
RNHTTR commented on PR #35045:
URL: https://github.com/apache/airflow/pull/35045#issuecomment-1874682602
Closed by: #36287
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org