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.

Source Distribution

releaselog-0.2.tar.gz (3.4 kB view details)

Uploaded Source

File details

Details for the file releaselog-0.2.tar.gz.

File metadata

  • Download URL: releaselog-0.2.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for releaselog-0.2.tar.gz
Algorithm Hash digest
SHA256 a9683ddef3f69feaacd74499360c573749022f709e187de61800dc02880fd7c6
MD5 bd703ec09ad969958b287f8b4a465aa1
BLAKE2b-256 d3f887423d1a04b45bb49f7693cadb435a78c29c378c95cbb3d77e07e814abff

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