feat: add creation of variant docs #113

xxthunder · 2024-01-03T16:22:29Z

backup

github-actions · 2024-01-03T16:31:54Z

Test Results

42 tests 42 ✅ 3m 5s ⏱️
1 suites 0 💤
1 files 0 ❌

Results for commit 327872c.

♻️ This comment has been updated with latest results.

backup

cuinixam · 2024-01-09T10:47:07Z

Pipfile

 cookiecutter = {version="==2.1.1"}
 gcovr = "*"
 hammocking = "*"
 kconfiglib = "*"

 [dev-packages]
+jinja2 = "*"


Copied all dependencies from SPLED to make sure the docs and spl-core python integration tests are working.
Keep in mind that the integration tests are using the spl-core python venv, that is why we have to add so many dev dependencies.

cuinixam · 2024-01-09T10:48:31Z

docs/about/index.rst

@@ -1 +1,4 @@
+📄 About


Create extra chapter to avoid the long list of CHANGELOG entries in the main toc tree.

cuinixam · 2024-01-09T10:49:16Z

docs/features/index.rst

@@ -0,0 +1,19 @@
+✨ Features


This chapter describes the main spl-core features for the users.

cuinixam · 2024-01-09T10:49:42Z

docs/getting_started/concepts.rst

@@ -4,25 +4,27 @@ Basic Concepts and Naming Conventions
 What is a Software Product Line (SPL)?
 --------------------------------------

-An SPL is a software project that contains shared and configurable source code elements known as `components <https://engweb.marquardt.de/sple/spl-core/develop/getting_started/concepts.html#what-is-a-component>`_, which are used to develop several versions of a computer program, also known as `variants <https://engweb.marquardt.de/sple/spl-core/develop/getting_started/concepts.html#what-is-a-variant>`_.
+An SPL is a software project that contains shared and configurable source code elements known as :ref:`components <what_is_a_component>`, which are used to develop several versions of a computer program, also known as :ref:`variants <what_is_a_variant>`.


Remove all hardcoded references!

cuinixam · 2024-01-09T11:00:19Z

docs/reference/index.rst

@@ -1,8 +1,9 @@
-🔧 Reference
+🛠️ Reference


The old emoji was looking like a bone 😞

cuinixam · 2024-01-09T11:01:23Z

src/common/cmake.py

@@ -26,8 +26,7 @@ def configure(self, variant: Variant, build_kit: str = "prod"):
            f" -B{self.workspace_artifacts.get_build_dir(variant, build_kit)}"
            f" -G Ninja "
            f" -DBUILD_KIT:STRING={build_kit}"
-            f" -DFLAVOR:STRING={variant.flavor}"
-            f" -DSUBSYSTEM:STRING={variant.subsystem}"
+            f" -DVARIANT:STRING={variant.to_string()}"


SPL core needs to know about a variant. The flavor and subsystem information is obsolete.

cuinixam · 2024-01-09T11:03:46Z

src/project_creator/templates/project/{{cookiecutter.name}}/Pipfile

@@ -4,25 +4,30 @@ verify_ssl = true
 name = "pypi"

 [packages]


Copy all dependencies from SPLED to get the documentation and integration tests working

cuinixam · 2024-01-09T11:21:25Z

cmake/common.cmake

+
+")
+
+                # create the code coverage rst file


Create coverate rst file to be able to automatically link to the coverage/index.html

cuinixam · 2024-01-09T11:22:14Z

cmake/common.cmake

-                    \"component_test_junit_xml\": \"${_component_test_junit_xml}\",
-                    \"include_patterns\": [\"${_rel_component_doc_dir}/**\",\"${_rel_sphinx_output_dir}/**\"]
-                }")
+    \"component_info\": ${_component_info},


No need to store multiple keys for a component. All component relevant info is stored in component_info

cuinixam · 2024-01-09T11:23:56Z

cmake/common.cmake

