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

Add comment about versions updated by release manager #37488

Merged
merged 1 commit into from
Feb 16, 2024

Conversation

potiuk
Copy link
Member

@potiuk potiuk commented Feb 16, 2024


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@Taragolis
Copy link
Contributor

Maybe also add small note into the template?

__version__ = "{{ RELEASE }}{{ VERSION_SUFFIX }}"

Or better add it after rc2 of providers?

@potiuk
Copy link
Member Author

potiuk commented Feb 16, 2024

Maybe also add small note into the template?

__version__ = "{{ RELEASE }}{{ VERSION_SUFFIX }}"

Or better add it after rc2 of providers?

We have this note there in the generated init.py files., Isn't that enough?

# NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE
# OVERWRITTEN WHEN PREPARING DOCUMENTATION FOR THE PACKAGES.
#
# IF YOU WANT TO MODIFY THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
# `PROVIDER__INIT__PY_TEMPLATE.py.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY

Or better add it after rc2 of providers?

yep. we should merge it after Rc2 are out.

@Taragolis
Copy link
Contributor

Taragolis commented Feb 16, 2024

We have this note there in the generated init.py files., Isn't that enough?

I want to believe that in most cases it enough, but maybe first-time contributors do not always read comments or think this is a part of licence or some sort of that.

Some recent examples
#37244 (comment)
#36449 (comment)

@potiuk
Copy link
Member Author

potiuk commented Feb 16, 2024

I want to believe that in most cases it enough, but maybe first-time contributors do not always read comments or think this is a part of licence or some sort of that.

This is granted. No matter how hard you try, some people will not read things. This is usually survivorship bias - i.e. you do not know about the 100 who did and you see the 2 who did not.

But in this case the question is - what ELSE we can do. If you think you can do it in a better way that people will not skip when reading, then I am all ears and happy to accept it described differently/additionally.

@Taragolis
Copy link
Contributor

__version__ = 'x.y.z'  # If you would like to change the version, please scroll up a bit

🤣

Or some additional indents for notes, but need to check how it would work when we implement D104

#
# vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
# NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE
# OVERWRITTEN WHEN PREPARING DOCUMENTATION FOR THE PACKAGES.
#
# IF YOU WANT TO MODIFY THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
# `PROVIDER__INIT__PY_TEMPLATE.py.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

@potiuk potiuk merged commit 5a0be39 into apache:main Feb 16, 2024
62 checks passed
@potiuk potiuk deleted the add-comment-about-ugprading-versions branch February 16, 2024 20:39
@potiuk
Copy link
Member Author

potiuk commented Feb 16, 2024

version = 'x.y.z' # If you would like to change the version, please scroll up a bit

Why not :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment