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

Feature: Allow description to be passed in when using variables CLI #34791

Merged
merged 19 commits into from Oct 29, 2023

Conversation

Zhenye-Na
Copy link
Contributor

@Zhenye-Na Zhenye-Na commented Oct 5, 2023

Notes

This PR closes: #34756

Testing

pre-commit run  --all-files

Check if all hooks apply to the repository.........................................Passed
Add TOC for Markdown and RST files.................................................Passed
Add license for all SQL files......................................................Passed
Add license for all RST files......................................................Passed
Add license for all CSS/JS/JSX/PUML/TS/TSX files...................................Passed
Add license for all JINJA template files...........................................Passed
Add license for all Shell files....................................................Passed
Add license for all Python files...................................................Passed
Add license for all XML files......................................................Passed
Add license for all Helm template files............................................Passed
Add license for all YAML files except Helm templates...............................Passed
Add license for all Markdown files.................................................Passed
Add license for all other files....................................................Passed
Run black (Python formatter).......................................................Passed
Check and update common.sql API stubs..............................................Passed
Update black versions everywhere...................................................Passed
ruff...............................................................................Passed
Run black on Python code blocks in documentation files.............................Passed
Check that merge conflicts are not being committed.................................Passed
Detect accidentally committed debug statements.....................................Passed
Require literal syntax when initializing builtin types.............................Passed
Detect if private key is added to the repository...................................Passed
Make sure that there is an empty line at the end...................................Passed
Detect if mixed line ending is used (\r vs. \r\n)..................................Passed
Check that executables have shebang................................................Passed
Check XML files with xmllint.......................................................Passed
Remove trailing whitespace at end of line..........................................Passed
Remove encoding header from Python files...........................................Passed
Format JSON files..................................................................Passed
Check if RST files use double backticks for code...................................Passed
Check if there are no deprecate log warn...........................................Passed
Check YAML files with yamllint.....................................................Passed
Run flynt string format converter for Python.......................................Passed
Run codespell to check for common misspellings in files............................Passed
Validate pyproject.toml............................................................Passed
Replace bad characters.............................................................Passed
Lint OpenAPI using spectral........................................................Passed
Lint OpenAPI using openapi-spec-validator..........................................Passed
Lint Dockerfile....................................................................Passed
Check order of dependencies in setup.cfg and setup.py..............................Passed
Check airflow.kubernetes imports are not used......................................Passed
Check cncf.kubernetes imports used for executors only..............................Passed
Checks setup extra packages........................................................Passed
Check compatibility of Providers with Airflow......................................Passed
Check google-re2 is declared as dependency when needed.............................Passed
Update mounts in the local yml file................................................Passed
Update cross-dependencies for providers packages...................................Passed
Update extras in documentation.....................................................Passed
Check order of extras in Dockerfile................................................Passed
Updates supported versions in documentation........................................Passed
Check that the REVISION_HEADS_MAP is up-to-date....................................Passed
Update version to the latest version in the documentation..........................Passed
Check for pydevd debug statements accidentally left................................Passed
Verify example dags do not use hard-coded version numbers..........................Passed
Don't use safe in templates........................................................Passed
No providers imports in core example DAGs..........................................Passed
Do not use DeprecationWarning in providers.........................................Passed
No relative imports................................................................Passed
Don't use urlparse in code.........................................................Passed
Check NEW_SESSION is only used with @provide_session...............................Passed
Check for language that we do not accept as community..............................Passed
Check BaseOperator and partial() arguments.........................................Passed
Check model __init__ and decorator arguments are in sync...........................Passed
Check BaseOperator[Link] core imports..............................................Passed
Check BaseOperator[Link] other imports.............................................Passed
Check @task decorator implements custom_operator_name..............................Passed
Verify usage of Airflow deprecation classes in core................................Passed
Check provide_session and create_session imports...................................Passed
Make sure LoggingMixin is not used alone...........................................Passed
Make sure days_ago is imported from airflow.utils.dates............................Passed
start_date not to be defined in default_args in example_dags.......................Passed
Check if licenses are OK for Apache................................................Passed
Check if aiobotocore is an optional dependency only................................Passed
Checks for Boring Cyborg configuration consistency.................................Passed
Sort INTHEWILD.md alphabetically...................................................Passed
Sort alphabetically and uniquify installed_providers.txt...........................Passed
Sort alphabetically and uniquify spelling_wordlist.txt.............................Passed
Lint Helm Chart....................................................................Passed
Check Shell scripts syntax correctness.............................................Passed
stylelint..........................................................................Passed
Provider init file is missing......................................................Passed
Provider subpackage init files are there...........................................Passed
Validate hook IDs & names and sync with docs.......................................Passed
Update Breeze README.md with config files hash.....................................Passed
Breeze should have small number of top-level dependencies..........................Passed
Check if system tests have required segments of code...............................Passed
Generate PyPI README...............................................................Passed
Run markdownlint...................................................................Passed
Lint JSON Schema files with JSON Schema............................................Passed
Lint NodePort Service with JSON Schema.............................................Passed
Lint Docker compose files with JSON Schema.........................................Passed
Lint chart/values.schema.json file with JSON Schema................................Passed
Vendor k8s definitions into values.schema.json.....................................Passed
Lint chart/values.yaml file with JSON Schema.......................................Passed
Lint config_templates/config.yml file with JSON Schema.............................Passed
Check that workflow files have persist-credentials disabled........................Passed
Check that docstrings do not specify param types...................................Passed
Lint chart/values.schema.json file.................................................Passed
Inline Dockerfile and Dockerfile.ci scripts........................................Passed
Check changelogs for duplicate entries.............................................Passed
Check newsfragments are valid......................................................Passed
Update output of breeze commands in BREEZE.rst.....................................Passed
Check that example dags url include provider versions..............................Passed
Check that system tests is properly added..........................................Passed
Check that all logging methods are lazy............................................Passed
Create missing init.py files in tests..............................................Passed
TS types generation / ESLint / Prettier against UI files...........................Passed
Check that unit tests do not inherit from unittest.TestCase........................Passed
Use re2 module instead of re.......................................................Passed
Check default value of deferrable attribute........................................Passed
Run mypy for dev...................................................................Failed
- hook id: mypy-dev
- exit code: 1

