diff --git a/MODULE.bazel b/MODULE.bazel index 7edf970bf..aedcff4bf 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -13,7 +13,7 @@ module( name = "score_docs_as_code", - version = "0.3.3", + version = "0.4.0", compatibility_level = 0, ) @@ -22,7 +22,7 @@ module( # Packaging dependencies # ############################################################################### -bazel_dep(name = "rules_pkg", version = "1.0.1") +bazel_dep(name = "rules_pkg", version = "1.1.0") ############################################################################### # @@ -58,17 +58,17 @@ use_repo(pip, "pip_process") # Additional Python rules provided by aspect, e.g. an improved version of bazel_dep(name = "aspect_rules_py", version = "1.4.0") -bazel_dep(name = "buildifier_prebuilt", version = "7.3.1") +bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2") ############################################################################### # # Generic linting and formatting rules # ############################################################################### -bazel_dep(name = "aspect_rules_lint", version = "1.4.2") +bazel_dep(name = "aspect_rules_lint", version = "1.4.4") # PlantUML for docs -bazel_dep(name = "rules_java", version = "8.11.0") +bazel_dep(name = "rules_java", version = "8.13.0") http_jar = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_jar") @@ -94,8 +94,7 @@ bazel_dep(name = "score_python_basics", version = "0.3.2") bazel_dep(name = "score_cr_checker", version = "0.2.2") # This is only needed to build the examples. -bazel_dep(name = "score_platform", version = "0.1.1") # Grab dash bazel_dep(name = "score_dash_license_checker", version = "0.1.1") -bazel_dep(name = "score_process", version = "0.2.0") +bazel_dep(name = "score_process", version = "1.0.1") diff --git a/docs/BUILD b/docs/BUILD index a3afa8733..2ac04b22f 100644 --- a/docs/BUILD +++ b/docs/BUILD @@ -26,11 +26,6 @@ docs( { "suffix": "latest", # latest main branch documentation build "external_needs_info": [ - { - "base_url": "https://eclipse-score.github.io/score/main", - "json_url": "https://eclipse-score.github.io/score/main/needs.json", - "id_prefix": "score_", - }, { "base_url": "https://eclipse-score.github.io/process_description/main", "json_url": "https://eclipse-score.github.io/process_description/main/needs.json", @@ -41,15 +36,9 @@ docs( { "suffix": "release", # The version imported from MODULE.bazel "target": [ - "@score_platform//docs:docs_needs", "@score_process//process:docs_needs_latest", ], "external_needs_info": [ - { - "base_url": "https://eclipse-score.github.io/score/main", - "json_path": "/score_platform~/docs/docs_needs/_build/needs/needs.json", - "id_prefix": "score_", - }, { "base_url": "https://eclipse-score.github.io/process_description/main", "json_path": "/score_process~/process/docs_needs_latest/_build/needs/needs.json", diff --git a/docs/how-to-integrate/example/index.rst b/docs/how-to-integrate/example/index.rst index 51379cf83..e7e0339ac 100644 --- a/docs/how-to-integrate/example/index.rst +++ b/docs/how-to-integrate/example/index.rst @@ -30,21 +30,21 @@ This is a rendered example of the 'examples/linking-both' folder using the `docs Some content to make sure we also can render this This is a link to an external need inside the 'score' documentation. - :need:`SCORE_feat_req__persistency__config_file`. + :need:`PROCESS_gd_req__req__attr_uid`. Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here `_ -.. feat_req:: Some Title - :id: feat_req__example__some_title +.. tool_req:: Some Title + :id: tool_req__example__some_title :reqtype: Process :security: YES :safety: ASIL_D - :satisfies: SCORE_stkh_req__overall_goals__reuse_of_app_soft + :satisfies: PROCESS_gd_req__req__attr_uid :status: invalid With this requirement we can check if the removal of the prefix is working correctly. - It should remove id_prefix (SCORE _) as it's defined inside the BUILD file and remove it before it checks the leftover value + It should remove id_prefix (PROCESS _) as it's defined inside the BUILD file and remove it before it checks the leftover value against the allowed defined regex in the metamodel Note: The ID is different here as the 'folder structure' is as well diff --git a/docs/how-to-integrate/example/testing/index.rst b/docs/how-to-integrate/example/testing/index.rst index 802a7ced2..353694d41 100644 --- a/docs/how-to-integrate/example/testing/index.rst +++ b/docs/how-to-integrate/example/testing/index.rst @@ -25,18 +25,18 @@ This example will help catch things and bugs when rst's are defined inside a fol Some content to make sure we also can render this. This is a link to an external need inside the 'score' documentation. - :need:`SCORE_feat_req__persistency__config_file`. + :need:`PROCESS_gd_req__req__attr_uid` Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here `_ -.. feat_req:: Some Title - :id: feat_req__testing__some_title +.. tool_req:: Some Title + :id: tool_req__testing__some_title :reqtype: Process :security: YES :safety: ASIL_D - :satisfies: SCORE_stkh_req__overall_goals__reuse_of_app_soft + :satisfies: PROCESS_gd_req__req__attr_uid :status: invalid With this requirement we can check if the removal of the prefix is working correctly. - It should remove id_prefix (SCORE _) as it's defined inside the BUILD file and remove it before it checks the leftover value + It should remove id_prefix (PROCESS _) as it's defined inside the BUILD file and remove it before it checks the leftover value against the 'allowed' defined regex in the metamodel diff --git a/examples/linking-both/BUILD b/examples/linking-both/BUILD index b0863beda..c03e90173 100644 --- a/examples/linking-both/BUILD +++ b/examples/linking-both/BUILD @@ -27,26 +27,24 @@ docs( "suffix": "latest", # latest main branch documentation build "external_needs_info": [ { - "base_url": "https://eclipse-score.github.io/score/main", - "json_url": "https://eclipse-score.github.io/score/main/needs.json", - "id_prefix": "score_", + "base_url": "https://eclipse-score.github.io/process_description/main/", + "json_url": "https://eclipse-score.github.io/process_description/main/needs.json", + "id_prefix": "process_", }, ], }, { "suffix": "release", # The version imported from MODULE.bazel - "target": ["@score_platform//docs:docs_needs"], + "target": ["@score_process//process:docs_needs_latest"], "external_needs_info": [ { - "base_url": "https://eclipse-score.github.io/score/main", - "json_path": "/score_platform~/docs/docs_needs/_build/needs/needs.json", - "id_prefix": "score_", + "base_url": "https://eclipse-score.github.io/process_description/main", + "json_path": "/score_process~/process/docs_needs_latest/_build/needs/needs.json", + "id_prefix": "process_", }, ], }, ], source_dir = "examples/linking-both", - source_files_to_scan_for_needs_links = [ - "//src:score_extension_files", - ], + source_files_to_scan_for_needs_links = [], ) diff --git a/examples/linking-both/index.rst b/examples/linking-both/index.rst index 22d023a4b..24f0d55c5 100644 --- a/examples/linking-both/index.rst +++ b/examples/linking-both/index.rst @@ -33,20 +33,20 @@ This is a simple example of a documentation page using the `docs` tool. Some content to make sure we also can render this This is a link to an external need inside the 'score' documentation. - :need:`SCORE_feat_req__kvs__config_file` + :need:`PROCESS_gd_req__req__attr_uid` Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here `_ -.. feat_req:: Some Title - :id: feat_req__index__some_title +.. tool_req:: Some Title + :id: tool_req__index__some_title :reqtype: Process :security: YES :safety: ASIL_D - :satisfies: SCORE_stkh_req__overall_goals__reuse_of_app_soft + :satisfies: PROCESS_gd_req__req__attr_uid :status: invalid With this requirement we can check if the removal of the prefix is working correctly. - It should remove id_prefix (SCORE _) as it's defined inside the BUILD file and remove it before it checks the leftover value + It should remove id_prefix (PROCESS _) as it's defined inside the BUILD file and remove it before it checks the leftover value against the allowed defined regex in the metamodel diff --git a/examples/linking-both/testing/test.rst b/examples/linking-both/testing/test.rst index 5dcfa9d1d..d5b2ecefc 100644 --- a/examples/linking-both/testing/test.rst +++ b/examples/linking-both/testing/test.rst @@ -25,19 +25,19 @@ This example will help catch things and bugs when rst's are defined inside a fol Some content to make sure we also can render this. This is a link to an external need inside the 'score' documentation. - :need:`SCORE_feat_req__kvs__config_file`. + :need:`PROCESS_gd_req__req__attr_uid` Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here `_ -.. feat_req:: Some Title - :id: feat_req__testing__some_title +.. tool_req:: Some Title + :id: tool_req__testing__some_title :reqtype: Process :security: YES :safety: ASIL_D - :satisfies: SCORE_stkh_req__overall_goals__reuse_of_app_soft + :satisfies: PROCESS_gd_req__req__attr_uid :status: invalid With this requirement we can check if the removal of the prefix is working correctly. - It should remove id_prefix (SCORE _) as it's defined inside the BUILD file and remove it before it checks the leftover value + It should remove id_prefix (PRCOESS _) as it's defined inside the BUILD file and remove it before it checks the leftover value against the 'allowed' defined regex in the metamodel diff --git a/examples/linking-latest/BUILD b/examples/linking-latest/BUILD index f3663c0e5..8866b0a2b 100644 --- a/examples/linking-latest/BUILD +++ b/examples/linking-latest/BUILD @@ -27,16 +27,13 @@ docs( "suffix": "latest", # latest main branch documentation build "external_needs_info": [ { - "base_url": "https://eclipse-score.github.io/score/main", - "json_url": "https://eclipse-score.github.io/score/main/needs.json", - "version": "0.1", - "id_prefix": "score_", + "base_url": "https://eclipse-score.github.io/process_description/main/", + "json_url": "https://eclipse-score.github.io/process_description/main/needs.json", + "id_prefix": "process_", }, ], }, ], source_dir = "examples/linking-latest", - source_files_to_scan_for_needs_links = [ - "//src:score_extension_files", - ], + source_files_to_scan_for_needs_links = [], ) diff --git a/examples/linking-latest/index.rst b/examples/linking-latest/index.rst index 336987e60..6213fac52 100644 --- a/examples/linking-latest/index.rst +++ b/examples/linking-latest/index.rst @@ -16,6 +16,11 @@ Hello World ================= This is a simple example of a documentation page using the `docs` tool. + +Hello World +================= +This is a simple example of a documentation page using the `docs` tool. + .. stkh_req:: TestTitle :id: stkh_req__docs__test_requirement :status: valid @@ -25,6 +30,6 @@ This is a simple example of a documentation page using the `docs` tool. Some content to make sure we also can render this This is a link to an external need inside the 'score' documentation. - :need:`SCORE_feat_req__kvs__config_file`. + :need:`PROCESS_gd_req__req__attr_uid` Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here `_ diff --git a/examples/linking-release/BUILD b/examples/linking-release/BUILD index 5265b8c56..33beef3c1 100644 --- a/examples/linking-release/BUILD +++ b/examples/linking-release/BUILD @@ -25,27 +25,16 @@ docs( docs_targets = [ { "suffix": "release", # The version imported from MODULE.bazel - "target": ["@score_platform//docs:docs_needs"], + "target": ["@score_process//process:docs_needs_latest"], "external_needs_info": [ { "base_url": "https://eclipse-score.github.io/score/main", - "json_path": "/score_platform~/docs/docs_needs/_build/needs/needs.json", - "version": "0.1", - "id_prefix": "score_", + "json_path": "/score_process~/process/docs_needs_latest/_build/needs/needs.json", + "id_prefix": "process_", }, ], }, ], source_dir = "examples/linking-release", - source_files_to_scan_for_needs_links = [ - # Note: you can add filegroups, globs, or entire targets here. - "//src:score_extension_files", - ], + source_files_to_scan_for_needs_links = [], ) - -# ╭───────────────────────────────────────╮ -# │ This is commented out until local │ -# │ multi-repo testing is implemented │ -# ╰───────────────────────────────────────╯ - -# { diff --git a/examples/linking-release/index.rst b/examples/linking-release/index.rst index d2d307257..3cc89afcc 100644 --- a/examples/linking-release/index.rst +++ b/examples/linking-release/index.rst @@ -24,7 +24,6 @@ This is a simple example of a documentation page using the `docs` tool. :reqtype: Functional Some content to make sure we also can render this - This is a link to an external need inside the 'score' documentation - :need:`SCORE_stkh_req__overall_goals__reuse_of_app_soft` + This is a link to an external need inside the 'score' documentation. + :need:`PROCESS_gd_req__req__attr_uid` Note how it starts with the defined prefix but in UPPERCASE. This comes from sphinx-needs, `see here `_ -