-
Notifications
You must be signed in to change notification settings - Fork 846
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: Removal of top-level --file breaking change #5308
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The content looks good. Do we want to collect simple breaking changes that only occur in a single release version under the same H2 header for that version? I realize the datasource identification doesn't fall into that camp so maybe it trails below the 24.1 section as it bridges multiple release versions.
Here's the diff I was thinking about. it allows us to consolidate multiple simple changes into a single version. But, I think you may have already had a conversation about this on a prior PR and come to a different conclusion, so I'm fine either way. If we don't want to nest the snap.seeded and --file docs under the same 24.1 header, maybe we at least order them order them in the same area of the document and push the datasource identification below.
diff --git a/doc/rtd/reference/breaking_changes.rst b/doc/rtd/reference/breaking_changes.rst
index 3432bb6fd..93c4ff371 100644
--- a/doc/rtd/reference/breaking_changes.rst
+++ b/doc/rtd/reference/breaking_changes.rst
@@ -11,8 +11,11 @@ releases.
many operating system vendors patch out breaking changes in
cloud-init to ensure consistent behavior on their platform.
-24.1 - Removal of ``--file`` top-level option
-=============================================
+24.1
+====
+
+Removal of ``--file`` top-level option
+--------------------------------------
The ``--file`` top-level option has been removed from cloud-init. It only
applied to a handful of subcommands so it did not make sense as a top-level
@@ -30,27 +33,8 @@ Instead, use:
cloud-init modules --file=userdata.yaml --mode config
-23.2-24.1 - Datasource identification
-=====================================
-
-**23.2**
- If the detected ``datasource_list`` contains a single datasource or
- that datasource plus ``None``, automatically use that datasource without
- checking to see if it is available. This allows for using datasources that
- don't have a way to be deterministically detected.
-**23.4**
- If the detected ``datasource_list`` contains a single datasource plus
- ``None``, no longer automatically use that datasource because ``None`` is
- a valid datasource that may be used if the primary datasource is
- not available.
-**24.1**
- ds-identify no longer automatically appends ``None`` to a
- datasource list with a single entry provided under ``/etc/cloud``.
- If ``None`` is desired as a fallback, it must be explicitly added to the
- customized datasource list.
-
-24.1 - removed Ubuntu's ordering dependency on snapd.seeded
-===========================================================
+Removed Ubuntu's ordering dependency on snapd.seeded
+----------------------------------------------------
In Ubuntu releases, cloud-init will no longer wait on ``snapd`` pre-seeding to
run. If a user-provided script relies on a snap, it must now be prefixed with
@@ -72,6 +56,25 @@ Will now need to be:
- [ snap, install, mc-installer ]
+23.2-24.1 - Datasource identification
+=====================================
+
+**23.2**
+ If the detected ``datasource_list`` contains a single datasource or
+ that datasource plus ``None``, automatically use that datasource without
+ checking to see if it is available. This allows for using datasources that
+ don't have a way to be deterministically detected.
+**23.4**
+ If the detected ``datasource_list`` contains a single datasource plus
+ ``None``, no longer automatically use that datasource because ``None`` is
+ a valid datasource that may be used if the primary datasource is
+ not available.
+**24.1**
+ ds-identify no longer automatically appends ``None`` to a
+ datasource list with a single entry provided under ``/etc/cloud``.
+ If ``None`` is desired as a fallback, it must be explicitly added to the
+ customized datasource list.
+
23.4 - added status code for recoverable error
==============================================
It may be worth moving the snapd.seeded section next to this section as well so all simple 24.1 related breaking changes are together? WE I realize the datasource identification changes are more complex and bridge multiple versions, but maybe it's best to keep the simple breaking changes for a single version together and allow the complex multi-version breaks to follow. With simple changes, they could all live under the same
Yep, I like your suggestion better. Applied. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Proposed Commit Message
Merge type