Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pawamoy/git-changelog

Automatic Changelog generator using Jinja2 templates.
https://github.com/pawamoy/git-changelog

angular-style atom-style automatic-changelog-generator changelog generator git

Last synced: 5 days ago
JSON representation

Automatic Changelog generator using Jinja2 templates.

Host: GitHub
URL: https://github.com/pawamoy/git-changelog
Owner: pawamoy
License: isc
Created: 2018-06-20T18:15:55.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-11-26T00:14:32.000Z (about 1 month ago)
Last Synced: 2024-12-14T11:01:36.371Z (12 days ago)
Topics: angular-style, atom-style, automatic-changelog-generator, changelog, generator, git
Language: Python
Homepage: https://pawamoy.github.io/git-changelog
Size: 3.28 MB
Stars: 143
Watchers: 3
Forks: 35
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # git-changelog

[![ci](https://github.com/pawamoy/git-changelog/workflows/ci/badge.svg)](https://github.com/pawamoy/git-changelog/actions?query=workflow%3Aci)

[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/git-changelog/)

[![pypi version](https://img.shields.io/pypi/v/git-changelog.svg)](https://pypi.org/project/git-changelog/)

[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#git-changelog:gitter.im)

Automatic Changelog generator using Jinja2 templates. From git logs to change logs.

## Features

- [Jinja2][jinja2] templates!

  You get full control over the rendering.

  Built-in [Keep a Changelog][keep-a-changelog] and [Angular][angular] templates

  (also see [Conventional Changelog][conventional-changelog]).

- Commit styles/conventions parsing.

  Built-in [Angular][angular-convention], [Conventional Commit][conventional-commit] and basic conventions.

- Git service/provider agnostic,

  plus references parsing (issues, commits, etc.).

  Built-in [GitHub][github-refs], [Gitlab][gitlab-refs] and [Bitbucket][bitbucket-refs] support.

- Understands [SemVer][semver] and [PEP 440][pep-440] versioning schemes.

  Guesses next version based on last commits.

- Parses [Git trailers][git-trailers], allowing to reference

  issues, PRs, etc., in your commit messages

  in a clean, provider-agnostic way.

- Template context injection,

  to furthermore customize how your changelog will be rendered.

- Todo:

    - [Plugin architecture][issue-19],

      to support more commit conventions and git services.

    - [Easy access to "Breaking Changes"][issue-14] in the templates.

[jinja2]:                 http://jinja.pocoo.org/

[keep-a-changelog]:       http://keepachangelog.com/en/1.0.0/

[angular]:                https://github.com/angular/angular/blob/master/CHANGELOG.md

[conventional-changelog]: https://github.com/conventional-changelog/conventional-changelog

[semver]:                 http://semver.org/spec/v2.0.0.html

[angular-convention]:     https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit

[conventional-commit]:    https://www.conventionalcommits.org/en/v1.0.0/

[github-refs]:            https://help.github.com/articles/autolinked-references-and-urls/

[gitlab-refs]:            https://docs.gitlab.com/ce/user/markdown.html#special-gitlab-references

[bitbucket-refs]:         https://support.atlassian.com/bitbucket-cloud/docs/markup-comments

[git-trailers]:           https://git-scm.com/docs/git-interpret-trailers

[pep-440]:                https://peps.python.org/pep-0440/

[issue-14]: https://github.com/pawamoy/git-changelog/issues/14

[issue-19]: https://github.com/pawamoy/git-changelog/issues/19

## Installation

```bash

pip install git-changelog

```

With [`uv`](https://docs.astral.sh/uv/):

```bash

uv tool install git-changelog

```

## Usage

Simply run `git-changelog` in your repository to output a changelog on standard output.

To show the different options and their descriptions, use `git-changelog -h`.

- See [Quick usage](http://pawamoy.github.io/git-changelog/usage/#quick-usage)

  for some command line examples.

- See [Configuration](https://pawamoy.github.io/git-changelog/usage/#configuration-files)

  to learn how to configure *git-changelog* for your project.

- See the [CLI reference](https://pawamoy.github.io/git-changelog/cli)

  and the [API reference](https://pawamoy.github.io/git-changelog/reference) for more information.

## Alternatives

- [git-cliff](https://github.com/orhun/git-cliff): A highly customizable Changelog Generator that follows Conventional Commit specifications.