diff options
| author | Zuul <zuul@review.openstack.org> | 2018-10-06 18:34:58 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2018-10-06 18:34:58 +0000 |
| commit | 36da1a13c0197b3daf02003188cbae93509a644f (patch) | |
| tree | 01769f6eec66366eb3d05872bfecc1486ed27632 /doc/source/user | |
| parent | 7b2177843ba3b84ea95d13bec5a343d1a9106580 (diff) | |
| parent | dac6f829af0fcca3586d7e953c7020692ae700c0 (diff) | |
| download | pbr-36da1a13c0197b3daf02003188cbae93509a644f.tar.gz | |
Merge "docs: Add docs for reno integration"
Diffstat (limited to 'doc/source/user')
| -rw-r--r-- | doc/source/user/features.rst | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/source/user/features.rst b/doc/source/user/features.rst index 7e2e979..106fd1a 100644 --- a/doc/source/user/features.rst +++ b/doc/source/user/features.rst @@ -62,7 +62,7 @@ From this, we note a couple of the main features of *pbr*: - Extensive use of ``setup.cfg`` for configuration - Automatic package metadata generation (``version``) - 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* will do for you: @@ -257,6 +257,21 @@ test files. __ 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 -------------- |