Add changelog to mdBook

This commit is contained in:
Nick Groenen 2020-12-22 14:28:38 +01:00
parent 6d03d4b2ca
commit 147c2a4bd5
No known key found for this signature in database
GPG Key ID: 4F0AD019928AE098
5 changed files with 62 additions and 3 deletions

View File

@ -5,7 +5,8 @@
- [ ] Commit changes to `Cargo.*` with the message format `Release vN.N.N` - [ ] Commit changes to `Cargo.*` with the message format `Release vN.N.N`
- [ ] Make git tag `vN.N.N` - [ ] Make git tag `vN.N.N`
- [ ] Run `gitchangelog` - [ ] 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` - [ ] Force update git tag `vN.N.N`
- [ ] Push changes & tag - [ ] Push changes & tag
- [ ] Wait for builds to turn green (<https://github.com/zoni/obsidian-export/actions>) - [ ] Wait for builds to turn green (<https://github.com/zoni/obsidian-export/actions>)

49
book/book-src/CHANGES.md Normal file
View File

@ -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]

View File

@ -3,4 +3,8 @@
* [Introduction](index.md) * [Introduction](index.md)
* [Installation](installation.md) * [Installation](installation.md)
* [Usage](usage.md) * [Usage](usage.md)
* [License](license.md)
---
[Changelog](CHANGES.md)
[License](license.md)

View File

@ -0,0 +1 @@
../../CHANGES.md

View File

@ -3,4 +3,8 @@
- [[index|Introduction]] - [[index|Introduction]]
- [[Installation]] - [[Installation]]
- [[Usage]] - [[Usage]]
- [[License]]
---
[[CHANGES|Changelog]]
[[License]]