Skip to content

Latest commit

 

History

History
107 lines (84 loc) · 6.61 KB

CHANGELOG.md

File metadata and controls

107 lines (84 loc) · 6.61 KB
Raw

Changelog

0.6.0

Compare with v0.5.0

Features

  • Upgrade Jinja2 to 3.0.3 (2f3f6bd)

  • Allow sorting of types when rendering a template (95eb4fe)

    The new "type_order" configuration key allows users to specify the order commit types are dprovided in when rendering a template.

Fixes

  • templates: Fix up the conventional-commit template (3fae8b1)
  • Update formatting and add missing typing (3199c6b)
  • Change flake8 to be a dev-dependency (4538ba5)

v0.5.0

Compare with v0.4.1

Features

  • api: Update internal API to be more user-friendly (cf53788)

  • cli: Add "version" subcommand (6ca1e53)

  • templates: Add conventional-commit template (alpha) (9aefe89)

    This template aims to allow for rendering parsed data in a Conventional Commit format. This can be used to round-trip and standardise Conventional Commits, as well as allow for manipulating commit data and re-rendering it.

v0.4.1

Compare with v0.4.0

Features

  • Return exit code 1 if no commits to template (dc9003d)

v0.4.0

Compare with v0.3.0

Features

  • docs: Update README with new properties for default templates (434a81a)

  • slack: Add support for compare and version patterns (2658093)

  • Add --template-name flag (72ac63f)

    The --template-name flag can be used to pick which template is used by the template command.

  • Add template.directory config property (70a0b61)

    The template.directory property can be used to specify a folder which can contain templates. May be a single string, or a list of strings.

  • examples: Add example script for creating a release (18cac15)

Fixes

  • Correct type of --unreleased-version flag (31ff1eb)
  • Correct the calculation of which version a commit is in (43f5cda)

v0.3.0

Compare with v0.2.0

Features

  • Refactor CLI library, update changelog template, add examples (b91ea2c)

    This commit replaces the Click library with Typer, adds new functionality to the default changelog template, and also adds some examples of how conventional can be used with other command-line tools.

    Changes:

    • When conventional is run from within a git repository, the root of the repository is checked for a .conventional.yaml file and, if it exists, the file is loaded as a configuration file.
    • The --config-file parameter can now be specified multiple times to load multiple configuration files. Each time the parameter is specified, properties in the given configuration file will override those in earlier files.
    • The template command supports setting the heading for unreleased changes via the --unreleased-version parameter. For template authors, this sets the tag["name"] property other properties on the tag object for unreleased commits are left as None. A new test unreleased has been added to test if a tag is for an unreleased version.
    • The default changelog templates support linking to Github / Bitbucket / etc. for showing the source at a given version and comparing two versions. This is configured via the version-link-pattern, used to generate a link to the source for a given version, and compare-link-pattern, used to link to a comparison between two versions.
    • The default changelog.md template also supports rendering "BREAKING CHANGE" footers.

    BREAKING CHANGE: The --path parameter has been removed. The command now need to be run from within a git repository if using any of the commands which interact with git (eg. list-commits).

v0.2.0

Compare with v0.1.0

Features

  • Add documentation and help text (ee25481)

v0.1.0

Features

  • Initial commit with config files (79a6df1)
  • Create core git repository parsing functionality (72d54b0)
  • Add "template" command for generating templates from commits (d216714)
  • Finish up "template" command, add new flags to other commands (608f976)