You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Colin Powell cb751ec723 Adding a MANIFEST file 3 years ago
changelogbuilder Restructure the project and add a Makefile 3 years ago
.gitignore Restructure the project and add a Makefile 3 years ago
MANIFEST.in Adding a MANIFEST file 3 years ago
Makefile Updating some bootstrapping and make scripts 3 years ago
README.adoc Initial commit 3 years ago
requirements.txt Updating some bootstrapping and make scripts 3 years ago
setup.cfg Updating some bootstrapping and make scripts 3 years ago
setup.py Updating some bootstrapping and make scripts 3 years ago

README.adoc

= A simple CHANGELOG builder
Colin Powell <colin.powell@gmail.com>
v0.1, 2016-05-16

This is a fairly basic CLI tool which takes the current branch you're project is on and attempts to generate an intelligent CHANGELOG from the list of commits.

For this to work, your project needs to adhere to some fairly basic expectations so this tool will likely not be useful universally. That said, I'm open to adding functionality like branch comparison generators, and partial log buildilng.

For now, it simply reads the commit messages from all commits and tries to guess when a version has been set by reading a version number in the commit message. This will, obviously, result in some false positives, if you happen to mention a version number string without actually intending to mark a version. A smarter program might use tags, or branch comparison to avoid this. This tool is not that smart.

What we recommend is that you read over the log generated and clean up any inconsistencies.

== How to use

1. Install changelogbuilder: `pip install changelogbuilder`
2. Change to the tag or branch: `git checkout release/2.0.fabulous`
3. Run the builder `changelogbuilder > CHANGELOG.adoc`

== Notes

=== Philosophy

This tool is simple by design. All it does is pull commit messages out of your git log and dump them into standard out on the command line. Maybe it will do more in the future. Right now, it does not.

=== Full logs ( --full )

By default this tool dumps only the parts of a log that have been updated since the last run. If you would like to build a full log, e.g. for a project which has no CHANGELOG file, add --full to the parameter list.