https://github.com/honza/renodiff

Convert your git patch to a reno release note
https://github.com/honza/renodiff

Last synced: about 5 hours ago
JSON representation

Convert your git patch to a reno release note

• Host: GitHub
• URL: https://github.com/honza/renodiff
• Owner: honza
• License: gpl-3.0
• Created: 2017-03-06T12:06:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T20:27:20.000Z (almost 2 years ago)
• Last Synced: 2024-09-06T19:16:07.649Z (2 months ago)
• Language: Python
• Size: 39.1 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
===============================

renodiff

===============================

.. image:: https://img.shields.io/pypi/v/renodiff.svg

        :target: https://pypi.python.org/pypi/renodiff

.. image:: https://img.shields.io/travis/honza/renodiff.svg

        :target: https://travis-ci.org/honza/renodiff

.. image:: https://readthedocs.org/projects/renodiff/badge/?version=latest

        :target: https://renodiff.readthedocs.io/en/latest/?badge=latest

        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/honza/renodiff/shield.svg

     :target: https://pyup.io/repos/github/honza/renodiff/

     :alt: Updates

renodiff is a tool for converting a git commit diff to a `reno`_ release note.

It scans the commit message for Openstack-specific strings, like ``Closes-Bug``

or ``Implements``, finds the relevant bug numbers and links, and formats

everything for ingestion by reno.  You should still expand the release note by

hand to provide more context but renodiff can remove a lot of the grunt work.

.. _reno: https://docs.openstack.org/developer/reno/ 

Installation

------------

::

    pip install renodiff

Usage

-----

::

    git show | renodiff

License

-------

GNU General Public License v3

Credits

---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage