Merge "docs: Add docs for reno integration"
This commit is contained in:
commit
36da1a13c0
|
@ -21,6 +21,7 @@ using an install tool such as *pip*.
|
||||||
* **ChangeLog**: Generate ChangeLog from git log
|
* **ChangeLog**: Generate ChangeLog from git log
|
||||||
* **Manifest**: Generate a sensible manifest from git files and some standard
|
* **Manifest**: Generate a sensible manifest from git files and some standard
|
||||||
files
|
files
|
||||||
|
* **Release Notes**: Generate a release notes file using reno
|
||||||
* **Requirements**: Store your dependencies in a pip requirements file
|
* **Requirements**: Store your dependencies in a pip requirements file
|
||||||
* **long_description**: Use your README file as a long_description
|
* **long_description**: Use your README file as a long_description
|
||||||
* **Smart find_packages**: Smartly find packages under your root package
|
* **Smart find_packages**: Smartly find packages under your root package
|
||||||
|
|
|
@ -62,7 +62,7 @@ From this, we note a couple of the main features of *pbr*:
|
||||||
- Extensive use of ``setup.cfg`` for configuration
|
- Extensive use of ``setup.cfg`` for configuration
|
||||||
- Automatic package metadata generation (``version``)
|
- Automatic package metadata generation (``version``)
|
||||||
- Automatic metadata file generation (``AUTHOR``, ``ChangeLog``,
|
- Automatic metadata file generation (``AUTHOR``, ``ChangeLog``,
|
||||||
``MANIFEST.in``)
|
``MANIFEST.in``, ``RELEASENOTES.txt``)
|
||||||
|
|
||||||
In addition, there are other things that you don't see here but which *pbr*
|
In addition, there are other things that you don't see here but which *pbr*
|
||||||
will do for you:
|
will do for you:
|
||||||
|
@ -257,6 +257,21 @@ test files.
|
||||||
|
|
||||||
__ https://packaging.python.org/tutorials/distributing-packages/#manifest-in
|
__ https://packaging.python.org/tutorials/distributing-packages/#manifest-in
|
||||||
|
|
||||||
|
Release Notes
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
.. admonition:: Summary
|
||||||
|
|
||||||
|
*pbr* will automatically use *reno* \'s ``build_reno`` setuptools command
|
||||||
|
to generate a release notes file, if reno is available and configured.
|
||||||
|
|
||||||
|
If using *reno*, you may wish to include a copy of the release notes in your
|
||||||
|
packages. *reno* provides a ``build_reno`` `setuptools command`__ and, if reno
|
||||||
|
is present and configured, *pbr* will automatically call this to generate a
|
||||||
|
release notes file for inclusion in your package.
|
||||||
|
|
||||||
|
__ https://docs.openstack.org/reno/latest/user/setuptools.html
|
||||||
|
|
||||||
Setup Commands
|
Setup Commands
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue