Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add toml python extra to pull in a toml parser #126

Merged
merged 3 commits into from Jul 5, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Expand Up @@ -27,6 +27,14 @@ It can be installed with pip:

pip install antsibull-changelog

For python projects, `antsibull-changelog release` can retrieve the current
version from `pyproject.toml`.
You can install the project with

pip install antsibull-changelog[toml]

to pull in the necessary toml parser for this feature.
felixfontein marked this conversation as resolved.
Show resolved Hide resolved

For more information, see the
[documentation](https://github.com/ansible-community/antsibull-changelog/tree/main/docs/changelogs.rst).

Expand Down
5 changes: 5 additions & 0 deletions changelogs/fragments/126-toml-extra.yaml
@@ -0,0 +1,5 @@
---
minor_changes:
- Add ``toml`` extra to pull in a toml parser to use to guess the version
based on ``pyproject.toml``
(https://github.com/ansible-community/antsibull-changelog/pull/126).
13 changes: 13 additions & 0 deletions pyproject.toml
Expand Up @@ -53,6 +53,19 @@ antsibull-changelog = "antsibull_changelog.cli:main"


[project.optional-dependencies]
#
# User facing
#

# Use for getting the current version from pyproject.toml
toml = [
"tomli; python_version<'3.11'",
]

#
# Development. Not user facing.
#

codeqa = [
"flake8 >= 3.8.0",
"pylint",
Expand Down