From 0d4146cb6424db9f44f244a3610b7eb439df66cf Mon Sep 17 00:00:00 2001 From: Alicia Cozine <879121+acozine@users.noreply.github.com> Date: Thu, 11 Mar 2021 17:28:15 -0600 Subject: [PATCH] Mention that minor releases end once the next ansible release is made. (#73836) (#73868) (cherry picked from commit 197e8f5640bbbb4ce12983f0afcf5fa7a06d67aa) Co-authored-by: Toshio Kuratomi --- docs/docsite/rst/roadmap/COLLECTIONS_2_10.rst | 9 ++- docs/docsite/rst/roadmap/COLLECTIONS_3_0.rst | 58 +++++++++++++++++++ 2 files changed, 65 insertions(+), 2 deletions(-) create mode 100644 docs/docsite/rst/roadmap/COLLECTIONS_3_0.rst diff --git a/docs/docsite/rst/roadmap/COLLECTIONS_2_10.rst b/docs/docsite/rst/roadmap/COLLECTIONS_2_10.rst index dd845badbe8..88d6fdcd369 100644 --- a/docs/docsite/rst/roadmap/COLLECTIONS_2_10.rst +++ b/docs/docsite/rst/roadmap/COLLECTIONS_2_10.rst @@ -39,8 +39,13 @@ Release Schedule Ansible-2.10.x patch releases will occur roughly every three weeks if changes to collections have been made or if it is deemed necessary to force an upgrade to a later ansible-base-2.10.x. Ansible-2.10.x patch releases may contain new features but not backwards incompatibilities. In practice, this means we will include new collection versions where either the patch or the minor version number has changed but not when the major number has changed (example: Ansible-2.10 ships with community-crypto-1.1.0; ansible-2.10.1 may ship with community-crypto-1.2.0 but would not ship with community-crypto-2.0.0). -Breaking changes may be introduced in ansible-2.11.0 although we encourage collection owners to use deprecation periods that will show up in at least one Ansible release before being changed incompatibly. -The rough schedule for Ansible-2.11 and beyond (such as how many months we'll aim for between versions) is still to be discussed and likely will be made after 2.10.0 has been released. +.. note:: + + Minor releases will stop when :ref:`Ansible-3 ` is released. See the :ref:`Release and Maintenance Page ` for more information. + + +Breaking changes may be introduced in ansible-3.0 although we encourage collection owners to use deprecation periods that will show up in at least one Ansible release before being changed incompatibly. + For more information, reach out on a mailing list or an IRC channel - see :ref:`communication` for more details. diff --git a/docs/docsite/rst/roadmap/COLLECTIONS_3_0.rst b/docs/docsite/rst/roadmap/COLLECTIONS_3_0.rst new file mode 100644 index 00000000000..2af350ab966 --- /dev/null +++ b/docs/docsite/rst/roadmap/COLLECTIONS_3_0.rst @@ -0,0 +1,58 @@ +.. _ansible_3_roadmap: + +=================== +Ansible project 3.0 +=================== + +This release schedule includes dates for the `ansible `_ package, with a few dates for the `ansible-base `_ package as well. All dates are subject to change. Ansible 3.x.x includes ``ansible-base`` 2.10. See :ref:`base_roadmap_2_10` for the most recent updates on ``ansible-base``. + +.. contents:: + :local: + +Release schedule +================= + +.. note:: + + Ansible is switching from its traditional versioning scheme to `semantic versioning `_ starting with this release. So this version is 3.0.0 instead of 2.11.0. + + + +:2020-12-16: Finalize rules for net-new collections submitted for the ansible release. +:2021-01-27: Final day for new collections to be **reviewed and approved**. They MUST be + submitted prior to this to give reviewers a chance to look them over and for collection owners + to fix any problems. +:2021-02-02: Ansible-3.0.0-beta1 -- feature freeze [1]_ +:2021-02-09: Ansible-3.0.0-rc1 -- final freeze [2]_ [3]_ +:2021-02-16: Release of Ansible-3.0.0 +:2021-03-09: Release of Ansible-3.1.0 (bugfix + compatible features: every three weeks) + +.. [1] No new modules or major features accepted after this date. In practice this means we will freeze the semver collection versions to compatible release versions. For example, if the version of community.crypto on this date was community-crypto-2.1.0; ansible-3.0.0 could ship with community-crypto-2.1.1. It would not ship with community-crypto-2.2.0. + +.. [2] After this date only changes blocking a release are accepted. Accepted changes require creating a new rc and may slip the final release date. +.. [3] Collections will only be updated to a new version if a blocker is approved. Collection owners should discuss any blockers at a community IRC meeting (before this freeze) to decide whether to bump the version of the collection for a fix. See the `Community IRC meeting agenda `_. + + +.. note:: + + Breaking changes may be introduced in Ansible 3.0.0, although we encourage collection owners to use deprecation periods that will show up in at least one Ansible release before the breaking change happens. + + +Ansible minor releases +======================= + +Ansible 3.x.x minor releases will occur approximately every three weeks if changes to collections have been made or if it is deemed necessary to force an upgrade to a later ansible-base-2.10.x. Ansible 3.x.x minor releases may contain new features but not backwards incompatibilities. In practice, this means we will include new collection versions where either the patch or the minor version number has changed but not when the major number has changed. For example, if Ansible-3.0.0 ships with community-crypto-2.1.0; Ansible-3.1.0 may ship with community-crypto-2.2.0 but would not ship with community-crypto-3.0.0). + + +.. note:: + + Minor releases will stop when :ref:`Ansible-4 ` is released. See the :ref:`Release and Maintenance Page ` for more information. + + +For more information, reach out on a mailing list or an IRC channel - see :ref:`communication` for more details. + + +ansible-base release +==================== + +Ansible 3.x.x works with ``ansible-base`` 2.10. See :ref:`base_roadmap_2_10` for details.