Metadata-Version: 2.1
Name: braulio
Version: 0.3.0
Summary: A command line tool to handle changelogs using Git commit messages
Home-page: https://github.com/mbarakaja/braulio
Author: José María Domínguez Moreno
Author-email: miso.0b11@gmail.com
License: MIT license
Keywords: braulio
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: Click

Braulio
=======


.. image:: https://img.shields.io/pypi/v/braulio.svg
        :target: https://pypi.python.org/pypi/braulio

.. image:: https://img.shields.io/travis/mbarakaja/braulio.svg
        :target: https://travis-ci.org/mbarakaja/braulio

.. image:: https://readthedocs.org/projects/braulio/badge/?version=latest
        :target: https://braulio.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status


Simplify software release by handling versioning and changelogs.

Braulio walks through all commits of your Git project and classifies them
to determine what should be the next version and generate a proper changelog.
To do so, it collects only Commits that follow a given message convention.

Read the `documentation`_ to know how it works.


Highlights
----------

* Determine the next version automatically.
* Update the Changelog with new changes.
* Customizable Commit message convention.
* Support pre-releases.
* Can merge pre-release changelogs.



Installing
----------

Install and update using pip:

.. code-block:: bash

    $ pip install -U braulio


Usage
-----

To setup your project

.. code-block:: bash

    $ brau init

To release a new version

.. code-block:: bash

    $ brau release


* Free software: MIT license


.. _documentation: https://braulio.readthedocs.io/en/latest/


History
=======

0.3.0 (2018-08-22)
------------------

Bug Fixes
~~~~~~~~~

* release

  - Abort when a lower version is passed to --bump
  - Stop aborting when user inputs No to confirmation prompt
  - Ensure --bump works with versions without minor and patch parts.
  - Validate tag_pattern value
* git - Fix Tag's __repr__ and __str__ methods

Features
~~~~~~~~

* release

  - Add --merge-pre option
  - Add --stage option
  - Support pre-release versions
  - Add option to customize the commit message
  - Add option to specify the current version
  - Add support to custom git tag names
  - Add support to custom commit message conventions
* cli - Add --version option to output current version

0.2.0 (2018-07-25)
------------------

Bug Fixes
~~~~~~~~~

* changelog - Fix release markup being inserted in the wrong place

Features
~~~~~~~~

* release

  - Show useful info while running release subcommand
  - Add support to custom change log file names
  - Support version string update on selected files
* init - Add interactive config and changelog files creation

0.1.0 (2018-07-13)
------------------

Features
~~~~~~~~

* release

  - Add --no-commit and --no-tag options
  - Add options for manual version bump



