Bump the version to 0.18.0 and add a changelog

.gitignore

@@ -8,4 +8,5 @@
 Manifest.toml
 /test/Lib*.jl
 /test/build
-/test/products
+/test/products
+docs/src/_generated_changelog.md

Project.toml

@@ -1,6 +1,6 @@
 name = "Clang"
 uuid = "40e3b903-d033-50b4-a0cc-940c62c95e31"
-version = "0.17.8"
+version = "0.18.0"
 
 [deps]
 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82"

docs/Project.toml

@@ -1,3 +1,4 @@
 [deps]
+Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
 Clang = "40e3b903-d033-50b4-a0cc-940c62c95e31"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

@@ -1,6 +1,15 @@
 using Clang
 using Clang.LibClang
 using Documenter
+import Changelog
+
+
+Changelog.generate(
+    Changelog.Documenter(),
+    joinpath(@__DIR__, "src/changelog.md"),
+    joinpath(@__DIR__, "src/_generated_changelog.md"),
+    repo="JuliaInterop/Clang.jl"
+)
 
 makedocs(;
     modules=[Clang, Clang.LibClang],
@@ -18,6 +27,7 @@ makedocs(;
         "LibClang Tutorial" => "tutorial.md",
         "LibClang Wrapper API Reference" => "libclang.md",
         "Clang API Reference" => "api.md",
+        "Changelog" => "_generated_changelog.md"
     ],
     warnonly=:missing_docs
 )

docs/src/changelog.md

@@ -0,0 +1,18 @@
+# Changelog
+
+This documents notable changes in Clang.jl. The format is based on [Keep a
+Changelog](https://keepachangelog.com).
+
+## [v0.18.0] - 2024-01-05
+
+### Added
+
+- Doxygens `@deprecated` command will now be translated to a `!!! compat`
+  admonition ([#460]).
+
+### Breaking
+
+- The `callback_documentation` callback will be called whenever it is set, and
+  any docstring parsed from the headers will be passed to it ([#458],
+  [#462]). The signature of the callback changed from `f(node::ExprNode)` to
+  `f(node::ExprNode, doc::Vector{String})`.