v6.0.1

What's Changed

• 📚 Add release labels to changelog by @ubmarco in #1523
• 🔧 Improve error for variant options by @ubmarco in #1524
• 🔧 Fix schema json missing exc message by @ubmarco in #1526
• 👌 Add schema to add_extra_option by @ubmarco in #1527
• 🐛 Fix name error schema_path_contains by @ubmarco in #1530
• 🐛 Inject build_tags to variant filter strings by @ubmarco in #1531
• 🚀 Release v6.0.1 by @ubmarco in #1532

Full Changelog: 6.0.0...6.0.1

v6.0.0

What's Changed

• 👌 Re-allow dynamic functions for layout field by @chrisjsewell in #1423
• 🔧 Centralise allowed variant core need fields by @chrisjsewell in #1424
• 🐛 Warn on dynamic function with surrounding text by @chrisjsewell in #1426
• 🔧 Allow pre/post template global_options by @chrisjsewell in #1428
• ✨ Add is_import need field by @chrisjsewell in #1429
• 📚 update tox version to py39 by @ubmarco in #1438
• 🔧 Use ubuntu-latest in CI by @ubmarco in #1439
• 🔧 Added yamlfmt pre-commit by @ubmarco in #1446
• 🐛 Fix cyclic imports by @ubmarco in #1443
• 🔧 benchmark group non win32 by @ubmarco in #1450
• ⬆️ Drop Sphinx<7.4, test against Python 3.13 by @ubmarco in #1447
• 🔧 Allow template global_options by @chrisjsewell in #1454
• Allow collapse and hide in needs_global_options by @chrisjsewell in #1456
• 👌 Reset directive option specs at start of build by @ubmarco in #1448
• ⬆️ Drop Python 3.9 by @ubmarco in #1468
• 👌 Improve need part processing by @chrisjsewell in #1469
• 📚 Fix escape sequences by @ubmarco in #1470
• 📚 Format configuration.rst by @chrisjsewell in #1473
• ✨ Schema validation v2 by @ubmarco in #1467
• 📚 Clarify c.this_doc() for needextend by @ubmarco in #1475
• ‼️ Disallow add_extra_option overriding an internal field by @chrisjsewell in #1477
• ‼️ Improve needs default field application (via needs_global_options) by @chrisjsewell in #1478
• ♻️ Lazily assess directive options by @chrisjsewell in #1482
• 🔧 Split import item filtering to separate function by @chrisjsewell in #1484
• ♻️ Store needs as NeedItem / NeedPartItem, rather than standard dict by @chrisjsewell in #1485
• ♻️ Set some core need fields to nullable by @chrisjsewell in #1488
• 🐛 Fix: disallow need variants for list type fields by @chrisjsewell in #1489
• ♻️ split NeedItem internal data into core, extras, links and backlinks by @chrisjsewell in #1490
• ♻️ split off source fields in NeedItem internal data by @chrisjsewell in #1491
• ♻️ Auto-compute certain need fields by @chrisjsewell in #1496
• 📚 Fix needs_extra_links name by @HolgerPeters in #1501
• 👌 Capture more information about modifications on NeedItem by @chrisjsewell in #1502
• 🔧 Improve storage of constraint results on NeedItem by @chrisjsewell in #1504
• ♻️ Exclude is_need / is_part from needs.json output by @chrisjsewell in #1505
• 🔧 Improve storage of content generation on NeedItem by @chrisjsewell in #1506
• 🧪 Improve test for need parts by @chrisjsewell in #1507
• ♻️ Improve storage of part data on NeedItem by @chrisjsewell in #1509
• 👌 Write schema violations into a JSON file by @iSOLveIT in #1503
• Always generate schema violations.json report file by @iSOLveIT in #1511
• 🐛 Avoid leaking auth credentials for ext. need warnings by @cedossan in #1512
• 🔧 Add DynamicFunctionParsed dataclass by @chrisjsewell in #1514
• 🔧 Add VariantFunctionParsed dataclass by @chrisjsewell in #1515
• ‼️ remove parsing of deprecated needs_global_options format by @chrisjsewell in #1517
• 🧪 Move to snapshot testing for test_schema by @chrisjsewell in #1519
• ♻️ Allow for typed needs_extra_options fields by @chrisjsewell in #1516
• ♻️ Warn for missing needimport files by @PhilipPartsch in #1510
• 🔧 Improve plantuml check + add tests by @ubmarco in #1521
• 🚀 Release v6.0.0 by @ubmarco in #1522

