Conventional

Latest version: v0.6.0

Safety actively analyzes 681812 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 1 of 2

0.6.0

*Compare with [v0.5.0](https://github.com/multimac/conventional/compare/v0.5.0...0.6.0)*

Features
- Upgrade Jinja2 to 3.0.3 ([2f3f6bd](https://github.com/multimac/conventional/commit/2f3f6bdb38d9921e89082d079e9ab75150287ba0))
- Allow sorting of types when rendering a template ([95eb4fe](https://github.com/multimac/conventional/commit/95eb4fe0b2697679188af7df25531f40bacdc3df))

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](https://github.com/multimac/conventional/commit/3fae8b11972558e70378072865d2919dfe368600))
- Update formatting and add missing typing ([3199c6b](https://github.com/multimac/conventional/commit/3199c6bd41d545820db76a29a6c04961b8bbcbb2))
- Change flake8 to be a dev-dependency ([4538ba5](https://github.com/multimac/conventional/commit/4538ba5ba7a0af2908d0a8390d273c0ebac3fce4))

0.5.0

*Compare with [v0.4.1](https://github.com/multimac/conventional/compare/v0.4.1...v0.5.0)*

Features
- **api:** Update internal API to be more user-friendly ([cf53788](https://github.com/multimac/conventional/commit/cf53788389e43a0658c6c2fc4e591d45c0d0f090))
- **cli:** Add "version" subcommand ([6ca1e53](https://github.com/multimac/conventional/commit/6ca1e536f1d6d2209cb86dad2b5cd677013afcd1))
- **templates:** Add conventional-commit template (alpha) ([9aefe89](https://github.com/multimac/conventional/commit/9aefe89dd759a29b78ca75cf827f0408a349ea01))

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.

0.4.1

*Compare with [v0.4.0](https://github.com/multimac/conventional/compare/v0.4.0...v0.4.1)*

Features
- Return exit code 1 if no commits to template ([dc9003d](https://github.com/multimac/conventional/commit/dc9003d9e070e77fb813210b06588fee6f74bc7e))

0.4.0

*Compare with [v0.3.0](https://github.com/multimac/conventional/compare/v0.3.0...v0.4.0)*

Features
- **docs:** Update README with new properties for default templates ([434a81a](https://github.com/multimac/conventional/commit/434a81a8f646d20425ba88226acb4c0ed468f230))
- **slack:** Add support for compare and version patterns ([2658093](https://github.com/multimac/conventional/commit/26580939308ac2f58a973a8a1baca2b3d4d11ee4))
- Add --template-name flag ([72ac63f](https://github.com/multimac/conventional/commit/72ac63f9f58fab34bcfa9601794c343d8560409b))

The `--template-name` flag can be used to pick which
template is used by the `template` command.
- Add `template.directory` config property ([70a0b61](https://github.com/multimac/conventional/commit/70a0b61b58d17aa194bd9a1373fa834f5136a51d))

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](https://github.com/multimac/conventional/commit/18cac153df799aa2d6a9006ec74b72199c0c0810))

Fixes
- Correct type of --unreleased-version flag ([31ff1eb](https://github.com/multimac/conventional/commit/31ff1ebfeaff75d91944f36f3c84cf1dc2c56e35))
- Correct the calculation of which version a commit is in ([43f5cda](https://github.com/multimac/conventional/commit/43f5cdaf0ba1b1ead249bc165bd72f42e1ac39ce))

0.3.0

*Compare with [v0.2.0](https://github.com/multimac/conventional/compare/v0.2.0...v0.3.0)*

Features
- Refactor CLI library, update changelog template, add examples ([b91ea2c](https://github.com/multimac/conventional/commit/b91ea2c1a269fdf2f3c885f5bdc13939cdfde75f))

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

0.2.0

*Compare with [v0.1.0](https://github.com/multimac/conventional/compare/v0.1.0...v0.2.0)*

Features
- Add documentation and help text ([ee25481](https://github.com/multimac/conventional/commit/ee254814ef312cab254fff447d4995fe7e204ff3))

Page 1 of 2

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.