Commit b475f29d authored by Simon Chabot's avatar Simon Chabot
Browse files

docs: add a readme

parent 99c6a55bbeb9
# autochangelog
Autochangelog is a mercurial extension that tries to automatically generate
a changelog based on the description of the commits.
## Installation
Download the package, and install it on your computer (with pip for instance)
(the installation is mainly needed to make sure that you have all the
dependancies)
```bash
cd hg-autochangelog
pip3 install --user .
```
Activate the extension in your `~/.hgrc`
```
[extensions]
autochangelog = /path/to/hg-autochangelog/hg_autochangelog/main.py
```
## Usage
This extension adds a new `autochangelog` command to mercurial. The changelog is
written on the standard output. To write down the changelog, simply redirect the
standard output.
Error will be listed on the standard error output.
```bash
hg autochangelog > CHANGELOG.md
```
By default, the command build the changelog with the ancestors of the last
public changeset. You can customize the revision set with the `--rev` option:
```bash
hg autochangelog --rev "all()" > CHANGELOG.md
```
for instance, to use *all* the revisions.
#!/usr/bin/env python
# coding: utf-8
from setuptools import find_packages, setup
author = "Logilab"
author_email = "contact@logilab.fr"
install_requires = ["mercurial", "Jinja2"]
setup(
name="hg-autochangelog",
version="0.1.0",
license="AGPLv3",
description="automatically generate a changelog from your history",
author=author,
author_email=author_email,
install_requires=install_requires,
packages=find_packages(exclude=["test"]),
include_package_data=True,
zip_safe=False,
)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment