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

docs(newsfragment): add template for significant newsfragments #44378

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Lee-W
Copy link
Member

@Lee-W Lee-W commented Nov 26, 2024

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.rst or {issue_number}.significant.rst, in newsfragments.

@Lee-W Lee-W force-pushed the add-significant-newsfragements-template branch from 57e441f to cc83957 Compare November 26, 2024 09:30
@Lee-W Lee-W force-pushed the add-significant-newsfragements-template branch from cc83957 to 740d841 Compare November 26, 2024 10:51
@Lee-W Lee-W marked this pull request as ready for review November 26, 2024 10:54
@Lee-W
Copy link
Member Author

Lee-W commented Nov 26, 2024

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.

Copy link
Member

@kaxil kaxil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah let's some validation via script if towncrier can't do it for us

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create news fragments template
2 participants