Output changelog checklists

Fixes: matrix-org#1682 Signed-off-by: Johannes Marbach <[email protected]>
Johennes · Aug 22, 2024 · 4250f33 · 4250f33
1 parent 215982a
commit 4250f33
Show file tree

Hide file tree

Showing 16 changed files with 70 additions and 3 deletions.
diff --git 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 → content/changelog/_index.md b/content/changelog/index.md → content/changelog/_index.md
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1 @@
+{{ .RawContent | replaceRE "\n- " "\n- [ ] " | replaceRE "<!--(.|\\s)*?-->\n?" "" }}
diff --git 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
@@ -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