From 6a9ad7527d361bf5950b1e941bc832d4f6e41eb3 Mon Sep 17 00:00:00 2001 From: Marco Heinemann Date: Sat, 20 Jun 2026 22:40:55 +0200 Subject: [PATCH] Release 1.3.0 --- docs/source/development/change_log.rst | 53 +++++++++++++++++++++++--- docs/source/development/roadmap.rst | 1 - pyproject.toml | 2 +- 3 files changed, 49 insertions(+), 7 deletions(-) diff --git a/docs/source/development/change_log.rst b/docs/source/development/change_log.rst index d0ab1cc..5509b82 100644 --- a/docs/source/development/change_log.rst +++ b/docs/source/development/change_log.rst @@ -3,17 +3,60 @@ Changelog ========= -Upcoming --------- +.. _`release:1.3.0`: + +1.3.0 +----- + +:Released: 20.06.2026 + +New and Improved +................ -- โฌ†๏ธ Support and test sphinx-needs v5-8 -- ๐Ÿ“š Documented C# language support in ``features.rst`` -- ๐Ÿงช Added Sphinx integration test for C# source files - โœจ Added Go parser for the ``analyse`` module. Need ID references and one-line need definitions can now be extracted from Go source files. The supported comment styles are ``//`` and ``/* */``. +- โœจ Added JSONC language support for the ``analyse`` module. + + Comments in JSONC files are now parsed for need ID references and one-line need definitions. + ``.json`` files are also checked when they begin with a comment (see jsonc.org). + +- ๐Ÿ‘Œ Replaced ``gitignore-parser`` with ``ignore-python`` for source discovery. + + This adds native nested ``.gitignore`` support, improves performance, and brings behavioral + parity with ubCode. A per-project ``follow_links`` configuration option was also added. + +- โฌ†๏ธ Support and test Sphinx-Needs v5-8. +- โฌ†๏ธ Allow Sphinx 9. +- ๐Ÿ“š Documented C# language support in ``features.rst``. +- ๐Ÿงช Added a Sphinx integration test for C# source files. + +Fixes +..... + +- ๐Ÿ› Register Sphinx-Needs fields with a typed schema. + + The ``project``, ``file``, ``directory`` and URL fields are now registered with a typed + (string) schema, so they no longer trigger schema violations on needs that do not set them + when strict Sphinx-Needs schema validation is enabled. + +- ๐Ÿ› Do not mutate the ``rebuild='env'`` ``src_trace_projects`` configuration during builds. + + Incremental Sphinx builds no longer re-read every document on each run. + +- ๐Ÿ› Route ``analyse`` logging through the active environment instead of installing a stderr + handler at import time. + + Routine INFO progress no longer goes to stderr unconditionally, and importing the package no + longer forces a logging handler onto consumers. + +- ๐Ÿ› Validate field default ordering in the oneline configuration. + + A required field defined after a field with a default is now reported as an error instead of + being silently skipped. + .. _`release:1.2.0`: 1.2.0 diff --git a/docs/source/development/roadmap.rst b/docs/source/development/roadmap.rst index 293f984..45b78f7 100644 --- a/docs/source/development/roadmap.rst +++ b/docs/source/development/roadmap.rst @@ -19,7 +19,6 @@ Source Code Parsing - Introduce a configurable option to strip leading characters (e.g., ``*``) from commented RST blocks. - Enrich tagged scopes with additional metadata. -- โœ… Nested ``.gitignore`` files are now supported (implemented via ``ignore-python``). Defining Needs in Source Code ----------------------------- diff --git a/pyproject.toml b/pyproject.toml index 2c11dd5..61900c9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "sphinx-codelinks" -version = "1.2.0" +version = "1.3.0" description = "Fast Source Code Traceability for Sphinx-Needs" authors = [{ name = "team useblocks", email = "info@useblocks.com" }] maintainers = [