Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

Create a suggested CHANGELOG from your git repos logs

Project Description

changelog

Writing CHANGELOGs can be a grueling task but git logs can help you create a suggested CHANGELOG. The intention of this tool is to remove some of the grunt work involved checking diffs to write CHANGELOGs.

Installation

Currently this project is not on pip. You could clone this repository and run the command:

python setup.py develop

Usage

Command line usage:

usage: changelog [-h] -s START [-e END] -v VERSION [-i ISSUE]
                 [-u ISSUE_URL_PREFIX]

Publish suggested CHANGELOG from git commits

optional arguments:
  -h, --help            show this help message and exit
  -s START, --start START
                        Enter commit/tag/branch you want CHANGELOG from
  -e END, --end END     Enter commit/tag/branch you want CHANGELOG to. Default
                        value is set to `master` branch
  -v VERSION, --version VERSION
                        Enter new version number for the CHANGELOG
  -i ISSUE, --issue ISSUE
                        Enter issue ID pattern. Should be a regex pattern to
                        look for
  -u ISSUE_URL_PREFIX, --issue-url-prefix ISSUE_URL_PREFIX
                        Enter issue URL prefix. If your issues are on github
                        then it could be https://github.com/<username
                        >/<repository-name>/issues/<issue-number>

License

MIT (See LICENSE)

Note

Again, this command line tool creates a suggested CHANGELOG. So use it at your discretion. It is advisable to add more information to your CHANGELOG once you have created it through this command line utility. Better advice can be found here.

Release History

Release History

This version
History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
changelog-0.1.4.tar.gz (5.8 kB) Copy SHA256 Checksum SHA256 Source Aug 25, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting