Changelog

Unreleased

Released:

TBD

New Features

  • ✨ Added value_map support to from-reqif structured mapping entries. A mapping field can now specify source_attribute (the ReqIF attribute to read) and a value_map table (Sphinx-Needs value → ReqIF value) for automatic value translation during import. When the mapped field is type, the emitted RST directive is updated accordingly.

Fixes

  • 🐛 Fixed from-reqif multi-value enum fields: previously only the last selected enum value was kept; now all selected values are collected and joined with ", ".

Deprecations

  • The [ubconnect.from_reqif.rst.type_mapping] table is deprecated and will be removed in a future release. Use structured mapping entries with value_map instead (see Mapping with Value Translation).

0.13.0

Released:

27.03.2026

New and Improved

  • ✨ Added value_map to [ubconnect.to_reqif.mapping.*]. Provides explicit translation of Sphinx-Needs field values to ReqIF attribute values for enum and string datatypes. See Value Map (Explicit Value Translation).

0.12.0

Released:

16.03.2026

New and Improved

path_field can now also be used in Mode 0 (without type_value or container_as_need): the path is built from ancestor node titles in the ReqIF hierarchy tree. name_attribute can optionally override the attribute used for path segment names.

  • ✨ Added container_as_need and type_for_need to [ubconnect.from_reqif.section]. When container_as_need = true, section/container nodes are emitted as needs instead of being discarded, and their type is set to type_for_need. Two new operating modes are introduced:

    • Mode 1 (container_as_need only): structural nesting — any node with children becomes a container need regardless of spec-object type.

    • Mode 3 (container_as_need + type_value): typed container — nodes matched by type are emitted as container needs.

    Nodes that lack the configured mapping id attribute fall back to the ReqIF Spec-Object UUID (prefixed with id_prefix). ** BREAKING ** When no [ubconnect.from_reqif.section] configuration is provided, the legacy fallback has been removed. Mode 0 is the replacement and emits all nodes as flat needs instead of guessing section nodes based on the presence of children. See Operating Modes.

0.11.0

Released:

16.03.2026

New and Improved

  • 👌 Improved ReqIF-to-Needs section detection configuration (from-reqif) to support both spec-object-type and attribute-based discrimination. See Section Detection (Hierarchy).

  • ✨ Added path_field to [ubconnect.from_reqif.section] to populate a need field with the full section hierarchy path (for example "Root > SubFolder").

Fixes

  • 🐛 Fixed error handling when outpath is wrongly configured such as empty string

  • 🐛 Remove dependency on wmic for licensing on Windows

0.10.0

Released:

06.03.2026

New and Improved

0.9.0

Released:

27.02.2026

New and Improved

  • ✨ Added Jama Connector support Jama Connect

  • ✨ Added CSV Connector support CSV

  • ✨ Added support for 1:N mapping: a single ReqIF attribute can now be mapped to multiple Sphinx-Needs fields. See Mapping Configuration.

  • 👌 Improved validation for mapping field names, static field conflicts, and case-insensitive duplicates in ReqIF-to-Needs conversion.

Fixes

  • 🐛 Fixed error handling for mapping and static field configuration conflicts.

0.8.0

Released:

19.02.2026

New and Improved

  • ✨ Added support for template parameter in mapping configuration, enabling dynamic field rendering with MiniJinja.

  • ✨ Added pattern support for editlink and weblink fields.

  • ✨ Added optional import_date field to all needs exported to ReqIF, recording the UTC import timestamp.

  • ✨ Added alm_tool configuration option for to-reqif to specify target ALM tool (doors or codebeamer). See ALM Tool Configuration.

  • ✨ Added hierarchical section configuration support for to-reqif. See (see Section Configuration)

  • ✨ Added new options images_target_dir and images_ref_dir for from-reqif to handle ReqIFZ attachments (e.g., images)

  • 👌 Enhanced support for Sphinx-Needs 6 data types (integer, boolean, number, arrays) in ReqIF conversion

Fixes

  • 🐛 Fixed ReqIF XML identifier generation to comply with XSD ID schema requirements

0.7.2

Released:

27.01.2026

New and Improved

  • 👌 Improved error message for the license configuration

Fixes

  • 🐛 Fixed relative license file path resolution using wrong app_id

  • 🐛 Supported ReqIF Datatype BOOLEAN, INTEGER, REAL, and DATE for from-reqif

0.7.1

Released:

26.01.2026

Fixes

  • 🐛 update the dependency of ReqIF to 0.0.48.

0.7.0

Released:

04.12.2025

New and Improved

  • ✨ Added origin_field option for to-reqif and from-reqif

  • 👌 Changed id_prefix behavior for from-reqif (avoid double-prefix; preserve Sphinx-Needs IDs)

0.6.0

Released:

20.11.2025

New and Improved

  • ✨ Added uuid_source for to-reqif and uuid_target for from-reqif

  • 👌 Do not force the ID prefix _ for from-reqif

  • 👌 Updated default mapping attribute names for to-reqif (prefer need_*)

  • 👌 Improved warnings for missing fields in to-reqif mapping configuration

  • 👌 Aligned outpath extension with reqifz flag

  • 👌 Improved warning for invalid ReqIF attribute names in from-reqif

  • 👌 Improved warning for missing mapped ReqIF attributes in from-reqif

Fixes

  • 🐛 Fixed the default datatype string not being applied when not given in the mapping configuration for to-reqif

0.5.0

Released:

30.10.2025

New and Improved

  • ✨ Added --config option for to-reqif and from-reqif

  • ✨ Added configuration for custom mappings from Sphinx-Needs fields to ReqIF attributes

0.4.0

Released:

16.10.2025

New and Improved

  • ✨ Added conversion from ReqIF SpecRelation to Sphinx-Needs link fields (from-reqif)

Fixes

  • 🐛 Fixed duplicate identifiers of SPEC-OBJECT and SPEC-HIERARCHY in the ReqIF XML file when using to-reqif

0.3.1

Released:

02.10.2025

Fixes

  • 🐛 Fixed section hierarchy when using to-reqif

  • 🐛 Fixed missing dependency error when using from-reqif

0.3.0

Released:

18.09.2025

New and Improved

  • ✨ Added CLI command from-reqif

0.2.0

Released:

25.08.2025

New and Improved

  • ✨ Added CLI option name

  • ✨ Added CLI option group-types

  • ✨ Export the name of how need items are grouped into ReqIfSpecifications to reqIf.Prefix

  • ✨ Resolve section hierarchy of need items and convert them to ReqIFSpecHierarchy

0.1.2

Released:

09.07.2025

Fixes

  • 🐛 Fixed need title to ReqIF.Name

  • 🐛 Fixed need content to ReqIF.Text

0.1.1

Released:

03.07.2025

New and Improved

  • Significantly reduced the binary package size of ubConnect.

Fixes

  • 🐛 Fixed enum serialization in reqif

0.1.0

Released:

18.06.2025

Initial release of the ubConnect CLI.

This version features exporting ReqIF files from needs.json.