From 147c2a4bd5ca24f6cec2d18012fcc70d09a5c2e0 Mon Sep 17 00:00:00 2001
From: Nick Groenen <nick@groenen.me>
Date: Tue, 22 Dec 2020 14:28:38 +0100
Subject: [PATCH] Add changelog to mdBook

---
 Release-checklist.md         |  3 ++-
 book/book-src/CHANGES.md     | 49 ++++++++++++++++++++++++++++++++++++
 book/book-src/SUMMARY.md     |  6 ++++-
 book/obsidian-src/CHANGES.md |  1 +
 book/obsidian-src/SUMMARY.md |  6 ++++-
 5 files changed, 62 insertions(+), 3 deletions(-)
 create mode 100644 book/book-src/CHANGES.md
 create mode 120000 book/obsidian-src/CHANGES.md

diff --git a/Release-checklist.md b/Release-checklist.md
index f5aa265..d633402 100644
--- a/Release-checklist.md
+++ b/Release-checklist.md
@@ -5,7 +5,8 @@
 - [ ] Commit changes to `Cargo.*` with the message format `Release vN.N.N`
 - [ ] Make git tag `vN.N.N`
 - [ ] Run `gitchangelog`
-- [ ] Stage `CHANGES.md` and amend previous commit
+- [ ] Regenerate mdBook sources: `book/generate.sh`
+- [ ] Stage `CHANGES.md` and `book/` and amend previous commit
 - [ ] Force update git tag `vN.N.N`
 - [ ] Push changes & tag
 - [ ] Wait for builds to turn green (<https://github.com/zoni/obsidian-export/actions>)
diff --git a/book/book-src/CHANGES.md b/book/book-src/CHANGES.md
new file mode 100644
index 0000000..780518d
--- /dev/null
+++ b/book/book-src/CHANGES.md
@@ -0,0 +1,49 @@
+# Changelog
+
+## v0.3.0 (2020-12-21)
+
+### New
+
+* Report file tree when RecursionLimitExceeded is hit. \[Nick Groenen]
+  
+  This refactors the Context to maintain a list of all the files which
+  have been processed so far in a chain of embeds. This information is
+  then used to print a more helpful error message to users of the CLI when
+  RecursionLimitExceeded is returned.
+
+### Changes
+
+* Add extra whitespace around multi-line warnings. \[Nick Groenen]
+  
+  This makes errors a bit easier to distinguish after a number of warnings
+  has been printed.
+
+### Other
+
+* Setup gitchangelog. \[Nick Groenen]
+  
+  This adds a changelog (CHANGES.md) which is automatically generated with
+  [gitchangelog](https://github.com/vaab/gitchangelog).
+
+## v0.2.0 (2020-12-13)
+
+* Allow custom filter function to be passed with WalkOptions. \[Nick Groenen]
+
+* Re-export vault_contents and WalkOptions as pub from crate root. \[Nick Groenen]
+
+* Run mdbook hook against README.md too. \[Nick Groenen]
+
+* Update installation instructions. \[Nick Groenen]
+  
+  Installation no longer requires a git repository URL now that a crate is
+  published.
+
+* Add MdBook generation script and precommit hook. \[Nick Groenen]
+
+* Add more reliable non-ASCII tetscase. \[Nick Groenen]
+
+* Create FUNDING.yml. \[Nick Groenen]
+
+## v0.1.0 (2020-11-28)
+
+* Public release. \[Nick Groenen]
diff --git a/book/book-src/SUMMARY.md b/book/book-src/SUMMARY.md
index 6368ef3..184d75d 100644
--- a/book/book-src/SUMMARY.md
+++ b/book/book-src/SUMMARY.md
@@ -3,4 +3,8 @@
 * [Introduction](index.md)
 * [Installation](installation.md)
 * [Usage](usage.md)
-* [License](license.md)
+
+---
+
+[Changelog](CHANGES.md)
+[License](license.md)
diff --git a/book/obsidian-src/CHANGES.md b/book/obsidian-src/CHANGES.md
new file mode 120000
index 0000000..8980b4a
--- /dev/null
+++ b/book/obsidian-src/CHANGES.md
@@ -0,0 +1 @@
+../../CHANGES.md
\ No newline at end of file
diff --git a/book/obsidian-src/SUMMARY.md b/book/obsidian-src/SUMMARY.md
index 11fab07..0af3125 100644
--- a/book/obsidian-src/SUMMARY.md
+++ b/book/obsidian-src/SUMMARY.md
@@ -3,4 +3,8 @@
 - [[index|Introduction]]
 - [[Installation]]
 - [[Usage]]
-- [[License]]
+
+---
+
+[[CHANGES|Changelog]]
+[[License]]