From bb29df51063931b819e9d3c5fa888fc8058b8a6d Mon Sep 17 00:00:00 2001
From: Morten Piibeleht <morten.piibeleht@juliahub.com>
Date: Thu, 27 Jun 2024 22:41:14 +1200
Subject: [PATCH] docs: include release notes in the manual

---
 .gitignore        |  1 +
 CHANGELOG.md      | 28 ++++++++++++++++++++++++++++
 Makefile          |  7 +++++--
 docs/Project.toml |  2 ++
 docs/changelog.jl |  7 +++++++
 docs/make.jl      | 13 ++++++++++++-
 6 files changed, 55 insertions(+), 3 deletions(-)
 create mode 100644 docs/changelog.jl

diff --git a/.gitignore b/.gitignore
index 43689a17a..de5624e54 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
 /Manifest.toml
+/docs/src/release-notes.md
 /docs/build/
 /docs/Manifest.toml
 /test/testdata/large.dat
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 812a99fc2..9428e4e09 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -94,3 +94,31 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 ## Version v0.1.0 - 2023-06-20
 
 Initial package release.
+
+
+<!-- Links generated by Changelog.jl -->
+
+[#1]: https://github.com/JuliaComputing/JuliaHub.jl/issues/1
+[#2]: https://github.com/JuliaComputing/JuliaHub.jl/issues/2
+[#3]: https://github.com/JuliaComputing/JuliaHub.jl/issues/3
+[#7]: https://github.com/JuliaComputing/JuliaHub.jl/issues/7
+[#9]: https://github.com/JuliaComputing/JuliaHub.jl/issues/9
+[#11]: https://github.com/JuliaComputing/JuliaHub.jl/issues/11
+[#12]: https://github.com/JuliaComputing/JuliaHub.jl/issues/12
+[#13]: https://github.com/JuliaComputing/JuliaHub.jl/issues/13
+[#14]: https://github.com/JuliaComputing/JuliaHub.jl/issues/14
+[#18]: https://github.com/JuliaComputing/JuliaHub.jl/issues/18
+[#28]: https://github.com/JuliaComputing/JuliaHub.jl/issues/28
+[#31]: https://github.com/JuliaComputing/JuliaHub.jl/issues/31
+[#32]: https://github.com/JuliaComputing/JuliaHub.jl/issues/32
+[#33]: https://github.com/JuliaComputing/JuliaHub.jl/issues/33
+[#34]: https://github.com/JuliaComputing/JuliaHub.jl/issues/34
+[#35]: https://github.com/JuliaComputing/JuliaHub.jl/issues/35
+[#37]: https://github.com/JuliaComputing/JuliaHub.jl/issues/37
+[#44]: https://github.com/JuliaComputing/JuliaHub.jl/issues/44
+[#46]: https://github.com/JuliaComputing/JuliaHub.jl/issues/46
+[#48]: https://github.com/JuliaComputing/JuliaHub.jl/issues/48
+[#49]: https://github.com/JuliaComputing/JuliaHub.jl/issues/49
+[#52]: https://github.com/JuliaComputing/JuliaHub.jl/issues/52
+[#53]: https://github.com/JuliaComputing/JuliaHub.jl/issues/53
+[#58]: https://github.com/JuliaComputing/JuliaHub.jl/issues/58
diff --git a/Makefile b/Makefile
index 562977536..95c287b54 100644
--- a/Makefile
+++ b/Makefile
@@ -8,14 +8,17 @@ help:
 
 docs/Manifest.toml: docs/Project.toml
 	@echo "Instantiating the docs/ environment:"
-	$(JULIA) --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate()'
+	${JULIA} --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate()'
 
 docs-manifest:
 	rm -f docs/Manifest.toml
 	$(MAKE) docs/Manifest.toml
 
 docs: docs/Manifest.toml
-	$(JULIA) --project=docs/ docs/make.jl
+	${JULIA} --project=docs/ docs/make.jl
+
+changelog:
+	${JULIA} --project=docs/ docs/changelog.jl
 
 test:
 	${JULIA} --project -e 'using Pkg; Pkg.test()'
diff --git a/docs/Project.toml b/docs/Project.toml
index 86f2b74a6..40ea80183 100644
--- a/docs/Project.toml
+++ b/docs/Project.toml
@@ -1,4 +1,5 @@
 [deps]
+Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterMermaid = "a078cd44-4d9c-4618-b545-3ab9d77f9177"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
@@ -8,5 +9,6 @@ TimeZones = "f269a46b-ccf7-5d73-abea-4c690281aa53"
 URIs = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
 
 [compat]
+Changelog = "1"
 Documenter = "1"
 DocumenterMermaid = "0.1"
diff --git a/docs/changelog.jl b/docs/changelog.jl
new file mode 100644
index 000000000..a08d0b855
--- /dev/null
+++ b/docs/changelog.jl
@@ -0,0 +1,7 @@
+using Changelog
+
+Changelog.generate(
+    Changelog.CommonMark(),
+    joinpath(@__DIR__, "..", "CHANGELOG.md");
+    repo="JuliaComputing/JuliaHub.jl",
+)
diff --git a/docs/make.jl b/docs/make.jl
index 91d2f2d09..bba0b043f 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -1,5 +1,7 @@
 using JuliaHub
-using Documenter, DocumenterMermaid
+using Documenter
+using DocumenterMermaid
+using Changelog
 import TimeZones
 
 # Timestamp printing is dependent on the timezone, so we force a specific (non-UTC)
@@ -43,6 +45,14 @@ function setup_job_results_file!()
     )
 end
 
+# Generate a Documenter-friendly changelog from CHANGELOG.md
+Changelog.generate(
+    Changelog.Documenter(),
+    joinpath(@__DIR__, "..", "CHANGELOG.md"),
+    joinpath(@__DIR__, "src", "release-notes.md");
+    repo="JuliaComputing/JuliaHub.jl",
+)
+
 # These lists are reused in the makedocs, but also in the at-contents
 # blocks on the src/index.md page.
 const PAGES_GUIDES = [
@@ -72,6 +82,7 @@ Mocking.apply(mocking_patch) do
             "Guides" => PAGES_GUIDES,
             "Reference" => PAGES_REFERENCE,
             Documenter.hide("internal.md"),
+            "release-notes.md",
         ],
         doctest=if in("--fix-doctests", ARGS)
             :fix