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.

Source Distribution

braulio-0.3.0.tar.gz (38.7 kB view details)

Uploaded Source

Built Distribution

braulio-0.3.0-py2.py3-none-any.whl (14.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file braulio-0.3.0.tar.gz.

File metadata

  • Download URL: braulio-0.3.0.tar.gz
  • Upload date:
  • Size: 38.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

File hashes

Hashes for braulio-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b13f4a522e94a4a0911e6355614962726722771995f3ed7c5e295563a8533fc4
MD5 15517d778e2730d278e00162db4372fe
BLAKE2b-256 4bc8ce5b708532bf17cc53b8e2fbcd9909bc6fcc56eb5d9b45c6cb3771656f82

See more details on using hashes here.

File details

Details for the file braulio-0.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: braulio-0.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.3

File hashes

Hashes for braulio-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0697dccaf411b8bc854eada8237cb8a6baa8142cc29b052ab3702423131012e7
MD5 df5649709d7f0640e62269a69d47f056
BLAKE2b-256 63e54caf7c0a2abeaa9d9be198686e31b1144bdbe8f3f1dd4990eb9c02ce60d5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page