New Contributors

• @HolgerPeters made their first contribution in #1501
• @cedossan made their first contribution in #1512

Full Changelog: 5.1.0...6.0.0

v5.1.0

What's Changed

• ♻️ Improve validation and docs for needs_global_options by @chrisjsewell in #1410
• ♻️ Change needs_global_options format by @chrisjsewell in #1413

Full Changelog: 5.0.0...5.1.0

v5.0.0

What's Changed

• ✨ Add c.this_doc() check for needextend filters by @chrisjsewell in #1393

• ✨ Extend c.this_doc() to all directives with filter option by @chrisjsewell in #1405

• ♻️ Remove back link manipulation from needextend by @chrisjsewell in #1386

• 🔧 Synchronize list splitting behaviour in need and needextend directives by @chrisjsewell in #1385

• 👌 Add type warnings of extra options in external/import reads by @chrisjsewell in #1389

• 🔧 Centralise extendable core need fields by @chrisjsewell in #1388

• ♻️ Don't process dynamic functions on internal need fields by @chrisjsewell in #1387

• ♻️ Make needextend argument declarative by @chrisjsewell in #1391

• 🔧 Remove constraints_passed/constraints_results directive options by @chrisjsewell in #1396

• ♻️ Remove delete from internal needs and needs.json by @chrisjsewell in #1347

• ♻️ Remove full_title need field and only trim generated titles by @chrisjsewell in #1407

• 🔧 Deprecate use of dynamic functions in need type fields by @chrisjsewell in #1406

• 🐛 Fix CSS for need table colors by @chrisjsewell in #1403

• 📚 clarify needimport argument format by @chrisjsewell in #1384

• 📚 Fix markup for dynamic functions by @ubmarco in #1382

• 📚 Update license year by @ubmarco in #1394

Full Changelog: 4.2.0...5.0.0

4.2.0

What's Changed

• 🔧 Add lineno to default output of needs.json by @chrisjsewell in #1346
• 🔧 Replace poetry with flit/uv by @chrisjsewell in #1355
• 🔧 Release needs data mutation lock at end of process by @chrisjsewell in #1359
• Allow filter-func in need-pie to have multiple dots in the import path. by @Aymen-Soussi-01 in #1373
• Fix typo in layout_styles.rst by @interifter in #1374
• 🐛 Fix: make external paths relative to confdir, not srcdir by @chrisjsewell in #1378
• ✨ Add needs_import_keys configuration by @chrisjsewell in #1379

New Contributors

• @Aymen-Soussi-01 made their first contribution in #1373
• @interifter made their first contribution in #1374

Full Changelog: 4.1.0...4.2.0

v4.1.0

What's Changed

• ✨ Add needs_from_toml configuration by @chrisjsewell in #1337
• ✨ Allow configuring description of extra option by @chrisjsewell in #1338
• 🐛 FIX needflow graphviz links by @chrisjsewell in #1339
• 🐛 Fix plantuml top-level import by @chrisjsewell in #1328
• ♻️ Improve access to dynamic configs: extra_options, functions, warnings by @chrisjsewell in #1332
• 🔧 Merge defaults into config earlier by @chrisjsewell in #1341
• 🔧 Remove some internal fields from needs layout by @chrisjsewell in #1330
• 📚 Docs: Fix API package by @ubmarco in #1327

Full Changelog: 4.0.0...4.1.0

v4.0.0

See https://sphinx-needs.readthedocs.io/en/latest/changelog.html

New Contributors

• @christopheseyler made their first contribution in #1296

Full Changelog: 3.0.0...4.0.0

v3.0.0

What's Changed

See https://sphinx-needs.readthedocs.io/en/latest/changelog.html

New Contributors

