doc/releases: Add ordering comment to releases.yml

anthonyeleven · anthonyeleven · commit 2290a904bd6a · 2025-03-08T10:58:37.000-05:00
Signed-off-by: Anthony D'Atri &lt;anthonyeleven@users.noreply.github.com&gt;
diff --git a/doc/releases/releases.yml b/doc/releases/releases.yml
@@ -1,5 +1,5 @@
 #
-# there are two sections
+# There are two sections
 #
 # releases: ... for named releases
 # development: ... for dev releases
@@ -11,6 +11,10 @@
 #
 # If a version might represent an actual number (e.g. 0.80) quote it.
 #
+# Note that in order for the Gantt chart to properly reflect the latest version
+#      of a major release, the versions within a `releases` list MUST be
+#      in descending order.
+
 releases:
   squid:
     target_eol: 2026-09-19

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`#`
`2`		`-# there are two sections`
	`2`	`+# There are two sections`
`3`	`3`	`#`
`4`	`4`	`# releases: ... for named releases`
`5`	`5`	`# development: ... for dev releases`
`@@ -11,6 +11,10 @@`
`11`	`11`	`#`
`12`	`12`	`# If a version might represent an actual number (e.g. 0.80) quote it.`
`13`	`13`	`#`
	`14`	`+# Note that in order for the Gantt chart to properly reflect the latest version`
	`15`	+# of a major release, the versions within a `releases` list MUST be
	`16`	`+# in descending order.`
	`17`	`+`
`14`	`18`	`releases:`
`15`	`19`	`squid:`
`16`	`20`	`target_eol: 2026-09-19`