You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "amoghrajesh (via GitHub)" <gi...@apache.org> on 2025/02/12 14:51:50 UTC
[PR] Relaxing restriction on multi-lines in feature newsfragments [airflow]
amoghrajesh opened a new pull request, #46681:
URL: https://github.com/apache/airflow/pull/46681
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
Feature newsfragments are change documents that define a new feature being added to Airflow. We should allow some room in there to add some more details about the feature. For instance, one would like to add some working examples.
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
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](https://github.com/apache/airflow/tree/main/newsfragments).
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "Lee-W (via GitHub)" <gi...@apache.org>.
Lee-W commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2658403126
> comments
👍
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2659247720
Closing this one in favour of the previous comment.
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "Lee-W (via GitHub)" <gi...@apache.org>.
Lee-W commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2655258580
> I'm a -0.25 on this one. Historically we've only done more than a single line for things that land in the "Significant" block in the release notes. Adding multiline for other sections would mean a different format for our release notes, and until we have a new standard for that, it falls on the poor release manager to sort out as they are building release notes.
>
> I'd say if there is something worth having more than a single line summary about, it should be significant instead. The example you linked would be better as significant, imo.
Another idea I have (which is probably also how [commitizen](https://github.com/commitizen-tools/commitizen) generates the changelog from longer commits) is adding only the first line to the release note. Rest of them are for ones that cares about the details. so the format would like
```rst
.. description of this feature and etc.
.. this line should be empty
.. detail if 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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2655641896
> does a significant newsfragments only cover "breaking" changes or is it OK to have a significant change that is not a "breaking change"?
I intentionally called it "significant" and not "breaking" for a reason :) but that is a subtle nuance, so fair question.
Also, the release manager is the final check - we will sometimes remove or add things to the significant section anyways.
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2658384142
Good ideas @Lee-W and @jedcunningham.
For the time being, I think I am gonna proceed with changing the newsfrag in my PR to a significant and close this one in that sense. But we should definitely follow up and reconsider the idea of adding rst comments. Sounds ok?
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "Lee-W (via GitHub)" <gi...@apache.org>.
Lee-W commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2655663818
> I intentionally called it "significant" and not "breaking" for a reason :) but that is a subtle nuance, so fair question. (edit: just to be very clear, yes it's fine that it's not breaking! We do it all the time in the helm chart for things like default image versions)
I thought significant == breaking in this case 😲 But if it's not, we can of course add it to significant.
> were you thinking those files lived on post release?
Yep, this is what I thought. I didn't know it would be deleted 🤦♂️
> So are you suggesting the additional lines are added as rst comments? Not visible in the rendered release notes, but visible if you want to look deeper?
Not actually, but it sounds like a good idea 🤔 I think if we want to keep the detail, it's better to be somewhere in the codebase instead of the github issue
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh closed pull request #46681: Relaxing restriction on multi-lines in feature newsfragments
URL: https://github.com/apache/airflow/pull/46681
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2655045744
I'm a -0.25 on this one. Historically we've only done more than a single line for things that land in the "Significant" block in the release notes. Adding multiline for other sections would mean a different format for our release notes, and until we have a new standard for that, it falls on the poor release manager to sort out as they are building release notes.
I'd say if there is something worth having more than a single line summary about, it should be significant instead. The example you linked would be better as significant, imo.
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2655616740
> I'm a -0.25 on this one. Historically we've only done more than a single line for things that land in the "Significant" block in the release notes. Adding multiline for other sections would mean a different format for our release notes, and until we have a new standard for that, it falls on the poor release manager to sort out as they are building release notes.
>
> I'd say if there is something worth having more than a single line summary about, it should be significant instead. The example you linked would be better as significant, imo.
Thanks for the explanation!
I was under the impression that a significant change has to tick one of the boxes under the template:
```
* Types of change
* [ ] Dag changes
* [ ] Config changes
* [ ] API changes
* [ ] CLI changes
* [ ] Behaviour changes
* [ ] Plugin changes
* [ ] Dependency changes
* [ ] Code interface changes
```
Doesn't seem to be the case with precommit. I think the change is "significant" enough in that case. (One qn, maybe for @Lee-W - does a significant newsfragments only cover "breaking" changes or is it OK to have a significant change that is not a "breaking change"?)
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2655621071
I also like the idea from Wei but seems like its an overkill?
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2655649645
> adding only the first line to the release note. Rest of them are for ones that cares about the details.
Interesting idea. Long term the only place these live is in the release notes themselves - the newsfragment files are deleted once its ends up in a release. So are you suggesting the additional lines are added as md comments? Not visible in the rendered release notes, but visible if you want to look deeper? Or were you thinking those files lived on post release?
--
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] Relaxing restriction on multi-lines in feature newsfragments [airflow]
Posted by "amoghrajesh (via GitHub)" <gi...@apache.org>.
amoghrajesh commented on PR #46681:
URL: https://github.com/apache/airflow/pull/46681#issuecomment-2654006797
An example: https://github.com/apache/airflow/pull/46613
I want to add a working example in the feature newsfragment
--
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