• @pre-commit-ci made their first contribution in #1179
• @AlexanderLanin made their first contribution in #1239

Full Changelog: 2.1.0...3.0.0

v2.1.0

What's Changed

Improvements

• 👌 Default to warning for missing needextend ID by @chrisjsewell in #1066
• 👌 Make needtable titles more permissive by @chrisjsewell in #1102
• 👌 Add filter_warning directive option, to replace default warning text by @kreuzberger in #1093
• 👌 Improve and test github needservice directive by @chrisjsewell in #1113
• 👌 Improve warnings for invalid filters (add source location and subtype) by @chrisjsewell in #1128
• 👌 Exclude external needs from needs_id_regex check by @David-Le-Nir in #1108
• 👌 Fail and emit warning on filters that do not return a boolean result by @big1hc in #964
• 👌 Improve Need node creation and content parsing by @chrisjsewell in #1168
• 👌 Add loading message to permalink.html by @csIcaK in #1081
• 👌 Remove hard-coding of completion and duration need fields by @chrisjsewell in #1127

Bug fixes

• 🐛 Image layout function by @danwos in #1135
• 🐛 Centralise splitting of need ID by @chrisjsewell in #1101
• 🐛 Centralise need missing link reporting by @chrisjsewell in #1104

Internal improvements

• 🔧 Use future annotations in all modules by @chrisjsewell in #1111

• 🔧 Replace black/isort/pyupgrade/flake8 with ruff by @chrisjsewell in #1080

• 🔧 Add better typing for extra_links config variable by @chrisjsewell in #1131

• 🔧 Centralise need parts creation and strongly type needs by @chrisjsewell in #1129

• 🔧 Fix typing of need docname/lineno by @chrisjsewell in #1134

• 🔧 Type ExternalSource config dict by @chrisjsewell in #1115

• 🔧 Enforce type checking in needuml.py by @chrisjsewell in #1116

• 🔧 Enforce type checking in api/need.py by @chrisjsewell in #1117

• 🔧 Add better typing for global_options config variable by @chrisjsewell in #1120

• 🔧 Move dead link need fields to internals by @chrisjsewell in #1119

• 🔧 Remove usage of hide_status and hide_tags by @chrisjsewell in #1130

• 🔧 Remove hidden field from extra_options by @chrisjsewell in #1124

• 🔧 Remove constraints from extra_options by @chrisjsewell in #1123

• 🔧 Remove use of deprecated needs_extra_options as dict by @chrisjsewell in #1126

New Contributors

• @csIcaK made their first contribution in #1081
• @big1hc made their first contribution in #964

Full Changelog: 2.0.0...2.1.0

v2.0.0

See: https://sphinx-needs.readthedocs.io/en/latest/changelog.html

This release is focussed on improving the internal code-base and its build time performance, as well as improved build warnings and other functionality improvements / fixes.

What's Changed

