maxking / scriv

changelog management tool

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Scriv

Scriv changelog management tool

PyPI Build status Documentation Supported Python versions License Sponsor me on GitHub nedbat on Twitter

Overview

Scriv is a command-line tool for helping developers maintain useful changelogs. It manages a directory of changelog fragments. It aggregates them into entries in a CHANGELOG file.

Getting Started

Scriv writes changelog fragments into a directory called "changelog.d". Start by creating this directory. (By the way, like many aspects of scriv's operation, you can choose a different name for this directory.)

To make a new changelog fragment, use the scriv create command. It will make a new file with a filename using the current date and time, your GitHub or Git user name, and your branch name. Changelog fragments should be committed along with all the other changes on your branch.

When it is time to release your project, the scriv collect command aggregates all the fragments into a new entry in your changelog file.

Documentation

Full documentation is at https://scriv.readthedocs.org.

License

The code in this repository is licensed under the Apache Software License 2.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome.

About

changelog management tool

License:Apache License 2.0


Languages

Language:Python 96.2%Language:Makefile 3.1%Language:Jinja 0.7%