docs: add changelog

This commit is contained in:
Christian Schwarz 2017-11-12 14:12:57 +01:00
parent b5475921a8
commit 2cad13f27b
3 changed files with 46 additions and 1 deletions

43
docs/changelog.rst Normal file
View File

@ -0,0 +1,43 @@
.. |break_config| replace:: **[BREAK]**
.. |bugfix| replace:: [BUG]
Changelog
=========
The changelog summarized bugfixes that are deemed relevant for users.
Developers should consult the git commit log or GitHub issue tracker.
0.0.2
-----
Breaking
~~~~~~~~
* |break_config| :commit:`b95260f`: ``global.logging`` is no longer a dictionary but a list
* |break_config| :commit:`3e647c1`: ``source`` job field ``datasets`` renamed to ``filesystems``
* **NOTE**: zrepl will parse missing ``filesystems`` field as an empty filter,
i.e. no filesystems are presented to the other side.
* |bugfix| :commit:`72d2885` fix aliasing bug with root `<` subtree wildcard
* Filesystems paths with final match at blank `s` subtree wildcard are now appended to the target path
* Non-root subtree wildcards, e.g. `zroot/foo/bar<` still map directrly onto the target path
* Support days (``d``) and weeks (``w``) in durations
* Docs
* Ditch Hugo, move to Python Sphinx
* Improve & simplify tutorial (single SSH key per installation)
* Document pruning policies
* Document job types
* Document logging
* Start updating implementation overview
0.0.1
-----
* Initial release

View File

@ -163,6 +163,7 @@ texinfo_documents = [
# http://www.sphinx-doc.org/en/stable/ext/extlinks.html # http://www.sphinx-doc.org/en/stable/ext/extlinks.html
extlinks = { extlinks = {
'issue':('https://github.com/zrepl/zrepl/issues/%s', 'issue #'), 'issue':('https://github.com/zrepl/zrepl/issues/%s', 'issue #'),
'sampleconf':('https://github.com/zrepl/zrepl/blob/master/cmd/sampleconf/%s', 'cmd/sampleconf') 'sampleconf':('https://github.com/zrepl/zrepl/blob/master/cmd/sampleconf/%s', 'cmd/sampleconf'),
'commit':('https://github.com/zrepl/zrepl/commit/%s', 'commit '),
} }

View File

@ -83,4 +83,5 @@ Table of Contents
installation installation
configuration configuration
implementation implementation
changelog
pr pr