From c9d6d5e389aa704f2d5bb5c7977c8ab7f952052b Mon Sep 17 00:00:00 2001 From: Marco Heinemann Date: Fri, 31 Oct 2025 21:58:29 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=80=20Release=20v0.2.4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/changelog.rst | 24 +++++++++++++++++++----- docs/configuration.rst | 2 +- needs_config_writer/__init__.py | 2 +- pyproject.toml | 2 +- 4 files changed, 22 insertions(+), 8 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index ea610ac..2483341 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -3,11 +3,25 @@ Changelog ========= -.. - .. _unreleased: +.. _`release:0.2.4`: - Unreleased - ---------- +0.2.4 +----- + +:Released: 31.10.2025 +:Full Changelog: `v0.2.3...v0.2.4 `__ + +- ✨ Convert absolute to relative paths (:pr:`22`) + + A new configuration option :ref:`config_relative_path_fields` was added to + specify which Sphinx-Needs configuration fields containing file paths + should be converted to relative paths in the exported TOML file. + + Main use case are generated paths by build systems such as Bazel. + + This allows to create more portable configuration files that can be + used across different environments or directory structures. + Committing ``ubproject.toml`` files to Git is only possible with stable paths. .. _`release:0.2.3`: @@ -19,7 +33,7 @@ Changelog - ✨ New config needscfg_exclude_defaults (:pr:`20`) - A new configuration option ``needscfg_exclude_defaults`` was added to + A new configuration option :ref:`config_exclude_defaults` was added to control whether default Sphinx-Needs configuration values should be excluded from the exported TOML file. diff --git a/docs/configuration.rst b/docs/configuration.rst index 82645b0..f213448 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -373,7 +373,7 @@ value. If they match, the option is excluded from the output file. configuration that includes all customized values while excluding unchanged defaults. This provides a clean view of what's been explicitly configured. -.. _`config_relativize_paths`: +.. _`config_relative_path_fields`: needscfg_relative_path_fields ----------------------------- diff --git a/needs_config_writer/__init__.py b/needs_config_writer/__init__.py index 2034a45..64c1976 100644 --- a/needs_config_writer/__init__.py +++ b/needs_config_writer/__init__.py @@ -1,6 +1,6 @@ """Sphinx extension to write Sphinx-Needs config to ubproject.toml.""" -__version__ = "0.2.3" +__version__ = "0.2.4" def setup(app): diff --git a/pyproject.toml b/pyproject.toml index 9fe86ed..88a2bc2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi" [project] name = "needs-config-writer" -version = "0.2.3" +version = "0.2.4" description = "Sphinx extension to write Sphinx-Needs config to ubproject.toml" readme = "README.rst" urls.Repository = "https://github.com/useblocks/needs-config-writer"