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 matyanUsage
Basic usage
See Basic concepts section to get impression on possible commit methodology and assumptions taken.
Generate changelog:
generate-changelogGenerate 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-otherGenerate 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.3Generate 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..acceptanceGenerate changelog with releases info shown
generate-changelog --show-releasesGenerate changelog between releases with releases info shown
generate-changelog 0.0.1..0.0.3 --show-releasesGenerate changelog between branches with releases info shown
generate-changelog master..dev --show-releasesGenerate changelog for the latest release with releases info shown
generate-changelog --latest-release --show-releasesGenerate changelog with headings only (no commit messages) and releases info shown
generate-changelog --headings-only --show-releasesGenerate changelog between two branches, show unreleased changes only:
generate-changelog master..acceptance --show-releases --unreleased-onlyRendering
The following renderers are implemented:
Markdown
RestructuredText
Historical Markdown (for compatibility with matyan versions prior to 0.4).
Markdown
generate-changelog --show-releases --renderer=markdownRestructuredText
generate-changelog --show-releases --renderer=restHistorical Markdown
generate-changelog --show-releases --renderer=historical-markdownJira integration
It’s possible to fetch ticket title and description from Jira. In order for it to work, you should provide a fetch-title and fetch-description arguments.
The following needs to be added to your .matyan.ini:
[Settings]
fetchDataFrom=JiraIn addition to that, you should put valid Jira credentials into your global .matyan.ini configuration file.
Command to run:
generate-changelog --show-releases --fetch-title --fetch-descriptionExamples
See the output directory for examples.
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 onNote, that placing .matyan.ini into the home root will make that configuration global for all projects. That however could be handy, since local .matyan.ini files simply override the global ones. For example, you could use global configuration for storing Jira credentials.
[Jira]
url:https://barseghyanartur.atlassian.net/
username:user@domain.com
token:abcd1234Tips and tricks
Write to file
generate-changelog --show-releases 2>&1 | tee changelog.mdCreate initial config file
matyan-make-configTesting
Simply type:
./runtests.pyOr use tox:
toxOr use tox to check specific env:
tox -e py36Writing 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.
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.4.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 84d61f1cc3e9f9302a2018b0ace18f927380adb5e1302cf7896fa6905a3f30fc |
|
| MD5 | 265ed0f57f3ac05217f12065f9d871b8 |
|
| BLAKE2b-256 | e4c16ede958473dded5614de29e4f51a25341bfdb87bc5ff4f226d0619883488 |