The image ghcr.io/Zhenye-Na/airflow/main/ci/python3.8 is not available

@Zhenye-Na
Copy link
Contributor Author

Having some issue with CI, resolving those issues now

@Zhenye-Na
Copy link
Contributor Author

Fixed unit test errors

breeze testing tests --test-type CLI

tests/cli/test_cli_parser.py ....................................        [  9%]
tests/cli/commands/test_celery_command.py ..........                     [ 12%]
tests/cli/commands/test_cheat_sheet_command.py .                         [ 12%]
tests/cli/commands/test_config_command.py ..................             [ 17%]
tests/cli/commands/test_connection_command.py .......................... [ 24%]
.....................                                                    [ 29%]
tests/cli/commands/test_dag_command.py ................................. [ 38%]
..                                                                       [ 38%]
tests/cli/commands/test_dag_processor_command.py .                       [ 39%]
tests/cli/commands/test_db_command.py .................................. [ 48%]
.................................                                        [ 57%]
tests/cli/commands/test_info_command.py ............                     [ 60%]
tests/cli/commands/test_internal_api_command.py .......                  [ 62%]
tests/cli/commands/test_jobs_command.py ......                           [ 63%]
tests/cli/commands/test_kerberos_command.py ..                           [ 64%]
tests/cli/commands/test_kubernetes_command.py ..........                 [ 66%]
tests/cli/commands/test_legacy_commands.py ...                           [ 67%]
tests/cli/commands/test_plugins_command.py ...                           [ 68%]
tests/cli/commands/test_pool_command.py ...........                      [ 71%]
tests/cli/commands/test_rotate_fernet_key_command.py ..                  [ 71%]
tests/cli/commands/test_scheduler_command.py ..................          [ 76%]
tests/cli/commands/test_standalone_command.py ................           [ 80%]
tests/cli/commands/test_task_command.py ................................ [ 89%]
............                                                             [ 92%]
tests/cli/commands/test_triggerer_command.py .                           [ 92%]
tests/cli/commands/test_variable_command.py ...........                  [ 95%]
tests/cli/commands/test_version_command.py .                             [ 96%]
tests/cli/commands/test_webserver_command.py ...............             [100%]


All Warning errors can be found in the /files/warnings-CLI-postgres.txt file.
================= 377 passed, 52 warnings in 192.05s (0:03:12) =================
Number of warnings: 26 /files/warnings-CLI-postgres.txt

Will be publishing next revision in a bit

@Zhenye-Na Zhenye-Na marked this pull request as ready for review October 8, 2023 04:48
@Zhenye-Na
Copy link
Contributor Author

Used Github UI to rebase the feature branch.

@Taragolis Taragolis changed the title Feature: Allow description to be passed in when uring variables CLI Feature: Allow description to be passed in when using variables CLI Oct 10, 2023
@eladkal eladkal added this to the Airflow 2.8.0 milestone Oct 10, 2023
@eladkal eladkal added the type:improvement Changelog: Improvements label Oct 10, 2023
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
@eladkal eladkal merged commit 77ae1de into apache:main Oct 29, 2023
44 checks passed
@Zhenye-Na Zhenye-Na deleted the 34756 branch November 2, 2023 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:CLI type:improvement Changelog: Improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CLI: Variables set should allow to set description
5 participants