https://github.com/topenkoff/poetry-release
Poetry plugin for easy release management
https://github.com/topenkoff/poetry-release
git poetry python release-management semver
Last synced: 5 months ago
JSON representation
Poetry plugin for easy release management
- Host: GitHub
- URL: https://github.com/topenkoff/poetry-release
- Owner: topenkoff
- License: mit
- Created: 2021-02-07T19:48:44.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T09:16:47.000Z (almost 2 years ago)
- Last Synced: 2025-09-29T02:23:15.827Z (9 months ago)
- Topics: git, poetry, python, release-management, semver
- Language: Python
- Homepage:
- Size: 92.8 KB
- Stars: 20
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Poetry release
==============
|CI| |PyPi Package|
.. |CI| image:: https://github.com/topenkoff/poetry-release/actions/workflows/ci.yml/badge.svg
:target: https://github.com/topenkoff/poetry-release/actions?query=workflow
.. |PyPi Package| image:: https://img.shields.io/pypi/v/poetry-release?color=%2334D058&label=pypi%20package
:target: https://pypi.org/project/poetry-release/
Release managment plugin for
`poetry `__
*The project is currently under development and is not ready for use in
production.*
Inspired by `cargo-release `__
Features
--------
- `Semver `__ support
- Creating git tag and commits after release
- `Changelog `__ support
Installation
------------
**Note:** Plugins work at Poetry with version 1.2.0 or above.
You can install plugin via ``poetry``
.. code-block:: bash
poetry self add poetry-release
or via ``pipx inject``
.. code-block:: bash
pipx inject poetry poetry-release
Usage
-----
.. code-block:: bash
poetry release
Existing levels
- major
- minor
- patch
- release (default)
- rc
- beta
- alpha
Prerequisite
~~~~~~~~~~~~
Your project should be managed by git.
Config
------
Replacements
~~~~~~~~~~~~
Poetry-release supports two types of release replacements:
#. | By Regex
| You can create replacements in files using regular expressions:
.. code-block:: toml
release-replacements = [
{ file="CHANGELOG.md", pattern="\\[Unreleased\\]", replace="[{version}] - {date}" },
]
#. Message replacements
+---------------------------------+--------------------------------------------------+
| Replacement | Description |
+=================================+==================================================+
| ``release-commit-message`` | Message for release commit |
+---------------------------------+--------------------------------------------------+
| ``post-release-commit-message`` | Message for post release commit(if it's allowed) |
+---------------------------------+--------------------------------------------------+
| ``tag-name`` | The name of tag |
+---------------------------------+--------------------------------------------------+
| ``tag-message`` | The message for tag |
+---------------------------------+--------------------------------------------------+
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}``
+------------------+-------------------------------------------------------+
| Template | Description |
+==================+=======================================================+
| ``package_name`` | The name of this project in `pyproject.toml` |
+------------------+-------------------------------------------------------+
| ``prev_version`` | The project version before release |
+------------------+-------------------------------------------------------+
| ``version`` | The bumped project version |
+------------------+-------------------------------------------------------+
| ``next_version`` | The version for next development iteration (alpha) |
+------------------+-------------------------------------------------------+
| ``date`` | The current date in ``%Y-%m-%d``` format |
+------------------+-------------------------------------------------------+
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
+------------------+---------+-----+--------------------+---------------------------------+
| Settings | Default | CLI | ``pyproject.toml`` | Description |
+==================+=========+=====+====================+=================================+
| ``disable-push`` | false | yes | yes | Don't do git push |
+------------------+---------+-----+--------------------+---------------------------------+
| ``disable-tag`` | false | yes | yes | Don't do git tag |
+------------------+---------+-----+--------------------+---------------------------------+
| ``disable-dev`` | false | yes | yes | Skip bump version after release |
+------------------+---------+-----+--------------------+---------------------------------+
| ``sign-commit`` | false | no | yes | Signed commit |
+------------------+---------+-----+--------------------+---------------------------------+
| ``sign-tag`` | false | no | yes | Signed tag |
+------------------+---------+-----+--------------------+---------------------------------+
| ``dry-run`` | false | yes | no | Dry run release |
+------------------+---------+-----+--------------------+---------------------------------+
Default git messages
^^^^^^^^^^^^^^^^^^^^
- Tag name - ``{version}``
- Tag message - ``Released {package_name} {version}``
- Release commit - ``Released {package_name} {version}``
- Post release commit - ``Starting {package_name}'s next development iteration {next_version}``
Example
~~~~~~~
.. code-block:: toml
[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
.. code-block:: bash
poetry release minor --disable-dev --disable-tag