Skip to main content

Generate release notess from git commit logs.

Project description

releaselog is a tool for generating release notes from git logs for taskotron. Currently it only supports a very small and fragile setup specific to Taskotron. This script might however be useful for other projects as well.

Installation

pip install releaselog

Or

python setup.py install

Usage

releaselog was originally meant to generate RST files for use with Sphinx, but could be used for pretty much anything else that wants RST. Adding this to your project should be simple.

Assumptions:
  • project uses sphinx for documentation
  • sphinx uses a ‘docs’ directory

From your ‘docs’ directory, run “releaselog”. The default is to drop down into the parent directory and examine git logs. You can optionally pass in a path “releaselog <path>” and it will add the docs to <path>/docs/source.

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
releaselog-0.2.tar.gz (3.4 kB) Copy SHA256 hash SHA256 Source None

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 SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page