From 3bca062cd71493f95c6c4c77ae1c949c0914254e Mon Sep 17 00:00:00 2001 From: Richard Frank Date: Wed, 24 Feb 2016 18:51:48 -0500 Subject: [PATCH] DOC: Updated with latest release process --- docs/source/release-process.rst | 28 +++++++++++---- docs/source/whatsnew/skeleton.txt | 59 +++++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+), 7 deletions(-) create mode 100644 docs/source/whatsnew/skeleton.txt diff --git a/docs/source/release-process.rst b/docs/source/release-process.rst index 24089c1a..3a9e348e 100644 --- a/docs/source/release-process.rst +++ b/docs/source/release-process.rst @@ -18,13 +18,11 @@ Edit the release date field to be today's date in the format: , -then include this file in ``docs/source/releases.rst``. New releases should -appear at the top. The syntax for this is: - -:: - - .. include:: whatsnew/.txt - +for example, November 6, 2015. +Remove the active development warning from the whatsnew, since it will no +longer be pending release. +Update the title of the release from "Development" to "Release x.x.x" and +update the underline of the title to match the title's width. Updating the ``__version__`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -193,3 +191,19 @@ Once we are happy, push the updated docs to the GitHub ``gh-pages`` branch. $ git push origin gh-pages `zipline.io `__ will update in a few moments. + +Next Commit +~~~~~~~~~~~ + +Push a new commit post-release that adds the whatsnew for the next release, +which should be titled according to a micro version increment. If that next +release turns out to be a major/minor version increment, the file can be +renamed when that's decided. You can use ``docs/source/whatsnew/skeleton.txt`` +as a template for the new file. + +Include the whatsnew file in ``docs/source/releases.rst``. New releases should +appear at the top. The syntax for this is: + +:: + + .. include:: whatsnew/.txt diff --git a/docs/source/whatsnew/skeleton.txt b/docs/source/whatsnew/skeleton.txt new file mode 100644 index 00000000..abb397d8 --- /dev/null +++ b/docs/source/whatsnew/skeleton.txt @@ -0,0 +1,59 @@ +Development +----------- + +:Release: x.x.x +:Date: TBD + +.. warning:: + This release is still under active development. All changes listed are + subject to change at any time. + + +Highlights +~~~~~~~~~~ + +None + +Enhancements +~~~~~~~~~~~~ + +None + +Experimental Features +~~~~~~~~~~~~~~~~~~~~~ + +.. warning:: + + Experimental features are subject to change. + +None + +Bug Fixes +~~~~~~~~~ + +None + +Performance +~~~~~~~~~~~ + +None + +Maintenance and Refactorings +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +None + +Build +~~~~~ + +None + +Documentation +~~~~~~~~~~~~~ + +None + +Miscellaneous +~~~~~~~~~~~~~ + +None