git-changelog

Automatic Changelog generator using Jinja2 templates.

ISC License

Downloads
27.3K
Stars
135
Committers
7

Bot releases are hidden (Show)

git-changelog - 1.0.0

Published by pawamoy over 1 year ago

Breaking changes

This version brings a lot of new features, so I took this opportunity
to break things, allowing to clean things up, and to bump to version 1.0.0.

  • New version is not automatically guessed anymore (by bumping latest version).
    Enable it again with the --bump-latest CLI option.
  • Provider-specific references are not parsed by default anymore.
    Parse them again with the --parse-refs CLI option.
  • The commit convention cannot be passed with the -s CLI option anymore.
    This option is now used for declaring sections. Use -c instead.
    See usage.
  • Rename Python objects by replacing occurrences of "style" by "convention" everywhere.

Features

Lots of new features! Usage is documented here: https://pawamoy.github.io/git-changelog/usage/.

  • Support updating changelog in-place (18029cd by Timothée Mazzucotelli). Issue #15
  • Better handle single, initial versions (4c6ecf5 by Timothée Mazzucotelli).
  • Use current directory by default (d50d0b1 by Timothée Mazzucotelli).
  • Allow choosing whether to guess new version by bumping latest (85c04fd by Timothée Mazzucotelli).
  • Support Git trailers, render them in Keep A Changelog template (cdf17c0 by Timothée Mazzucotelli).
  • Disable parsing of provider-specific references by default, allow enabling it (cf41a97 by Timothée Mazzucotelli).

Bug Fixes

  • Clean up body to fix parsing trailers (1183c25 by Timothée Mazzucotelli).
  • Fix building commit body (f76bf32 by Timothée Mazzucotelli).
  • Fix spacing in keepachangelog templates (cf5117a by Timothée Mazzucotelli).
  • Don't crash when trying to parse the latest tag as semver (e90aa2b by Timothée Mazzucotelli).
  • Keep a Changelog template: don't capitalize commit summary (87348ed by Timothée Mazzucotelli).
  • Keep a Changelog template: respect sections order (don't sort) (f645e62 by Timothée Mazzucotelli).
  • Use importlib.metadata instead of pkg_resources to get current version (79109d0 by Timothée Mazzucotelli).

Code Refactoring

  • Allow passing sections with -s CLI option (removed from commit convention option) (a1ae778 by Timothée Mazzucotelli).
  • Rename 'style' to 'convention' everywhere (c454481 by Timothée Mazzucotelli).
  • Rename inplace variable to in_place (7a271ef by Timothée Mazzucotelli).
  • Refactor CLI: all flags default to false (9616bdd by Timothée Mazzucotelli).
  • Refactor CLI for better library usage (43ec5d1 by Timothée Mazzucotelli).
  • Make changelog methods private (0b4bbc0 by Timothée Mazzucotelli).
  • Expose Changelog and Commit from git_changelog (d3dca05 by Timothée Mazzucotelli).
  • Detect more commit types (Karma/Angular), rework section titles (f751736 by Timothée Mazzucotelli).
  • Allow passing datetimes, UTC timestamps as strings, or nothing when creating commit (34460ab by Timothée Mazzucotelli).
  • Build body before instantiating commit (37de53f by Timothée Mazzucotelli).