Skip to content

Latest commit

 

History

History
347 lines (209 loc) · 23.8 KB

CHANGELOG.md

File metadata and controls

347 lines (209 loc) · 23.8 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

2.5.2 - 2024-04-04

Compare with 2.5.1

Bug Fixes

  • Fix bumping initial version (37a3b62 by Timothée Mazzucotelli). Issue-82

2.5.1 - 2024-04-02

Compare with 2.5.0

Dependencies

  • Declare dependency to packaging (29c4fa8 by Timothée Mazzucotelli).

2.5.0 - 2024-04-02

Compare with 2.4.1

Features

  • Add CLI and configuration option -n, --versioning to select versioning scheme (f9c91f1 by Timothée Mazzucotelli).
  • Implement SemVer and PEP 440 versioning schemes (f7c8bfa by Timothée Mazzucotelli).
  • Support for additional template variables (58a4d88 by Christian Meffert). Issue-17, PR-73, Co-authored-by: Timothée Mazzucotelli dev@pawamoy.fr

Bug Fixes

  • Deduplicate commits for unreleased version with merged branches (b61199f by Christian Meffert). PR-76
  • Handle no remote gracefully (92f6f94 by Christian Meffert). Issue-24, PR-75

Code Refactoring

2.4.1 - 2024-03-14

Compare with 2.4.0

Bug Fixes

  • Assign commits to versions following their commit graph (follow SemVer) (f191ed7 by Christian Meffert). Issue-70, Issue-42, PR-72, Co-authored-by: Timothée Mazzucotelli dev@pawamoy.fr
  • Ignore bump on new Git repo without unreleased commits (438968c by Christian Meffert). PR-71
  • Use provided version when creating first changelog entry (dd264cc by Christian Meffert). PR-69

2.4.0 - 2023-11-04

Compare with 2.3.2

Features

Bug Fixes

  • Always output release notes to stdout (1e44bca by Timothée Mazzucotelli). Issue #65

2.3.2 - 2023-10-25

Compare with 2.3.1

Dependencies

  • Use tomli instead of toml on Python less than 3.11 (37f7cf1 by Timothée Mazzucotelli).

2.3.1 - 2023-10-10

Compare with 2.3.0

Bug Fixes

  • Remove any credentials from remote URLs, not just GitHub tokens (5d07e91 by Timothée Mazzucotelli). Issue #61

2.3.0 - 2023-10-08

Compare with 2.2.0

Deprecations

Features

2.2.0 - 2023-08-17

Compare with 2.1.0

Features

  • Add option to omit empty versions from output (b91f777 by Sven Axelsson). PR #52

Code Refactoring

  • Remove broken Atom commit convention (2f33180 by Timothée Mazzucotelli).

2.1.0 - 2023-08-04

Compare with 2.0.0

Features

  • Add Bitbucket provider (5d793e5 by Sven Axelsson).

Code Refactoring

  • Stop using deprecated datetime.utcfromtimestamp (Python 3.12) (1f3ed5d by Sven Axelsson).

2.0.0 - 2023-07-03

Compare with 1.0.1

Breaking Changes

  • Drop support for Python 3.7

Features

  • Add option to output release notes (483745a by Timothée Mazzucotelli). Issue #49

Bug Fixes

  • Remove GitHub tokens from remote URL (187e26e by Timothée Mazzucotelli). Issue #50

Code Refactoring

  • Show default for every CLI option (f015830 by Timothée Mazzucotelli).
  • Remove Python 3.7 related code (3295812 by Timothée Mazzucotelli).

1.0.1 - 2023-05-10

Compare with 1.0.0

Bug Fixes

  • Check if the latest version tag is already part of the changelog (1fad8a8 by Kevin Squire).
  • Include v prefix in default version regular expression (a50d6a2 by Kevin Squire).

1.0.0 - 2023-02-04

Compare with 0.6.0

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).

0.6.0 - 2022-10-26

Compare with 0.5.0

Features

  • Add GIT_CHANGELOG_REMOTE variable (9b9b3fc by Lukáš Zapletal). PR #35

0.5.0 - 2021-11-14

Compare with 0.4.2

Dependencies

  • Accept Jinja2 3.x (9ef3259 by Timothée Mazzucotelli).

Features

  • Allow to choose conventional style from CLI (aafa779 by Ivan Gonzalez). PR #32
  • Add ConventionalCommit commit type (3becce8 by Kevin Squire). PR #30

Bug Fixes

  • Properly bump SemVer version (ecc7dd4 by Kevin Squire). References: #31
  • Fix typo in keepachangelog template (fa9b434 by Alexander Schleifer). PR #28

Code Refactoring

  • Use SemVer to bump version more reliably (b68a565 by Timothée Mazzucotelli).

0.4.2 - 2021-01-06

Compare with 0.4.1

Bug Fixes

  • Handle prerelease tags better (4bcc451 by Timothée Mazzucotelli).

0.4.1 - 2020-12-21

Compare with 0.4.0

Bug Fixes

  • Fix wrong version being printed (0ec050f by Timothée Mazzucotelli).

0.4.0 - 2020-05-21

Compare with 0.3.0

Bug Fixes

  • Use actual url for references (46a8790 by Timothée Mazzucotelli).
  • Use style subject if possible (7f2c3ad by Timothée Mazzucotelli).
  • Correctly handle nested subgroups for gitlab repos (8ca990b by Timothée Mazzucotelli).
  • Fix bumping versions starting with "v" (44e7644 by Timothée Mazzucotelli).

Code Refactoring

  • Move styles into new commit module to avoid cyclic dependencies (d90bd15 by Timothée Mazzucotelli).

Features

  • Improve changelog rendering (e9dd3f4 by Timothée Mazzucotelli).
    • Use today's date for current version
    • Move "compare" link below the heading (better table of contents in documentation)
    • Improve "compare" links to handle first and current version
    • Use selected commit types to render sections
  • Add default commit types to render variable (173392a by Timothée Mazzucotelli).
  • Always use today's date for unreleased version (1c34fa8 by Timothée Mazzucotelli).

0.3.0 - 2020-03-31

Compare with 0.2.0

Bug Fixes

  • Fix is_minor method for version (6d08978 by Loïc Viennois).
  • Fix parse_refs method for ProviderRefParser (dc51589 by Loïc Viennois).
  • Correctly detect major version, for both angular style and basic style (7385e19 by Loïc Viennois).

Code Refactoring

  • Add type hints to all classes and methods (95276ef by Loïc Viennois).

Features

  • Update template keepachangelog (ce76ed6) by RainChen:
    • Capitalize commit subject
    • Show author name for each commit
    • Sort commits by date
    • Unique commit subjects

0.2.0 - 2019-11-24

Compare with 0.1.1

Drop support for Python < 3.6.

Use poetry to manage the project!

Fixed

  • Fix detection of feature (is_minor) for angular style (4fbf0ee).

0.1.1 - 2018-06-27

Compare with 0.1.0

Fixed

  • Fix build with MANIFEST.in, add license file (013fb69).

Misc

0.1.0 - 2018-06-27

Compare with first commit

Added

  • Add github/github regexes (584fd73).

Fixed

Misc

  • Continue packaging (#6) (a29af2c).
  • Finish packaging (#6) (e92b492).
  • Implement reference parsing (a9b4a89).
  • Improve angular template, improve style/refs system (5b87d48).
  • Initial commit (83845fe).
  • Package code (#6) (1219eaf).
  • Update changelog for version 0.1.0 (14edcaf).
  • Update changelog for version 0.1.0 (610633d).
  • Update changelog for version 0.1.0 (2eaaa2e).
  • Work in progress (27a60e8).