From 2cad13f27b3d6935faa4bc5ed55085ac9cf2dd4d Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Sun, 12 Nov 2017 14:12:57 +0100 Subject: [PATCH] docs: add changelog --- docs/changelog.rst | 43 +++++++++++++++++++++++++++++++++++++++++++ docs/conf.py | 3 ++- docs/index.rst | 1 + 3 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 docs/changelog.rst diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..cab9c55 --- /dev/null +++ b/docs/changelog.rst @@ -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 diff --git a/docs/conf.py b/docs/conf.py index 2ed64c0..c7242a7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -163,6 +163,7 @@ texinfo_documents = [ # http://www.sphinx-doc.org/en/stable/ext/extlinks.html extlinks = { '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 '), } diff --git a/docs/index.rst b/docs/index.rst index 7236e48..c9bbc06 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -83,4 +83,5 @@ Table of Contents installation configuration implementation + changelog pr