poetry-release 0.3.1

Prerequisite

Your project should be managed by git.

Replacements

Poetry-release supports two types of release replacements:

1. By Regex

   You can create replacements in files using regular expressions:

   release-replacements = [
       { file="CHANGELOG.md", pattern="\\[Unreleased\\]", replace="[{version}] - {date}" },
   ]

2. Message replacements

Templates

Poetry-release supports templates to build releases. Templates could be used in release replacements/messages/tags. Template is indicated like some text {package_name}

Release settings

These settings allow you to disable part of the functionality. They can be set either in pyproject.toml or in CLI like flag. Settings from CLI have a higher priority

Example

[tool.poetry-release]
release-replacements = [
    { file="CHANGELOG.md", pattern="\\[Unreleased\\]", replace="[{version}] - {date}" },
    { file="CHANGELOG.md", pattern="\\(https://semver.org/spec/v2.0.0.html\\).", replace="(https://semver.org/spec/v20.0.html).\n\n## [Unreleased]"},
]
disable-push = false
disable-tag = false
disable-dev = false
release-commit-message = "Release {package_name} {version}"
post-release-commit-message = "Start next development iteration {next_version}"
tag-name = "{version}"
sign-tag = true
sign-commit = true

poetry release minor --disable-dev --disable-tag