Generate changelog release info with Hugo rather than when generating…

… changelog (#2033)
matrix-org · Dec 23, 2024 · 6f1e64c · 6f1e64c
1 parent baa60bf
commit 6f1e64c
Show file tree

Hide file tree

Showing 22 changed files with 127 additions and 246 deletions.
diff --git a/changelogs/header.md b/changelogs/header.md
diff --git a/changelogs/internal/newsfragments/2033.clarification b/changelogs/internal/newsfragments/2033.clarification
@@ -0,0 +1 @@
+Generate the changelog release info with Hugo, rather than the changelog generation script.
diff --git a/content/changelog/_index.md b/content/changelog/_index.md
@@ -4,4 +4,4 @@ type: docs
 weight: 1000
 ---
 
-{{% changelog/changelogs %}}
+<!-- This page will be redirected to the latest version's changelog -->
diff --git a/content/changelog/v1.1.md b/content/changelog/v1.1.md
@@ -2,26 +2,13 @@
 title: v1.1 Changelog
 linkTitle: v1.1
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2021-11-09T00:00:00+0000
+date: 2021-11-09
 ---
-<!--
-This is a header file for the generated changelog.
 
-Variables:
-    v1.1  = Replaced by the version number (eg: v1.2)
-    November 09, 2021     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-doc/tree/v1.1">https://github.com/matrix-org/matrix-doc/tree/v1.1</a></td>
-<tr><th>Release date</th><td>November 09, 2021</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.1" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 ## Client-Server API
 
 

diff --git a/content/changelog/v1.10.md b/content/changelog/v1.10.md
@@ -2,26 +2,12 @@
 title: v1.10 Changelog
 linkTitle: v1.10
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2024-03-22T09:59:45-06:00
+date: 2024-03-22
 ---
-<!--
-This is a header file for the generated changelog.
-
-Variables:
-    v1.10  = Replaced by the version number (eg: v1.2)
-    March 22, 2024     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.10">https://github.com/matrix-org/matrix-spec/tree/v1.10</a></td>
-<tr><th>Release date</th><td>March 22, 2024</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.10" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 
 ## Client-Server API
 

diff --git a/content/changelog/v1.11.md b/content/changelog/v1.11.md
@@ -2,26 +2,12 @@
 title: v1.11 Changelog
 linkTitle: v1.11
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2024-06-20T10:20:43-06:00
+date: 2024-06-20
 ---
-<!--
-This is a header file for the generated changelog.
-
-Variables:
-    v1.11  = Replaced by the version number (eg: v1.2)
-    June 20, 2024     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.11">https://github.com/matrix-org/matrix-spec/tree/v1.11</a></td>
-<tr><th>Release date</th><td>June 20, 2024</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.11" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 
 ## Client-Server API
 

diff --git a/content/changelog/v1.12.md b/content/changelog/v1.12.md
@@ -2,26 +2,12 @@
 title: v1.12 Changelog
 linkTitle: v1.12
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2024-10-07T13:32:03-06:00
+date: 2024-10-07
 ---
-<!--
-This is a header file for the generated changelog.
-
-Variables:
-    v1.12  = Replaced by the version number (eg: v1.2)
-    October 07, 2024     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.12">https://github.com/matrix-org/matrix-spec/tree/v1.12</a></td>
-<tr><th>Release date</th><td>October 07, 2024</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.12" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 
 ## Client-Server API
 

diff --git a/content/changelog/v1.13.md b/content/changelog/v1.13.md
@@ -2,26 +2,12 @@
 title: v1.13 Changelog
 linkTitle: v1.13
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2024-12-19T09:22:47-07:00
+date: 2024-12-19
 ---
-<!--
-This is a header file for the generated changelog.
-
-Variables:
-    v1.13  = Replaced by the version number (eg: v1.2)
-    December 19, 2024     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.13">https://github.com/matrix-org/matrix-spec/tree/v1.13</a></td>
-<tr><th>Release date</th><td>December 19, 2024</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.13" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 
 ## Client-Server API
 

diff --git a/content/changelog/v1.2.md b/content/changelog/v1.2.md
@@ -2,26 +2,13 @@
 title: v1.2 Changelog
 linkTitle: v1.2
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2022-02-02T00:00:00+0000
+date: 2022-02-02
 ---
-<!--
-This is a header file for the generated changelog.
 
-Variables:
-    v1.2  = Replaced by the version number (eg: v1.2)
-    February 02, 2022     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-doc/tree/v1.2">https://github.com/matrix-org/matrix-doc/tree/v1.2</a></td>
-<tr><th>Release date</th><td>February 02, 2022</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.2" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 ## Client-Server API
 
 

diff --git a/content/changelog/v1.3.md b/content/changelog/v1.3.md
@@ -2,26 +2,13 @@
 title: v1.3 Changelog
 linkTitle: v1.3
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2022-06-15T00:00:00+0100
+date: 2022-06-15
 ---
-<!--
-This is a header file for the generated changelog.
 
-Variables:
-    v1.3  = Replaced by the version number (eg: v1.2)
-    June 15, 2022     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.3">https://github.com/matrix-org/matrix-spec/tree/v1.3</a></td>
-<tr><th>Release date</th><td>June 15, 2022</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.3" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 ## Client-Server API
 
 

diff --git a/content/changelog/v1.4.md b/content/changelog/v1.4.md
@@ -2,26 +2,13 @@
 title: v1.4 Changelog
 linkTitle: v1.4
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2022-09-29T00:00:00+0100
+date: 2022-09-29
 ---
-<!--
-This is a header file for the generated changelog.
 
-Variables:
-    v1.4  = Replaced by the version number (eg: v1.2)
-    September 29, 2022     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.4">https://github.com/matrix-org/matrix-spec/tree/v1.4</a></td>
-<tr><th>Release date</th><td>September 29, 2022</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.4" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 ## Client-Server API
 
 

diff --git a/content/changelog/v1.5.md b/content/changelog/v1.5.md
@@ -2,26 +2,13 @@
 title: v1.5 Changelog
 linkTitle: v1.5
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2022-11-17T08:22:11-07:00
+date: 2022-11-17
 ---
-<!--
-This is a header file for the generated changelog.
 
-Variables:
-    v1.5  = Replaced by the version number (eg: v1.2)
-    November 17, 2022     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.5">https://github.com/matrix-org/matrix-spec/tree/v1.5</a></td>
-<tr><th>Release date</th><td>November 17, 2022</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.5" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 ## Client-Server API
 
 

diff --git a/content/changelog/v1.6.md b/content/changelog/v1.6.md
@@ -2,26 +2,13 @@
 title: v1.6 Changelog
 linkTitle: v1.6
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2023-02-14T08:25:40-07:00
+date: 2023-02-14
 ---
-<!--
-This is a header file for the generated changelog.
 
-Variables:
-    v1.6  = Replaced by the version number (eg: v1.2)
-    February 14, 2023     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.6">https://github.com/matrix-org/matrix-spec/tree/v1.6</a></td>
-<tr><th>Release date</th><td>February 14, 2023</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.6" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 ## Client-Server API
 
 

diff --git a/content/changelog/v1.7.md b/content/changelog/v1.7.md
@@ -2,26 +2,13 @@
 title: v1.7 Changelog
 linkTitle: v1.7
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2023-05-25T09:47:21-06:00
+date: 2023-05-25
 ---
-<!--
-This is a header file for the generated changelog.
 
-Variables:
-    v1.7  = Replaced by the version number (eg: v1.2)
-    May 25, 2023     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.7">https://github.com/matrix-org/matrix-spec/tree/v1.7</a></td>
-<tr><th>Release date</th><td>May 25, 2023</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.7" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 ## Client-Server API
 
 

diff --git a/content/changelog/v1.8.md b/content/changelog/v1.8.md
@@ -2,26 +2,12 @@
 title: v1.8 Changelog
 linkTitle: v1.8
 type: docs
+layout: changelog
 outputs:
   - html
   - checklist
-date: 2023-08-23T09:23:53-06:00
+date: 2023-08-23
 ---
-<!--
-This is a header file for the generated changelog.
-
-Variables:
-    v1.8  = Replaced by the version number (eg: v1.2)
-    August 23, 2023     = Replaced by the date (eg: April 01, 2021)
--->
-
-<table class="release-info">
-<tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.8">https://github.com/matrix-org/matrix-spec/tree/v1.8</a></td>
-<tr><th>Release date</th><td>August 23, 2023</td>
-<tr><th>Checklist</th><td><a href="{{< relref path="changelog/v1.8" outputFormat="Checklist" >}}">checklist.md</a></td>
-</table>
-
-<!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
 
 ## Client-Server API
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Generate the changelog release info with Hugo, rather than the changelog generation script.