Add reno & start at release notes

ianw · ianw · commit 0661da9c91f3 · 2016-03-07T13:08:39.000+11:00
Add reno &amp; start at having release notes

Change-Id: I747ccfd87cc56e0797ec899097a6e338c720692e
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -22,7 +22,8 @@
 extensions = [
     'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
-    'oslosphinx'
+    'oslosphinx',
+    'reno.sphinxext'
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -15,6 +15,7 @@ Contents:
    installation
    usage
    contributing
+   releasenotes
 
 Indices and tables
 ==================
diff --git a/doc/source/releasenotes.rst b/doc/source/releasenotes.rst
@@ -0,0 +1,5 @@
+=============
+Release Notes
+=============
+
+.. release-notes::
diff --git a/releasenotes/notes/heredoc-ignore-905b29053652f90e.yaml b/releasenotes/notes/heredoc-ignore-905b29053652f90e.yaml
@@ -0,0 +1,28 @@
+---
+fixes:
+
+  - Ignore contents of ``heredoc`` values.  ``heredocs`` usually
+    contain content in a foreign syntax so ``bashate`` will no longer
+    consider them.
+
+  - Continuation lines are now parsed into an array, rather than a
+    single logical-line.  This fixes continuation lines being
+    incorrectly reported as too long.
+
+  - |
+    Indentation now allows emacs-formatted idents, where continuation
+    lines for long commands align to the first argument above (rather
+    than a strict modulo of 4).  e.g.
+
+    ::
+
+       longcommand arg1 arg2 arg3 \
+                   arg4 arg5
+
+    will no longer trigger a bad indent warning.
+
+  - Use ``bash -n`` to detect unclosed heredocs, rather than construct
+    our own parsing.
+
+  - Correctly check for newlines at the end of all files; even if you
+    only specify one file to check.
diff --git a/releasenotes/notes/start-using-reno-eaaafddb3fbf2010.yaml b/releasenotes/notes/start-using-reno-eaaafddb3fbf2010.yaml
@@ -0,0 +1,3 @@
+---
+other:
+  - started using reno
diff --git a/test-requirements.txt b/test-requirements.txt
@@ -14,3 +14,4 @@ oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
 testrepository>=0.0.18
 testscenarios>=0.4
 testtools>=1.4.0
+reno>=0.1.1

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,8 @@`
`22`	`22`	`extensions = [`
`23`	`23`	`'sphinx.ext.autodoc',`
`24`	`24`	`#'sphinx.ext.intersphinx',`
`25`		`- 'oslosphinx'`
	`25`	`+ 'oslosphinx',`
	`26`	`+ 'reno.sphinxext'`
`26`	`27`	`]`
`27`	`28`
`28`	`29`	`# autodoc generation is a bit aggressive and a nuisance when doing heavy`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+other:`
	`3`	`+ - started using reno`