Generate changelog from a git repository
Project description
apx-changelog
PyPI package to generate changelogs from a git repository.
For examples, look at changelogs of the following projects:
Usage
Must be run in the root of a git repository.
usage: changelog.py [-h] --ref REF
[--comments]
[--out OUT]
[--releases RELEASES]
[--log LOG]
[--title TITLE]
[--ver VER]
Changelog generator for git repository
optional arguments:
-h, --help show this help message and exit
--ref REF git ref from which to collect changes
--comments append comments section
--out OUT output filename to store collected changelog markdown text
--releases RELEASES releases repository name if different
--log LOG filename of changelog file to update
--title TITLE project title for changelog file updates
--ver VER project version X.Y[.Z] for changelog file updates
--mkver MKVER filename to store current version (X.Y.Z)
The utility will parse commits and include commit messages starting with the following keywords:
feat
: New Featuresfix
: Bug Fixesrefactor
: Refactoringperf
: Performance Enhancementsopt
: Optimizationsdocs
: Documentation Changeschore
: Administration and Chores
Example commit message:
fix: a fix of a bug (closes user/repo#123)
Will produce the following section in the changelog output:
# Bug Fixes
* a fix of a bug (closes [`123`](https://github.com/user/repo/issues/123))
The issue user/repo
can be omitted, then the link will point to the current repository.
A multi-line commit message will add comments
section in changelog, displaying full text of the commit message.
The changelog file specified with the --log
option can have a template header, written in /.changelog
file.
Repository tags
The git repository can have tags in the format v1.2
to simplify versioning (vZ.Y.Z
) using git.describe('--always', '--tags', '--match=v*.*')
.
Releases must be tagged in the format release-X.Y.Z
.
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 apx_changelog-1.0.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 286d5ac06bd4e7566785a7d9078afe51e4763f153c9f6580b359eb92ed7302f9 |
|
MD5 | 69733066af340610801e01b06e11ac46 |
|
BLAKE2b-256 | 7bf69af86211ac493f7973645571c54abc3b0ea223244652a37ddd790adc9b9c |