Browse Source

Merge "docs: Add docs for reno integration"

tags/5.0.0
Zuul 8 months ago
parent
commit
36da1a13c0
2 changed files with 17 additions and 1 deletions
  1. 1
    0
      doc/source/index.rst
  2. 16
    1
      doc/source/user/features.rst

+ 1
- 0
doc/source/index.rst View File

@@ -21,6 +21,7 @@ using an install tool such as *pip*.
21 21
 * **ChangeLog**: Generate ChangeLog from git log
22 22
 * **Manifest**: Generate a sensible manifest from git files and some standard
23 23
   files
24
+* **Release Notes**: Generate a release notes file using reno
24 25
 * **Requirements**: Store your dependencies in a pip requirements file
25 26
 * **long_description**: Use your README file as a long_description
26 27
 * **Smart find_packages**: Smartly find packages under your root package

+ 16
- 1
doc/source/user/features.rst View File

@@ -62,7 +62,7 @@ From this, we note a couple of the main features of *pbr*:
62 62
 - Extensive use of ``setup.cfg`` for configuration
63 63
 - Automatic package metadata generation (``version``)
64 64
 - Automatic metadata file generation (``AUTHOR``, ``ChangeLog``,
65
-  ``MANIFEST.in``)
65
+  ``MANIFEST.in``, ``RELEASENOTES.txt``)
66 66
 
67 67
 In addition, there are other things that you don't see here but which *pbr*
68 68
 will do for you:
@@ -257,6 +257,21 @@ test files.
257 257
 
258 258
 __ https://packaging.python.org/tutorials/distributing-packages/#manifest-in
259 259
 
260
+Release Notes
261
+~~~~~~~~~~~~~
262
+
263
+.. admonition:: Summary
264
+
265
+    *pbr* will automatically use *reno* \'s ``build_reno`` setuptools command
266
+    to generate a release notes file, if reno is available and configured.
267
+
268
+If using *reno*, you may wish to include a copy of the release notes in your
269
+packages. *reno* provides a ``build_reno`` `setuptools command`__ and, if reno
270
+is present and configured, *pbr* will automatically call this to generate a
271
+release notes file for inclusion in your package.
272
+
273
+__ https://docs.openstack.org/reno/latest/user/setuptools.html
274
+
260 275
 Setup Commands
261 276
 --------------
262 277
 

Loading…
Cancel
Save