From 255d2cdecdb3863ce7816dd75a137437e9f579d9 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Thu, 26 May 2016 08:16:44 -0500 Subject: [PATCH] switch changelog to releases module format --- CHANGES | 146 +++++++++++-------------------------------- doc/conf.py | 7 +++ requirements/doc.txt | 1 + 3 files changed, 44 insertions(+), 110 deletions(-) diff --git a/CHANGES b/CHANGES index 8d03aaef..9c330cb5 100644 --- a/CHANGES +++ b/CHANGES @@ -4,17 +4,7 @@ Changelog Here you can find the recent changes to vcspull -CURRENT -------- - -Breaking Changes: - - [cli] [internal]: command line arg parsing now uses `click`_ library. -- [cli]: The command to update repositories is now ``vcspull u``, - ``vcspull up`` or ``vcspull update``:: - - $ vcspull up neovim - $ vcspull up neovim vim django - [cli] vcspull will use the beginning part of the argument to determine if its searching by vcs URL, repository name or system path. - [config] ``repo`` (the longform for the vcs url) is now ``url``. @@ -38,45 +28,31 @@ Breaking Changes: - [internal]: major internal cleanup of dead code, pep8 style updates. - [git] [tests]: fix git+https remotes `#14`_, add regression tests. -.. _#14: https://github.com/tony/vcspull/issues/14 -.. _click: https://github.com/pallets/click - -0.2.2 ------ +- :release:`0.2.2 <2015-07-10>` - [internal]: devendorize colorama -0.2.1 ------ - +- :release:`0.2.1 <2015-06-12>` - [internal] [tests]: handle ``ERROR`` in git cloning, add tests. Fixes cases like ``ERROR: Repository not found``. -0.2 ---- - +- :release:`0.2.0 <2015-05-19>` - [api] Change the API of :class:`vcspull.repo.base.BaseRepo` and :class:`vcspull.repo.Repo` to accept arguments as ``kwargs`` - [api]: Rename ``parent_path`` to ``cwd``. - [docs]: Pydoc documentation for ``Repo`` usage. - [docs]: Python API example -0.1.1 ------ - +- :release:`0.1.1 <2015-05-09>` - [testing] Fix sniffer on Python 3 - [cli] remove redundant message when adding remotes - [docs] add animated screencast preview for ReadTheDocs and README.rst -0.1 ---- - +- :release:`0.1.0 <2015-04-30>` - [cli]: support for specifying for config file path with ``-c``. - [cli]: clarify error output when no repositories found -0.0.10 ------- - +- :release:`0.0.10 <2015-04-08>` - [cli]: fix message when adding remotes - [internals]: split config-related functions into ``config`` module. - [tests]: consolidate tests from ``testsuite.cli`` into @@ -86,16 +62,12 @@ Breaking Changes: - [cli]: vcspull now checks for configs in ``~/.vcspull`` (yaml and json files) as well as the standard ``~/.vcspull.{yaml,json}`` files. -0.0.9.1 -------- - +- :release:`0.0.9-1 <2015-03-27>` - [internals]: move to ``__about__.py`` convention for pulling package data. - [internals]: remove extraneous url from stdout in git repositories. -0.0.9 ------ - +- :release:`0.0.9 <2015-03-25>` - [dev]: support for tmuxp ``before_script`` to set up local virtualenv + dependencies. - [dev]: Clean up ``__init__.py`` imports @@ -110,64 +82,42 @@ Breaking Changes: - [docs]: Update docs to reflect updates on new commands and how to clone private / priveleged GitHub repos. -.. _fnmatch: http://pubs.opengroup.org/onlinepubs/009695399/functions/fnmatch.html - -0.0.8.4 -------- - +- :release:`0.0.8-4 <2014-02-06>` - [cli] Update documentation when no config found to show ``yaml`` and ``json``. Remove mentioning of ``conf``. -0.0.8.3 -------- - +- :release:`0.0.8-3 <2014-02-06>` - [logging] `Issue #6`_ - fix issue where log templates would not concatenate correctly. -.. _issue #6: https://github.com/tony/vcspull/issues/6 - -0.0.8.2 -------- - +- :release:`0.0.8-2 <2014-02-05>` - [packaging] Fix issue where ``package_metadata.py`` missing from ``MANIFEST.in``. -0.0.8.1 -------- - +- :release:`0.0.8-1 <2014-02-05>` - [setup.py] remove history from readme -0.0.8 ------ - +- :release:`0.0.8 <2014-02-05>` - Use werkzeug/flask style unit test suites. - [docs] Fix section headings. - [internals] use conventions from `tony/cookiecutter-pypackage`_. -0.0.7 ------ - +- :release:`0.0.7 <2014-01-07>` - New logging system from pypa/pip with support showing current stderr (checkout, pull, cloning) progress. - ``unicode_literals``, ``__future__`` for python 3 support. -0.0.6 ------ - +- :release:`0.0.6 <2013-12-03>` - Renamed to ``vcspull``. -0.0.5 ------ - +- :release:`0.0.5 <2013-11-28>` - [tests] tests for loading multiple configs, config conflict cases - [internal] fix recursive imports, using explicit importing - [git] handle cli case where git is on a different branch, just fetch repo. - [py3] python 3 support -0.0.4 ------ - +- :release:`0.0.4 <2013-11-25>` - [svn] [git] [hg] added functionality for pip's netloc and vcs functionality. - [docs] update license docs for methods from salt (apache) and pip (mit). @@ -176,9 +126,8 @@ Breaking Changes: with ``${envvar}`` and ``~``. - [cli] Exit with ``Ctrl-C`` gracefully. -0.0.3 ------ +- :release:`0.0.3 <2013-11-23>` - [docs] [examples] more docs and examples - [internal] remove developer logger message that would show when updating. @@ -186,73 +135,42 @@ Breaking Changes: - [`pep257`_] [`pep8`_] [logger] update ``vcspull.log`` module to latest code (from `tmuxp`_ project). -0.0.2 ------ - -11/23/2013 -~~~~~~~~~~ - +- :release:`0.0.2 <2013-11-23>` - [tests] Move tests for making directory paths to ``test_repo`` TestSuite. - [tests] [git] more work on remotes with :class:`vcspull.repo.git.GitRepo`. -11/16/2013 -~~~~~~~~~~ - +- :release:`0.0.2 <2013-11-16>` - [tests] refactor tests modules - [git] add some functions with saltstack to :py:class:`vcspull.repo.git.GitRepo`. - [version] reset to 0.1.0 w/o dev tag to begin releases. -0.0.1 ------ - -11/15/2013 -~~~~~~~~~~ - +- :release:`0.0.1 <2013-11-15>` - [cli] [tests] fix `issue #1`_ for making directories recursively. -.. _issue #1: https://github.com/tony/vcspull/issues/1 - -11/14/2013 -~~~~~~~~~~ - +- :release:`0.0.1 <2013-11-15>` - [tests] :py:mod:`tempfile`. - [cli] [config] remove .ini support -11/09/2013 -~~~~~~~~~~ - +- :release:`0.0.1 <2013-11-09>` - `pep257`_ to all modules. - Add `argcomplete`_. - -11/09/2013 -~~~~~~~~~~ - - Move in code patterns from `tmuxp`_. New logger, setup.py, testsuite structure, etc. -10/23/2013 -~~~~~~~~~~ - +- :release:`0.0.1 <2013-10-23>` - add example -10/17/2013 -~~~~~~~~~~ - +- :release:`0.0.1 <2013-10-17>` - fix packaging issue, add MANIFEST.in - bump to 0.1.1 -10/08/2013 -~~~~~~~~~~ - +- :release:`0.0.1 <2013-10-08>` - move to semver -10/06/2013 -~~~~~~~~~~ - -https://github.com/tony/vcspull/compare/a96e723269...a5be723de5 - +- :release:`0.0.1 <2013-10-06>` +- https://github.com/tony/vcspull/compare/a96e723269...a5be723de5 - remove virtualenv dep [Done] - remove pip dep [Done] - logging for repo obtain/update/makedir/rev [Done] @@ -267,4 +185,12 @@ https://github.com/tony/vcspull/compare/a96e723269...a5be723de5 .. _argcomplete: https://github.com/kislyuk/argcomplete .. _tony/cookiecutter-pypackage: https://github.com/tony/cookiecutter-pypackage. +.. _#14: https://github.com/tony/vcspull/issues/14 +.. _click: https://github.com/pallets/click + +.. _fnmatch: http://pubs.opengroup.org/onlinepubs/009695399/functions/fnmatch.html +.. _issue #6: https://github.com/tony/vcspull/issues/6 + +.. _issue #1: https://github.com/tony/vcspull/issues/1 + .. vim: set filetype=rst: diff --git a/doc/conf.py b/doc/conf.py index 7a6a68c8..0cba6682 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -40,8 +40,15 @@ 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinxarg.ext', + 'releases', ] +# 'releases' (changelog) settings +releases_unstable_prehistory = True +releases_document_name = "history" +releases_issue_uri = "https://github.com/tony/vcspull/issues/%s" +releases_release_uri = "https://github.com/tony/vcspull/tree/%s" + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/requirements/doc.txt b/requirements/doc.txt index d62d1c8d..3099dff7 100644 --- a/requirements/doc.txt +++ b/requirements/doc.txt @@ -2,3 +2,4 @@ sphinx sphinx-argparse>=0.1.4 sphinx_rtd_theme +releases==1.2.0