👌 Exclude external needs from needs_id_regex check (#1108)

fix for [#1099](#1099)

---------

Co-authored-by: Chris Sewell <[email protected]>

Author: David-Le-Nir

.gitignore

@@ -1,4 +1,6 @@
 .idea
+*.iml
+.DS_Store
 .venv*
 .pvenv
 .nox

docs/changelog.rst

@@ -9,6 +9,15 @@ License
 .. include:: ../LICENSE
 
 
+Unreleased
+----------
+
+Fixed
+.....
+
+* Fix external needs identifier checked by regex (`#1099 <https://github.com/useblocks/sphinx-needs/pull/1099>`_)
+
+
 2.0.0
 -----
 

sphinx_needs/api/need.py

@@ -196,7 +196,11 @@ def run():
     else:
         need_id = id
 
-    if needs_config.id_regex and not re.match(needs_config.id_regex, need_id):
+    if (
+        needs_config.id_regex
+        and not is_external
+        and not re.match(needs_config.id_regex, need_id)
+    ):
         raise NeedsInvalidException(
             f"Given ID '{need_id}' does not match configured regex '{needs_config.id_regex}'"
         )

tests/doc_test/doc_needs_external_needs/conf.py

@@ -48,3 +48,6 @@
         "id_prefix": "ext_rel_path_",
     },
 ]
+
+# we want to ensure only internal needs are checked against this regex, not the external ones
+needs_id_regex = "INTERNAL.*"

tests/doc_test/doc_needs_external_needs/index.rst

@@ -1,6 +1,11 @@
 TEST DOCUMENT NEEDS EXTERNAL NEEDS
 ==================================
 
+.. spec:: Internal need
+   :id: INTERNAL_001
+
+   An internal requirement with an id check by the regex. External needs identifiers shall not be checked for regex matching.
+
 .. needlist::
    :tags: ext_test