Use Changelog.jl for changelog maintenance (#277)

.gitignore

@@ -4,4 +4,5 @@
 .DS_Store
 /docs/build/
 /docs/site/
+/docs/src/release-notes.md
 Manifest.toml

Makefile

@@ -1,6 +1,17 @@
-all: generate_badge generate_favicon
+JULIA:=julia
 
-.PHONY: all generate_badge generate_favicon
+default: help
+
+.PHONY: default changelog docs docs-instantiate generate_badge generate_favicon help test
+
+docs-instantiate:
+	${JULIA} docs/instantiate.jl
+
+changelog: docs-instantiate
+	${JULIA} --project=docs docs/changelog.jl
+
+docs: docs-instantiate
+	${JULIA} --project=docs docs/make.jl
 
 generate_badge:
 	SVG_BASE64=$(shell base64 -w 0 docs/src/assets/logo.svg); \
@@ -10,3 +21,14 @@ generate_favicon:
 	convert -background none docs/src/assets/logo.svg -resize 256x256 -gravity center -extent 256x256 logo.png
 	convert logo.png -define icon:auto-resize=256,64,48,32,16 docs/src/assets/favicon.ico
 	rm logo.png
+
+test:
+	${JULIA} --project -e 'using Pkg; Pkg.test()'
+
+help:
+	@echo "The following make commands are available:"
+	@echo " - make changelog: update all links in CHANGELOG.md's footer"
+	@echo " - make docs: build the documentation"
+	@echo " - make generate_badge: generate the Aqua.jl badge"
+	@echo " - make generate_favicon: generate the Aqua.jl favicon"
+	@echo " - make test: run the tests"

docs/Project.toml

@@ -1,5 +1,7 @@
 [deps]
+Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 
 [compat]
+Changelog = "1"
 Documenter = "1"

docs/changelog.jl

@@ -0,0 +1,7 @@
+using Changelog
+
+Changelog.generate(
+    Changelog.CommonMark(),
+    joinpath(@__DIR__, "..", "CHANGELOG.md");
+    repo = "JuliaTesting/Aqua.jl",
+)

docs/instantiate.jl

@@ -0,0 +1,17 @@
+# This script can be used to quickly instantiate the docs/Project.toml environment.
+using Pkg, TOML
+
+package_directory = joinpath(@__DIR__, "..")
+docs_directory = isempty(ARGS) ? @__DIR__() : joinpath(pwd(), ARGS[1])
+cd(docs_directory) do
+    Pkg.activate(docs_directory)
+    Pkg.develop(PackageSpec(path = package_directory))
+    Pkg.instantiate()
+
+    # Remove Aqua again from docs/Project.toml
+    project_toml = TOML.parsefile(joinpath(docs_directory, "Project.toml"))
+    delete!(project_toml["deps"], "Aqua")
+    open(joinpath(docs_directory, "Project.toml"), "w") do io
+        TOML.print(io, project_toml)
+    end
+end

docs/make.jl

@@ -1,6 +1,21 @@
-using Documenter, Aqua
+using Documenter, Aqua, Changelog
+
+# Generate a Documenter-friendly changelog from CHANGELOG.md
+Changelog.generate(
+    Changelog.Documenter(),
+    joinpath(@__DIR__, "..", "CHANGELOG.md"),
+    joinpath(@__DIR__, "src", "release-notes.md");
+    repo = "JuliaTesting/Aqua.jl",
+)
 
 makedocs(;
+    sitename = "Aqua.jl",
+    format = Documenter.HTML(;
+        repolink = "https://github.com/JuliaTesting/Aqua.jl",
+        assets = ["assets/favicon.ico"],
+        size_threshold_ignore = ["release-notes.md"],
+    ),
+    authors = "Takafumi Arakaki",
     modules = [Aqua],
     pages = [
         "Home" => "index.md",
@@ -15,13 +30,8 @@ makedocs(;
             "piracies.md",
             "persistent_tasks.md",
         ],
+        "release-notes.md",
     ],
-    sitename = "Aqua.jl",
-    format = Documenter.HTML(;
-        repolink = "https://github.com/JuliaTesting/Aqua.jl",
-        assets = ["assets/favicon.ico"],
-    ),
-    authors = "Takafumi Arakaki",
 )
 
 deploydocs(; repo = "github.com/JuliaTesting/Aqua.jl", push_preview = true)