• 👌 Performance: Memoize Inline parser for build_need by @chrisjsewell in #968
• Easier Sphinx-Needs docs builds by @danwos in #972
• ♻️ Change NeedsBuilder format to needs by @chrisjsewell in #978
• 👌 Improve sphinx warnings by @chrisjsewell in #975
• 📚 DOCS: Always use headless plantuml by @chrisjsewell in #983
• 🐛 Fix gantt chart rendering by @chrisjsewell in #984
• 👌 Improve plantuml warnings by @chrisjsewell in #982
• 🔧 Replace Directive with SphinxDirective by @chrisjsewell in #986
• 🧪 Add headless java to test builds by @chrisjsewell in #988
• 🧪 Remove all make files in test build folders by @chrisjsewell in #989
• 📚 DOCS: Add intersphinx by @chrisjsewell in #991
• 🧪 Remove boilerplate from test build conf.py files by @chrisjsewell in #990
• 🐛 Fix execute_func by @chrisjsewell in #994
• 👌 Improve logging for static file copies by @chrisjsewell in #992
• 🔧 Centralise access to sphinx-needs config by @chrisjsewell in #998
• 🔧 Centralise sphinx env data access (and add schemas) by @chrisjsewell in #987
• 🔧 Add strict typing for sphinx_needs.builder by @chrisjsewell in #1000
• 🔧 Make NEEDS_CONFIG type safe by @chrisjsewell in #1001
• 🔧 Make mypy pre-commit hook isolated by @chrisjsewell in #1003
• 🔀🔧 MERGE: Add strict typing for most sphinx_needs modules by @chrisjsewell in #1002
• Bump cypress-io/github-action from 5 to 6 by @dependabot in #981
• 🐛 Fix adding sections to hidden needs by @chrisjsewell in #995
• 🐛 FIX: NeedImport logic by @chrisjsewell in #1006
• 🐛 Fix creation of need title nodes by @chrisjsewell in #1008
• Namnn/need per id json by @nhatnamnguyengtvthcm in #960
• 📚 DOCS: Add outline of extension logic by @chrisjsewell in #1012
• 👌 Improve removal of hidden need nodes by @chrisjsewell in #1013
• 👌 Improve process_constraints by @chrisjsewell in #1015
• Fixed extra links example by @piotr-zyskowski-rai in #1016
• 🔧 Remove unwrap function by @chrisjsewell in #1017
• 🧪 Add snapshot testing for needs data by @chrisjsewell in #1019
• Bump docker/build-push-action from 2 to 5 by @dependabot in #1024
• Bump docker/setup-buildx-action from 2 to 3 by @dependabot in #1023
• Bump docker/metadata-action from 4 to 5 by @dependabot in #1022
• Bump docker/login-action from 1 to 3 by @dependabot in #1021
• Bump actions/checkout from 3 to 4 by @dependabot in #1009
• 🧪 Add snapshot testing for cached doctrees by @chrisjsewell in #1020
• 👌 Optimize needextend filter_needs usage by @danwos in #1030
• 👌 From string fix by @danwos in #1031
• 🐛 Improve logic for process_needextend by @chrisjsewell in #1037
• 👌 Removing deepcopy by @danwos in #1033
• 🧪 CI: Make documentation builds fail on warnings by @chrisjsewell in #1005
• ✨ Add error messages for constraint failures by @chrisjsewell in #1036
• 🔧 Consolidate needs data post-processing by @chrisjsewell in #1039
• ♻️ Refactor needs post-processing function signatures by @chrisjsewell in #1040
• 🔧 Add strict typing for sphinx_needs.functions.functions by @chrisjsewell in #1042
• Fix usage of reST syntax in prefix parameter of meta by @sleiner in #1046
• 👌 Allow needextend to use dynamic functions by @chrisjsewell in #1052
• 👌 Remove some unnecessary keys from needs.json by @chrisjsewell in #1053
• 👌 Improve performance of needs builders by @chrisjsewell in #1054
• 🧪 Testing of JS scripts using Cypress integrated into PyTest by @iSOLveIT in #1051
• Add check CI job by @chrisjsewell in #1058
• Remove node install from core tests CI by @chrisjsewell in #1057
• 🧪 Remove plantuml config from test builds conf.py by @chrisjsewell in #1059
• ⬆️ Update to Sphinx 7 by @chrisjsewell in #1056
• 🔧 Fix benchmark.yaml CI regression by @chrisjsewell in #1062
• 🔧 Add remove_node_from_tree utility function by @chrisjsewell in #1063
• ✨ NEW: needs_reproducible_json config option by @chrisjsewell in #1065
• ♻️ Make matplotlib dependency optional by @chrisjsewell in #1061
• 🧪 Add code coverage to CI testing by @chrisjsewell in #1067
• 🔧 Bump actions/setup-node from 3 to 4 by @dependabot in #1050
• 🚀 Release v2.0.0 by @chrisjsewell in #1068
• 🧪 Test README builds in pre-commit by @chrisjsewell in #1069
• 📚 Pin pydantic version by @chrisjsewell in #1071
• 🔧 Fix Docker deployment by @chrisjsewell in #1070

New Contributors

• @nhatnamnguyengtvthcm made their first contribution in #960
• @piotr-zyskowski-rai made their first contribution in #1016
• @sleiner made their first contribution in #1046

Full Changelog: 1.3.0...2.0.0