Release v0.5.0 (#41)

makukha · Jan 10, 2025 · 0dbcb50 · 0dbcb50
1 parent a2d04ab
commit 0dbcb50
Show file tree

Hide file tree

Showing 12 changed files with 30 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,26 @@ All notable changes to this project will be documented in this file. Changes for
 
 <!-- towncrier release notes start -->
 
+## [v0.5.0](https://github.com/makukha/docsub/releases/tag/v0.5.0) — 2025-01-10
+
+### Breaking 🔥
+
+- Completely changed syntax and command available ([#36](https://github.com/makukha/docsub/issues/36))
+
+### Added 🌿
+
+- Logging with [loguru](https://loguru.readthedocs.io) ([#11](https://github.com/makukha/docsub/issues/11))
+
+### Docs
+
+- Updated project metadata ([#29](https://github.com/makukha/docsub/issues/29))
+
+### Misc
+
+- Started using docsub for self README management ([#36](https://github.com/makukha/docsub/issues/36))
+- Started using [pydantic-settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings) for settings management ([#37](https://github.com/makukha/docsub/issues/37))
+
+
 ## [v0.4.0](https://github.com/makukha/docsub/releases/tag/v0.4.0) — 2024-12-30
 
 ### Added 🌿

diff --git a/README.md b/README.md
@@ -3,15 +3,15 @@
 
 [![license](https://img.shields.io/github/license/makukha/docsub.svg)](https://github.com/makukha/docsub/blob/main/LICENSE)
 [![versions](https://img.shields.io/pypi/pyversions/docsub.svg)](https://pypi.org/project/tox-multipython)
-[![pypi](https://img.shields.io/pypi/v/docsub.svg#v0.4.0)](https://pypi.python.org/pypi/docsub)
+[![pypi](https://img.shields.io/pypi/v/docsub.svg#v0.5.0)](https://pypi.python.org/pypi/docsub)
 [![uses docsub](https://img.shields.io/badge/uses-docsub-royalblue)
 ](https://github.com/makukha/docsub)
 
 > [!WARNING]
-> This project is on its very early stage, syntax and functionality may change significantly. Even if not scared, use specific package version, e.g. `docsub==0.4.0`
-
-> [!WARNING]
-> With `docsub`, every documentation file becomes executable. Never use `docsub` to process files from untrusted sources.
+> * With `docsub`, every documentation file may become executable.
+> * Never use `docsub` to process files from untrusted sources.
+> * This project is in research stage, syntax and functionality may change significantly.
+> * If still want to try it, use pinned package version `docsub==0.5.0`
 
 
 # Features
@@ -23,7 +23,7 @@
 * Plays nicely with other markups
 
 > [!NOTE]
-> This file itself uses [docsub]() to substitute README examples from `tests` folder. Dig into raw markup if interested.
+> This file uses [docsub]() itself. Dig into raw markup if interested.
 
 ## Missing features
 
@@ -49,7 +49,7 @@
 # Installation
 
 ```shell
-uv tool install docsub==0.4.0
+uv tool install docsub==0.5.0
 ```
 
 # Basic usage

diff --git a/news.d/11.added.md b/news.d/11.added.md
diff --git a/news.d/29.docs.md b/news.d/29.docs.md
diff --git a/news.d/36.added.md b/news.d/36.added.md
diff --git a/news.d/36.misc.md b/news.d/36.misc.md
diff --git a/news.d/36.removed.1.md b/news.d/36.removed.1.md
diff --git a/news.d/36.removed.md b/news.d/36.removed.md
diff --git a/news.d/37.misc.md b/news.d/37.misc.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -65,7 +65,7 @@ dev = [
 # bump-my-version
 
 [tool.bumpversion]
-current_version = "0.4.0"
+current_version = "0.5.0"
 allow_dirty = true
 files = [
   {filename = "README.md"},

diff --git a/src/docsub/__init__.py b/src/docsub/__init__.py
@@ -1 +1 @@
-__version__ = '0.4.0'
+__version__ = '0.5.0'
diff --git a/uv.lock b/uv.lock