docs(newsfragment): add template for significant newsfragments #44378
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Lee-W
force-pushed
the
add-significant-newsfragements-template
branch
2 times, most recently
from
cc83957 to
740d841
Compare
|
I've conducted some research into towncrier. It appears that there isn't a clever way to generate news fragments via templates, and it doesn't verify the content either. I'm not sure whether we should implement a script to check these sigificant files. The best we can do is probably check whether the checkboxes exist. |
kaxil
approved these changes
Nov 26, 2024
potiuk
reviewed
Nov 27, 2024
Lee-W
force-pushed
the
add-significant-newsfragements-template
branch
from
740d841 to
6e86092
Compare
potiuk
approved these changes
Nov 27, 2024
Lee-W
force-pushed
the
add-significant-newsfragements-template
branch
from
4089e41 to
09368ca
Compare
|
I'll do some test on the script before merging it |
Lee-W
force-pushed
the
add-significant-newsfragements-template
branch
from
09368ca to
e81c381
Compare
Lee-W
added
the
airflow3.0:breaking
Lee-W
force-pushed
the
add-significant-newsfragements-template
branch
from
837e8ee to
d010561
Compare
ArshiaZr
pushed a commit
to ArshiaZr/airflow
that referenced
this pull request
Nov 27, 2024
…e#44378) * docs(newsfragment): add template for significant newsfragments Closes: apache#44374 * docs(contributing-docs): add sigificant file template description * ci(github-actions): add script to check the news fragment content
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes: #44374
Why
make updating #41641 and https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+3+breaking+changes easier
What
Add a template and a command line to generate a file based on the description to the doc
^ 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.rstor{issue_number}.significant.rst, in newsfragments.