Add changelog (#109)

* add changelog

* add changelog to docs

* ignore NEWS.md for CI

* Update docs/make.jl

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* fill changelog

* rename to CHANGELOG.md

* cleanup

* fix typo

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: JoshuaLampert

.github/workflows/CI.yml

@@ -7,6 +7,7 @@ on:
     paths-ignore:
       - 'CITATION.bib'
       - 'LICENSE.md'
+      - 'CHANGELOG.md'
       - 'README.md'
       - '.zenodo.json'
       - '.github/workflows/CompatHelper.yml'
@@ -19,6 +20,7 @@ on:
     paths-ignore:
       - 'CITATION.bib'
       - 'LICENSE.md'
+      - 'CHANGELOG.md'
       - 'README.md'
       - '.zenodo.json'
       - '.github/workflows/CompatHelper.yml'

.github/workflows/Downgrade.yml

@@ -6,6 +6,7 @@ on:
       - 'AUTHORS.md'
       - 'CITATION.bib'
       - 'LICENSE.md'
+      - 'CHANGELOG.md'
       - 'README.md'
       - '.zenodo.json'
       - '.github/workflows/CompatHelper.yml'

CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+KernelInterpolation.jl follows the interpretation of
+[semantic versioning (semver)](https://julialang.github.io/Pkg.jl/dev/compatibility/#Version-specifier-format-1)
+used in the Julia ecosystem. Notable changes will be documented in this file
+for human readability.
+
+## Changes in the v0.2 lifecycle
+
+#### Added
+
+- Added support for general RNG in `random_*` functions ([#106]).
+- Added `LagrangeBasis` ([#103]).
+
+#### Changed
+
+- Use OrdinaryDiffEqRosenbrock.jl instead of OrdinaryDiffEq.jl in the examples and documentation ([#108]).
+- Fix seriestype for 1D plots ([#101]).
+
+## Changes when updating to v0.2 from v0.1.x
+
+#### Added
+
+- Added tutorial on noisy data ([#95]).
+- Added L2 regularization ([#94]).
+- Added least squares approximation ([#93], [#97]).
+
+#### Changed
+
+- Add interface for general bases and add `StandardBasis`. This is breaking for least squares approximations because
+  the order of `centers` and `nodeset` needs to be swapped in the `interpolate` function. Alternatively, use the new
+  `StandardBasis` ([#100]).
+
+## Changes in the v0.1 lifecycle
+
+#### Added
+
+- Added tutorial to documentation ([#66]).
+- Added `PartialDerivativeOperator` ([#65]).
+- Added compactly supported Wu kernels ([#64]).
+- Added compatibility for `PointSet`s  from Meshes.jl ([#63]).

docs/Project.toml

@@ -1,5 +1,6 @@
 [deps]
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Meshes = "eacbb407-ea5a-433e-ab97-5258b1ca43fa"
@@ -8,6 +9,7 @@ QuasiMonteCarlo = "8a4e6c94-4038-4cdc-81c3-7e6ffdb2a71b"
 
 [compat]
 CairoMakie = "0.12"
+Changelog = "1"
 Documenter = "1"
 LinearAlgebra = "1"
 Meshes = "0.52.1"

docs/make.jl

@@ -1,10 +1,18 @@
 using KernelInterpolation
 using Documenter
+import Changelog
 
 # Define module-wide setups such that the respective modules are available in doctests
 DocMeta.setdocmeta!(KernelInterpolation, :DocTestSetup, :(using KernelInterpolation);
                     recursive = true)
 
+# Create changelog
+Changelog.generate(Changelog.Documenter(),                        # output type
+                   joinpath(@__DIR__, "..", "CHANGELOG.md"),      # input file
+                   joinpath(@__DIR__, "src", "changelog.md");     # output file
+                   repo = "JoshuaLampert/KernelInterpolation.jl", # default repository for links
+                   branch = "main",)
+
 makedocs(;
          modules = [KernelInterpolation],
          authors = "Joshua Lampert <[email protected]> and contributors",
@@ -26,6 +34,7 @@ makedocs(;
                  "Dealing with noisy data" => "tutorial_noisy_data.md"],
              "Development" => "development.md",
              "Reference" => "ref.md",
+             "Changelog" => "changelog.md",
              "License" => "license.md"])
 
 deploydocs(;