Merge pull request #477 from randomir/add-reno-for-changelog

Add reno for changelog
dwavesystems · Aug 19, 2021 · 502d68e · 502d68e
2 parents e5a48af + 28f338d
commit 502d68e
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 13 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
diff --git a/README.rst b/README.rst
@@ -1,10 +1,10 @@
 .. image:: https://badge.fury.io/py/dwave-cloud-client.svg
     :target: https://badge.fury.io/py/dwave-cloud-client
-    :alt: Last version on PyPI
+    :alt: Latest version on PyPI
 
-.. image:: https://travis-ci.org/dwavesystems/dwave-cloud-client.svg?branch=master
-    :target: https://travis-ci.org/dwavesystems/dwave-cloud-client
-    :alt: Linux/Mac build status
+.. image:: https://circleci.com/gh/dwavesystems/dwave-cloud-client.svg?style=svg
+    :target: https://circleci.com/gh/dwavesystems/dwave-cloud-client
+    :alt: Linux/MacOS build status
 
 .. image:: https://ci.appveyor.com/api/projects/status/6a2wjq9xtgtr2t2c/branch/master?svg=true
     :target: https://ci.appveyor.com/project/dwave-adtt/dwave-cloud-client/branch/master
@@ -65,7 +65,7 @@ Installation
 
 .. installation-start-marker
 
-Requires Python 3.5+:
+Requires Python 3.6+:
 
 .. code-block:: bash
 
@@ -89,7 +89,28 @@ License
 Released under the Apache License 2.0. See `<LICENSE>`_ file.
 
 
-Contribution
+Contributing
 ------------
 
-See `<CONTRIBUTING.rst>`_ file.
+Ocean's `contributing guide <https://docs.ocean.dwavesys.com/en/stable/contributing.html>`_
+has guidelines for contributing to Ocean packages.
+
+Release Notes
+~~~~~~~~~~~~~
+
+D-Wave Cloud Client uses `reno <https://docs.openstack.org/reno/>`_ to manage
+its release notes.
+
+When making a contribution to D-Wave Cloud Client that will affect users, create
+a new release note file by running
+
+.. code-block:: bash
+
+    reno new your-short-descriptor-here
+
+You can then edit the file created under ``releasenotes/notes/``.
+Remove any sections not relevant to your changes.
+Commit the file along with your changes.
+
+See reno's `user guide <https://docs.openstack.org/reno/latest/user/usage.html>`_
+for details.
diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -36,7 +36,8 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
-    'sphinx.ext.ifconfig'
+    'sphinx.ext.ifconfig',
+    'reno.sphinxext',
 ]
 
 # autodoc_default_flags = ['members']

diff --git a/docs/index.rst b/docs/index.rst
@@ -29,6 +29,7 @@ Documentation
   intro
   reference/index
   bibliography
+  release_notes
 
 .. sdk-end-marker
 

diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -0,0 +1 @@
+.. release-notes:: Release Notes
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 sphinx>=4.0.0,<5.0.0
 sphinx_rtd_theme
+reno[sphinx]==3.4.0
diff --git a/releasenotes/notes/add-reno-a45ccf1f7e141857.yaml b/releasenotes/notes/add-reno-a45ccf1f7e141857.yaml
@@ -0,0 +1,10 @@
+---
+prelude: >
+    We began using `Reno <https://docs.openstack.org/reno/>`_ as a changelog
+    tool after the release of 0.8.7.
+    Content added before that release is not included.
+    See `releases <https://github.com/dwavesystems/dwave-cloud-client/releases>`_
+    for previous release notes.
+features:
+  - |
+    Begin using reno for changelog.
diff --git a/requirements.txt b/requirements.txt
@@ -7,4 +7,7 @@ plucky>=0.4.3
 # optional bqm support
 # note: dqm supported in dimod>0.9.6
 dimod>=0.10.5
-numpy>=1.16
+numpy>=1.16
+
+# dev requirements
+reno==3.4.0