From 4250f3364545776b3dc582a619a64a5e449054fb Mon Sep 17 00:00:00 2001
From: Johannes Marbach <n0-0ne+github@mailbox.org>
Date: Thu, 22 Aug 2024 09:45:35 +0200
Subject: [PATCH] Output changelog checklists

Fixes: #1682
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
---
 config.toml                                  | 8 ++++++++
 content/changelog/{index.md => _index.md}    | 0
 content/changelog/v1.1.md                    | 5 +++++
 content/changelog/v1.10.md                   | 5 +++++
 content/changelog/v1.11.md                   | 5 +++++
 content/changelog/v1.2.md                    | 5 +++++
 content/changelog/v1.3.md                    | 5 +++++
 content/changelog/v1.4.md                    | 5 +++++
 content/changelog/v1.5.md                    | 5 +++++
 content/changelog/v1.6.md                    | 5 +++++
 content/changelog/v1.7.md                    | 5 +++++
 content/changelog/v1.8.md                    | 5 +++++
 content/changelog/v1.9.md                    | 5 +++++
 layouts/_default/single.checklist.md         | 1 +
 layouts/shortcodes/changelog/changelogs.html | 4 +---
 scripts/generate-changelog.sh                | 5 +++++
 16 files changed, 70 insertions(+), 3 deletions(-)
 rename content/changelog/{index.md => _index.md} (100%)
 create mode 100644 layouts/_default/single.checklist.md

diff --git a/config.toml b/config.toml
index 6b669a798..b9a66cb81 100644
--- a/config.toml
+++ b/config.toml
@@ -138,3 +138,11 @@ sidebar_menu_compact = true
   [[module.imports]]
     path = "github.com/matrix-org/docsy"
     disable = false
+
+# custom output formats
+
+[outputFormats]
+  [outputFormats.Checklist]
+    mediaType = "text/markdown"
+    isPlainText = true
+    baseName = "checklist"
diff --git a/content/changelog/index.md b/content/changelog/_index.md
similarity index 100%
rename from content/changelog/index.md
rename to content/changelog/_index.md
diff --git a/content/changelog/v1.1.md b/content/changelog/v1.1.md
index 8cf438784..b838e2106 100644
--- a/content/changelog/v1.1.md
+++ b/content/changelog/v1.1.md
@@ -1,4 +1,9 @@
 ---
+title: v1.1
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2021-11-09T00:00:00+0000
 ---
 <!--
diff --git a/content/changelog/v1.10.md b/content/changelog/v1.10.md
index 16b3217da..d3b358e0a 100644
--- a/content/changelog/v1.10.md
+++ b/content/changelog/v1.10.md
@@ -1,4 +1,9 @@
 ---
+title: v1.10
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2024-03-22T09:59:45-06:00
 ---
 <!--
diff --git a/content/changelog/v1.11.md b/content/changelog/v1.11.md
index f3a60b550..f8ce5a8de 100644
--- a/content/changelog/v1.11.md
+++ b/content/changelog/v1.11.md
@@ -1,4 +1,9 @@
 ---
+title: v1.11
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2024-06-20T10:20:43-06:00
 ---
 <!--
diff --git a/content/changelog/v1.2.md b/content/changelog/v1.2.md
index 22deb1ac7..6e0de189d 100644
--- a/content/changelog/v1.2.md
+++ b/content/changelog/v1.2.md
@@ -1,4 +1,9 @@
 ---
+title: v1.2
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2022-02-02T00:00:00+0000
 ---
 <!--
diff --git a/content/changelog/v1.3.md b/content/changelog/v1.3.md
index bc05b1cc3..7510c1bb1 100644
--- a/content/changelog/v1.3.md
+++ b/content/changelog/v1.3.md
@@ -1,4 +1,9 @@
 ---
+title: v1.3
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2022-06-15T00:00:00+0100
 ---
 <!--
diff --git a/content/changelog/v1.4.md b/content/changelog/v1.4.md
index 7d22c00ed..297b01ce9 100644
--- a/content/changelog/v1.4.md
+++ b/content/changelog/v1.4.md
@@ -1,4 +1,9 @@
 ---
+title: v1.4
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2022-09-29T00:00:00+0100
 ---
 <!--
diff --git a/content/changelog/v1.5.md b/content/changelog/v1.5.md
index 258aabfa8..1614916b3 100644
--- a/content/changelog/v1.5.md
+++ b/content/changelog/v1.5.md
@@ -1,4 +1,9 @@
 ---
+title: v1.5
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2022-11-17T08:22:11-07:00
 ---
 <!--
diff --git a/content/changelog/v1.6.md b/content/changelog/v1.6.md
index 07574ff36..71bba682e 100644
--- a/content/changelog/v1.6.md
+++ b/content/changelog/v1.6.md
@@ -1,4 +1,9 @@
 ---
+title: v1.6
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2023-02-14T08:25:40-07:00
 ---
 <!--
diff --git a/content/changelog/v1.7.md b/content/changelog/v1.7.md
index 61ade090b..97e72ea4c 100644
--- a/content/changelog/v1.7.md
+++ b/content/changelog/v1.7.md
@@ -1,4 +1,9 @@
 ---
+title: v1.7
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2023-05-25T09:47:21-06:00
 ---
 <!--
diff --git a/content/changelog/v1.8.md b/content/changelog/v1.8.md
index 0d25f6a2f..5a6be8f91 100644
--- a/content/changelog/v1.8.md
+++ b/content/changelog/v1.8.md
@@ -1,4 +1,9 @@
 ---
+title: v1.8
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2023-08-23T09:23:53-06:00
 ---
 <!--
diff --git a/content/changelog/v1.9.md b/content/changelog/v1.9.md
index 46a79f379..810d281aa 100644
--- a/content/changelog/v1.9.md
+++ b/content/changelog/v1.9.md
@@ -1,4 +1,9 @@
 ---
+title: v1.9
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2023-11-29T10:04:26-07:00
 ---
 <!--
diff --git a/layouts/_default/single.checklist.md b/layouts/_default/single.checklist.md
new file mode 100644
index 000000000..1db24df3e
--- /dev/null
+++ b/layouts/_default/single.checklist.md
@@ -0,0 +1 @@
+{{ .RawContent | replaceRE "\n- " "\n- [ ] " | replaceRE "<!--(.|\\s)*?-->\n?" "" }}
diff --git a/layouts/shortcodes/changelog/changelogs.html b/layouts/shortcodes/changelog/changelogs.html
index f42963da4..f040cea8b 100644
--- a/layouts/shortcodes/changelog/changelogs.html
+++ b/layouts/shortcodes/changelog/changelogs.html
@@ -3,8 +3,6 @@
    "content/changelogs"
 */}}
 
-{{ with .Page.Resources.Match "*.md" }}
-{{ range ((sort . "Params.date" "desc")) }}
+{{ range .Page.RegularPages }}
 {{ .RenderShortcodes }}
 {{ end }}
-{{ end }}
diff --git a/scripts/generate-changelog.sh b/scripts/generate-changelog.sh
index 45132619e..bad6f73e7 100755
--- a/scripts/generate-changelog.sh
+++ b/scripts/generate-changelog.sh
@@ -22,6 +22,11 @@ towncrier --yes
     # to sort the changelogs at build time.
     cat <<EOF
 ---
+title: $VERSION
+type: docs
+outputs:
+  - html
+  - checklist
 date: $(date -Iseconds)
 ---
 EOF