pawamoy / Git Changelog
Licence: isc
Automatic Changelog generator using Jinja2 templates.
Stars: ✭ 30
Programming Languages
python
139335 projects - #7 most used programming language
Projects that are alternatives of or similar to Git Changelog
git-conventional-commits
Git Conventional Commits Util to generate Semantic Version and Markdown Change Log and Validate Commit Messag
Stars: ✭ 58 (+93.33%)
Mutual labels: generator, changelog
Maintainer
👨💻 🐳 Generate personal daily reports or summary, AUTHORS, CONTRIBUTING, CHANGELOG and so on for GitHub user or repository.
Stars: ✭ 152 (+406.67%)
Mutual labels: generator, changelog
Chyle
Changelog generator : use a git repository and various data sources and publish the result on external services
Stars: ✭ 137 (+356.67%)
Mutual labels: generator, changelog
Github Changelog Generator
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
Stars: ✭ 6,631 (+22003.33%)
Mutual labels: generator, changelog
Generate Gh Repo
Generate generator to create a new repository on GitHub.
Stars: ✭ 11 (-63.33%)
Mutual labels: generator
Project Name
Get the name of a project from package.json, git config, or basename of the current working directory.
Stars: ✭ 8 (-73.33%)
Mutual labels: generator
Swiftproject
🏆 Generate Swift project with necessary toolings
Stars: ✭ 27 (-10%)
Mutual labels: generator
Ios Icon Generator
This script is use to generate iOS/macOS/watchOS app icons more easier.
Stars: ✭ 878 (+2826.67%)
Mutual labels: generator
Strangelog
Painless file-based changelog management via CLI.
Stars: ✭ 12 (-60%)
Mutual labels: changelog
Goderive
Code Generation for Functional Programming, Concurrency and Generics in Golang
Stars: ✭ 848 (+2726.67%)
Mutual labels: generator
Larawiz
Larawiz is a easy project scaffolder for Laravel
Stars: ✭ 28 (-6.67%)
Mutual labels: generator
Clif
Binding generator to wrap C++ for Python using LLVM.
Stars: ✭ 845 (+2716.67%)
Mutual labels: generator
Samples Viewer Generator
🎉 A CLI utility tool to generate web app of data visualization samples for presentation purpose
Stars: ✭ 13 (-56.67%)
Mutual labels: generator
Aosp.changelog.to
Generates a change log between different aosp tags. Based on the wonderful work of @alsutton
Stars: ✭ 12 (-60%)
Mutual labels: changelog
git-changelog
Automatic Changelog generator using Jinja2 templates. From git logs to change logs.
Features
-
Jinja2 templates! You get full control over the rendering. Built-in Keep a Changelog and Angular templates (also see Conventional Changelog).
-
Commit styles/conventions parsing. Built-in Angular, Atom and basic styles.
-
Git service/provider agnostic, plus references parsing (issues, commits, etc.). Built-in GitHub and Gitlab support.
-
Understands Semantic Versioning: major/minor/patch for versions and commits. Guesses next version based on last commits.
-
Todo:
- Plugin architecture, to support more commit styles and git services.
- Template context injection, to furthermore customize how your changelog will be rendered.
- Easy access to "Breaking Changes" in the templates.
- Update changelog in-place, paired with commits/dates/versions range limitation ability.
Requirements
git-changelog requires Python 3.6 or above.
To install Python 3.6, I recommend using pyenv
.
# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv
# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"
# install Python 3.6
pyenv install 3.6.12
# make it available globally
pyenv global system 3.6.12
Installation
With pip
:
python3.6 -m pip install git-changelog
With pipx
:
python3.6 -m pip install --user pipx
pipx install --python python3.6 git-changelog
Usage (command-line)
usage: git-changelog [-h] [-o OUTPUT] [-s {angular,atom,basic}]
[-t {angular,keepachangelog}] [-v]
REPOSITORY
Command line tool for git-changelog Python package.
positional arguments:
REPOSITORY The repository path, relative or absolute.
optional arguments:
-h, --help Show this help message and exit.
-o OUTPUT, --output OUTPUT
Output to given file. Default: stdout.
-s {angular,atom,basic}, --style {angular,atom,basic}
The commit style to match against.
-t {angular,keepachangelog}, --template {angular,keepachangelog}
The Jinja2 template to use. Prefix with "path:" to
specify the path to a directory containing a file
named "changelog.md".
-v, --version Show the current version of the program and exit.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].