Skip to content

Update docs README.rst to clarify --package-filter usage - #35045

Closed
RNHTTR wants to merge 4 commits into
apache:mainfrom
RNHTTR:patch-7
Closed

Update docs README.rst to clarify --package-filter usage#35045
RNHTTR wants to merge 4 commits into
apache:mainfrom
RNHTTR:patch-7

Conversation

@RNHTTR

Copy link
Copy Markdown
Contributor

Make the --package-filter flag a bit more clear, and demonstrate that it can be used for multiple packages.

Make the --package-filter flag a bit more clear, and demonstrate that it can be used for multiple packages.
@RNHTTRRNHTTR changed the title Update README.rstUpdate docs README.rst to clarify --package-filter usageOct 19, 2023
Comment threaddocs/README.rst
@potiuk

Copy link
Copy Markdown
Member

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

@github-actions

Copy link
Copy Markdown
Contributor

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.

@github-actionsgithub-actionsBot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Dec 4, 2023
@github-actionsgithub-actionsBot removed the stale Stale PRs per the .github/workflows/stale.yml policy file label Dec 10, 2023
@eladkaleladkal added this to the Airflow 2.8.1 milestone Dec 10, 2023
@eladkaleladkal added the changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) label Dec 10, 2023
Comment on lines +483 to +485
"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>",

@potiukpotiukDec 10, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
"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>",
"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*'." ,

@potiuk

Copy link
Copy Markdown
Member

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.

@amoghrajeshamoghrajesh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM +1
Test needs fixing

@RNHTTR

Copy link
Copy Markdown
ContributorAuthor

Closed by: #36287

@RNHTTRRNHTTR closed this Jan 2, 2024
@RNHTTR
RNHTTR deleted the patch-7 branch January 2, 2024 23:28
@ephraimbuddyephraimbuddy removed this from the Airflow 2.8.1 milestone Jan 14, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog:skipChanges that should be skipped from the changelog (CI, tests, etc..)kind:documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@RNHTTR@potiuk@utkarsharma2@amoghrajesh@ephraimbuddy@eladkal