-
Notifications
You must be signed in to change notification settings - Fork 14.6k
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
version_added
field in configuration option doesn't work correctly in providers documentation
#34005
Comments
version_added
field in configuration option doesn't work correctly in Providersversion_added
field in configuration option doesn't work correctly in providers
I raised it in |
I believed (at least ) It's been fixed. |
|
I check that only IMAP set value greater than 2.7/2.8 airflow/airflow/providers/imap/provider.yaml Lines 68 to 89 in c077d19
As result this option not presented into the doc: I'm not sure for 100% but seems like it might only affect documentation. Because configs generated without any problem |
Yes. I think I fixed "generation" but documentation might be wrong. |
version_added
field in configuration option doesn't work correctly in providersversion_added
field in configuration option doesn't work correctly in providers documentation
The `version_added` for packages should use package version, not Airflow version. Fixes: apache#34005
Fix in #34011 |
The `version_added` for packages should use package version, not Airflow version. Fixes: #34005
Apache Airflow version
2.7.0
What happened
Initial finding: #33960 (comment)
Since Airflow 2.7.0 we have an ability to store configuration options in providers, everything works fine, except field
version_added
.The logic around this field expect Airflow version and not Provider version. Any attempt to add in this field any value greater than current version of Airflow (2.7.0 at that moment) will result that configuration option won't rendered in documentation, seem like it not prevented to add this configuration at least
airflow config get-value
command return expected option.What you think should happen instead
Various, depend on final solution and decision.
Option 1:
In case if we would not like use this field for providers we might ignore this field in providers configurations.
For Community Providers we could always set it to
~
Option 2:
Dynamically resolve depend on what a source of this configuration, Core/Provider
Option 3:
Add
provider_version_added
and use for show in which version of provider this configuration addedWe could keep
version_added
if configuration option in provider related to Airflow VersionOption 4:
Suggest you own 😺
How to reproduce
Create configuration option with
version_added
greater than current version of Airflow, for stable it is 2.7.0 for dev 2.8.0Operating System
n/a
Versions of Apache Airflow Providers
n/a
Deployment
Other
Deployment details
No response
Anything else
No response
Are you willing to submit PR?
Code of Conduct
The text was updated successfully, but these errors were encountered: