Skip to main content

A command line tool to handle changelogs using Git commit messages

Project description

Braulio

https://img.shields.io/pypi/v/braulio.svg https://img.shields.io/travis/mbarakaja/braulio.svg 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:

$ pip install -U braulio

Usage

To setup your project

$ brau init

To release a new version

$ brau release
  • Free software: MIT license

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
braulio-0.3.0-py2.py3-none-any.whl (14.3 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Aug 23, 2018
braulio-0.3.0.tar.gz (38.7 kB) Copy SHA256 hash SHA256 Source None Aug 23, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page