+                set(_cov_out_html reports/html/${_rel_component_reports_out_dir}/coverage/index.html)
+                file(RELATIVE_PATH _cov_out_json ${CMAKE_CURRENT_BINARY_DIR} ${_component_coverage_json})
+                add_custom_command(
+                    OUTPUT ${_cov_out_html}


For the component report, one needs to generate the coverage/index.html inside the component report sphinx output directory. This will avoid the need to copy the coverage/* directory inside the component report sphinx output directory.

cuinixam · 2024-01-09T11:24:28Z

cmake/common.cmake

+                )
+
+                # No OUTPUT is defined to force execution of this target every time
+                add_custom_target(


We need to split the component doxygen generation target because it is required by both, the component and variant reports.

cuinixam · 2024-01-09T11:28:48Z

cmake/common.cmake

+")
+
+    # Iterate over all components and create coverage and doxysphinx variant specific targets
+    foreach(component_info ${COMPONENTS_INFO})


For every component we need to create specific coverage and doxysphinx targets to make sure the output files are generate in the overall variant sphinx output directory. This will avoid the need to copy all the component coverage and doxygen files from the component directories to the variant directory.

cuinixam

👍🚀🤖

xxthunder force-pushed the feature/target-SWE.1-report-SWE.6 branch 4 times, most recently from f91b678 to 6308d97 Compare January 4, 2024 08:07

xxthunder changed the title ~~feat: new target for overall docs - SWE.1 SW requirements~~ feat: add creation of variant docs Jan 4, 2024

feat: add creation of variant docs

5a21b92

backup

xxthunder force-pushed the feature/target-SWE.1-report-SWE.6 branch 3 times, most recently from 9014896 to 63b230d Compare January 4, 2024 16:12

xxthunder self-assigned this Jan 4, 2024

xxthunder added enhancement New feature or request don't merge labels Jan 4, 2024

xxthunder force-pushed the feature/target-SWE.1-report-SWE.6 branch from 63b230d to 12cac27 Compare January 4, 2024 16:41

feat: we need generated rst files for every component

642b15f

cuinixam force-pushed the feature/target-SWE.1-report-SWE.6 branch from 12cac27 to 642b15f Compare January 5, 2024 11:10

cuinixam and others added 2 commits January 5, 2024 15:48

feat: add variant reports target

8ce5c75

chore: review and refactor variant reports target

f0e0caa

xxthunder force-pushed the feature/target-SWE.1-report-SWE.6 branch from 5353ef3 to f0e0caa Compare January 6, 2024 18:30

cuinixam force-pushed the feature/target-SWE.1-report-SWE.6 branch from bc4616a to fedd9f7 Compare January 8, 2024 15:48

feat: add coverage and doxygen to variant report

b5c8923

cuinixam force-pushed the feature/target-SWE.1-report-SWE.6 branch from fedd9f7 to b5c8923 Compare January 8, 2024 15:53

chore: update spl project template

1cae615

cuinixam force-pushed the feature/target-SWE.1-report-SWE.6 branch from 8b1fb2d to 1cae615 Compare January 9, 2024 09:00

docs: describe spl features and cmake targets

0da12f4

cuinixam force-pushed the feature/target-SWE.1-report-SWE.6 branch from df8278d to 0da12f4 Compare January 9, 2024 10:43

cuinixam reviewed Jan 9, 2024

View reviewed changes

chore: fix all review findings

327872c

cuinixam reviewed Jan 9, 2024

View reviewed changes

cuinixam approved these changes Jan 9, 2024

View reviewed changes

cuinixam removed the don't merge label Jan 9, 2024

cuinixam merged commit c4b3b0a into develop Jan 9, 2024
4 checks passed

cuinixam deleted the feature/target-SWE.1-report-SWE.6 branch January 9, 2024 12:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add creation of variant docs #113

feat: add creation of variant docs #113

xxthunder commented Jan 3, 2024

github-actions bot commented Jan 3, 2024 •

edited

Loading

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam Jan 9, 2024

cuinixam left a comment

feat: add creation of variant docs #113

feat: add creation of variant docs #113

Conversation

xxthunder commented Jan 3, 2024

github-actions bot commented Jan 3, 2024 • edited Loading

Test Results

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cuinixam left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 3, 2024 •

edited

Loading