ashb commented on code in PR #74589:
URL: https://github.com/apache/airflow/pull/74589#discussion_r4249204410
##########
contributing-docs/18_contribution_workflow.rst:
##########
@@ -325,3 +309,39 @@ on your PR and mention that you think it is ready to be
merged. Also, it's a goo
to latest ``main``, because there could be other changes merged in the
meantime that might cause conflicts or
fail tests or static checks, so by rebasing a PR that has been build few days
ago you make sure that it
still passes the tests and static checks today.
+
+
+Newsfragments
+-------------
+
+Newsfragments are only consumed by ``airflow-core/``, ``chart/`` and
``dev/mypy/``. Do not add one by default.
+
+For ``airflow-core/`` (including ``task-sdk/``, which ships with
``airflow-core``), use only ``significant``
+newsfragments, and only for a change users must read before upgrading:
+
+* a behaviour change, a removal or a new default,
+* a change that needs migration steps,
+* a change that cannot be explained in the one-line commit title.
Review Comment:
This feels too broad. If it trigger one of the previous two points, I don't
think a newsfragment is needed?
##########
contributing-docs/18_contribution_workflow.rst:
##########
@@ -325,3 +309,39 @@ on your PR and mention that you think it is ready to be
merged. Also, it's a goo
to latest ``main``, because there could be other changes merged in the
meantime that might cause conflicts or
fail tests or static checks, so by rebasing a PR that has been build few days
ago you make sure that it
still passes the tests and static checks today.
+
+
+Newsfragments
+-------------
+
+Newsfragments are only consumed by ``airflow-core/``, ``chart/`` and
``dev/mypy/``. Do not add one by default.
+
+For ``airflow-core/`` (including ``task-sdk/``, which ships with
``airflow-core``), use only ``significant``
+newsfragments, and only for a change users must read before upgrading:
+
+* a behaviour change, a removal or a new default,
+* a change that needs migration steps,
+* a change that cannot be explained in the one-line commit title.
+
+A ``significant`` newsfragment does not have to be a breaking change. Do not
add a newsfragment for an
+ordinary bug fix, feature, improvement or documentation change, or for
internal refactors, CI, tooling and
+tests. For ``chart/``, add a newsfragment only for major or breaking changes.
+
+If you are unsure, leave it out. A maintainer will ask for one during review
if it is needed.
+
+Never add newsfragments for ``providers/`` or ``airflow-ctl/``: their release
managers regenerate the
+changelog from the commit history. For a user-visible note, edit the changelog
directly: the provider's
+``docs/changelog.rst`` (see `providers/AGENTS.md
</providers/AGENTS.md#changelog--never-use-newsfragments>`__)
+or ``airflow-ctl/RELEASE_NOTES.rst``.
+
+To add a newsfragment, create an ``rst`` file named ``{pr_number}.{type}.rst``
(e.g. ``1234.significant.rst``)
+and place it in `airflow-core/newsfragments </airflow-core/newsfragments>`__
for core newsfragments, or
+`chart/newsfragments </chart/newsfragments>`__ for helm chart newsfragments.
The towncrier config accepts the
+types ``significant``, ``feature``, ``improvement``, ``bugfix``, ``doc`` and
``misc``.
Review Comment:
Are you sure this list is right?
But `doc` and `misc` almost, by definition won't ever need newsfragments?
##########
contributing-docs/18_contribution_workflow.rst:
##########
@@ -325,3 +309,39 @@ on your PR and mention that you think it is ready to be
merged. Also, it's a goo
to latest ``main``, because there could be other changes merged in the
meantime that might cause conflicts or
fail tests or static checks, so by rebasing a PR that has been build few days
ago you make sure that it
still passes the tests and static checks today.
+
+
+Newsfragments
+-------------
+
+Newsfragments are only consumed by ``airflow-core/``, ``chart/`` and
``dev/mypy/``. Do not add one by default.
+
+For ``airflow-core/`` (including ``task-sdk/``, which ships with
``airflow-core``), use only ``significant``
Review Comment:
This isn't really true. task-sdk is it's own dist. It currently ships on the
same schedule as airflow-core, but I think we need to be more precise here.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
