Skip to content

Commit 00e1371

Browse files
authored
Release 1.3.0 (#81)
Prepares the **1.3.0** release. ## Release changes - ⬆️ Bump version `1.2.0` → `1.3.0` in `pyproject.toml`. - 📝 Finalize the changelog: convert the `Upcoming` heading into a dated `1.3.0` section. Only 3 of the 10 PRs merged since 1.2.0 had added changelog entries, so this also documents the 7 user-facing PRs that were missing one. - 🗺️ Prune the completed "nested `.gitignore` support" item from the roadmap (shipped via #64). ## Changelog for 1.3.0 **New and Improved** - ✨ Added Go parser for the `analyse` module (#79) - ✨ Added JSONC language support for the `analyse` module (#70) - 👌 Replaced `gitignore-parser` with `ignore-python` for source discovery; added per-project `follow_links` (#64) - ⬆️ Support and test Sphinx-Needs v5-8 (#65) - ⬆️ Allow Sphinx 9 (#68) - 📚 Documented C# language support in `features.rst` (#78) - 🧪 Added a Sphinx integration test for C# source files (#78) **Fixes** - 🐛 Register Sphinx-Needs fields with a typed schema (#80) - 🐛 Don't mutate the `rebuild='env'` `src_trace_projects` config during builds (#75) - 🐛 Route `analyse` logging by environment instead of a stderr handler at import (#73) - 🐛 Validate field default ordering in the oneline config (#63) ## Verification - `tox -e docs-clean` (`sphinx-build -nW`) builds successfully — 0 schema warnings. ## After merge - Tag `1.3.0` on the merge commit (matching the existing `1.0.0`–`1.2.0` tags).
1 parent dcb1ac9 commit 00e1371

3 files changed

Lines changed: 49 additions & 7 deletions

File tree

docs/source/development/change_log.rst

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,60 @@
33
Changelog
44
=========
55

6-
Upcoming
7-
--------
6+
.. _`release:1.3.0`:
7+
8+
1.3.0
9+
-----
10+
11+
:Released: 20.06.2026
12+
13+
New and Improved
14+
................
815

9-
- ⬆️ Support and test sphinx-needs v5-8
10-
- 📚 Documented C# language support in ``features.rst``
11-
- 🧪 Added Sphinx integration test for C# source files
1216
- ✨ Added Go parser for the ``analyse`` module.
1317

1418
Need ID references and one-line need definitions can now be extracted from Go source files.
1519
The supported comment styles are ``//`` and ``/* */``.
1620

21+
- ✨ Added JSONC language support for the ``analyse`` module.
22+
23+
Comments in JSONC files are now parsed for need ID references and one-line need definitions.
24+
``.json`` files are also checked when they begin with a comment (see jsonc.org).
25+
26+
- 👌 Replaced ``gitignore-parser`` with ``ignore-python`` for source discovery.
27+
28+
This adds native nested ``.gitignore`` support, improves performance, and brings behavioral
29+
parity with ubCode. A per-project ``follow_links`` configuration option was also added.
30+
31+
- ⬆️ Support and test Sphinx-Needs v5-8.
32+
- ⬆️ Allow Sphinx 9.
33+
- 📚 Documented C# language support in ``features.rst``.
34+
- 🧪 Added a Sphinx integration test for C# source files.
35+
36+
Fixes
37+
.....
38+
39+
- 🐛 Register Sphinx-Needs fields with a typed schema.
40+
41+
The ``project``, ``file``, ``directory`` and URL fields are now registered with a typed
42+
(string) schema, so they no longer trigger schema violations on needs that do not set them
43+
when strict Sphinx-Needs schema validation is enabled.
44+
45+
- 🐛 Do not mutate the ``rebuild='env'`` ``src_trace_projects`` configuration during builds.
46+
47+
Incremental Sphinx builds no longer re-read every document on each run.
48+
49+
- 🐛 Route ``analyse`` logging through the active environment instead of installing a stderr
50+
handler at import time.
51+
52+
Routine INFO progress no longer goes to stderr unconditionally, and importing the package no
53+
longer forces a logging handler onto consumers.
54+
55+
- 🐛 Validate field default ordering in the oneline configuration.
56+
57+
A required field defined after a field with a default is now reported as an error instead of
58+
being silently skipped.
59+
1760
.. _`release:1.2.0`:
1861

1962
1.2.0

docs/source/development/roadmap.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ Source Code Parsing
1919

2020
- Introduce a configurable option to strip leading characters (e.g., ``*``) from commented RST blocks.
2121
- Enrich tagged scopes with additional metadata.
22-
- ✅ Nested ``.gitignore`` files are now supported (implemented via ``ignore-python``).
2322

2423
Defining Needs in Source Code
2524
-----------------------------

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "sphinx-codelinks"
3-
version = "1.2.0"
3+
version = "1.3.0"
44
description = "Fast Source Code Traceability for Sphinx-Needs"
55
authors = [{ name = "team useblocks", email = "info@useblocks.com" }]
66
maintainers = [

0 commit comments

Comments
 (0)