Skip to content

🚀 Release v0.2.4 #23

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.

Sign up for GitHub

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

Merged
ubmarco merged 1 commit into from
Oct 31, 2025
Merged

🚀 Release v0.2.4 #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/useblocks/needs-config-writer/compare/0.2.3...a4160cf>`__

- ✨ 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`:

Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------------------
Expand Down
2 changes: 1 addition & 1 deletion needs_config_writer/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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):
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down