Generate changelog from Git commits.
Project description
Generate changelog from Git commits.
Prerequisites
Python 3.6, 3.7 and 3.8
Documentation
Documentation is available on Read the Docs.
Installation
Latest stable version on PyPI:
pip install matyan
Usage
See Basic concepts section to get impression on possible commit methodology and assumptions taken.
Generate changelog:
generate-changelog
Generate changelog skipping orphaned commits:
In some cases you would only want to show what has been done with tickets and skip all non-ticket related commits.
generate-changelog --no-other
Generate changelog between two releases:
In other cases you would want to show what has been done since last release. The following example would generate changelog since version 0.0.1 to version 0.0.3.
generate-changelog 0.0.1..0.0.3
Generate changelog between two branches:
Sometimes you just need to show the changes made on acceptance since last production release. The following example would generate changelog with changes that are on acceptance branch and not yet in master.
generate-changelog master..acceptance
Generate changelog with releases info shown
generate-changelog --show-releases
Generate changelog between releases with releases info shown
generate-changelog 0.0.1..0.0.3 --show-releases
Generate changelog between branches with releases info shown
generate-changelog master..dev --show-releases
Generate changelog for the latest release with releases info shown
generate-changelog --latest-release --show-releases
Generate changelog with headings only (no commit messages) and releases info shown
generate-changelog --headings-only --show-releases
Generate changelog between two branches, show unreleased changes only:
generate-changelog master..acceptance --show-releases --unreleased-only
Configuration
In order to customize names and texts, add a .matyan.ini in your project directory, form which you will be running the generate-changelog command.
Sample configuration:
[BranchTypes]
feature: Feature
bugfix: Bugfix
hotfix: Hotfix
deprecation: Deprecation
[OtherBranchType]
other: Other
[Unreleased]
unreleased: Unreleased
[IgnoreCommits]
exact: more
clean up
code comments
more on docs
repo
working
more on
wip
commit
prefix: more on
continue on
Tips and tricks
Write to file
generate-changelog --show-releases 2>&1 | tee changelog.md
Create initial config file
matyan-make-config
Testing
Simply type:
./runtests.py
Or use tox:
tox
Or use tox to check specific env:
tox -e py36
Writing documentation
Keep the following hierarchy.
=====
title
=====
header
======
sub-header
----------
sub-sub-header
~~~~~~~~~~~~~~
sub-sub-sub-header
^^^^^^^^^^^^^^^^^^
sub-sub-sub-sub-header
++++++++++++++++++++++
sub-sub-sub-sub-sub-header
**************************
License
GPL-2.0-only OR LGPL-2.1-or-later
Support
For any issues contact me at the e-mail given in the Author section.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for matyan-0.3.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | decede85a7c6b29809211b067906d79c7978d23f9f6089f7682ed79c35d57186 |
|
MD5 | ccbeface1aa141aa7562966f5b24b99a |
|
BLAKE2b-256 | c65aa3cb159b947790feeeec48c00c6cc56386947b7e1d9edc40988e9e6eea40 |