Skip to content

Add requirements docs-as-code organization structure#40

Open
jorgecasal wants to merge 2 commits intoeclipse-score:mainfrom
etas-contrib:feature/96545-requirements-docs-as-code
Open

Add requirements docs-as-code organization structure#40
jorgecasal wants to merge 2 commits intoeclipse-score:mainfrom
etas-contrib:feature/96545-requirements-docs-as-code

Conversation

@jorgecasal
Copy link
Contributor

This pull request introduces a three-level requirements hierarchy for the SOME/IP Gateway:

  • docs/requirements/index.rst: conventions reference (folder structure, component names, identifier scheme, mandatory attributes)
  • docs/requirements/stakeholder.rst: stakeholder requirements
  • docs/requirements/feature/index.rst: feature requirements skeleton
  • docs/requirements/component/index.rst: component requirements skeleton
  • docs/tc8_conformance/: TC8 SOME/IP conformance test requirements

@github-actions
Copy link

github-actions bot commented Mar 4, 2026

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
2026/03/04 12:54:08 Downloading https://releases.bazel.build/8.3.0/release/bazel-8.3.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: 72761840-f553-45ad-8dce-7c4a853e6dea
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'googletest', the root module requires module version googletest@1.17.0, but got googletest@1.17.0.bcr.2 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 5 packages loaded
Loading: 5 packages loaded
    currently loading: 
Loading: 5 packages loaded
    currently loading: 
Loading: 5 packages loaded
    currently loading: 
Loading: 5 packages loaded
    currently loading: 
Analyzing: target //:license-check (6 packages loaded, 0 targets configured)
Analyzing: target //:license-check (6 packages loaded, 0 targets configured)

Analyzing: target //:license-check (34 packages loaded, 9 targets configured)

Analyzing: target //:license-check (94 packages loaded, 9 targets configured)

Analyzing: target //:license-check (101 packages loaded, 9 targets configured)

Analyzing: target //:license-check (150 packages loaded, 525 targets configured)

Analyzing: target //:license-check (170 packages loaded, 2627 targets configured)

Analyzing: target //:license-check (171 packages loaded, 4841 targets configured)

Analyzing: target //:license-check (172 packages loaded, 7617 targets configured)

Analyzing: target //:license-check (172 packages loaded, 7617 targets configured)

Analyzing: target //:license-check (172 packages loaded, 7617 targets configured)

Analyzing: target //:license-check (174 packages loaded, 7619 targets configured)

Analyzing: target //:license-check (180 packages loaded, 9645 targets configured)

Analyzing: target //:license-check (181 packages loaded, 9769 targets configured)

Analyzing: target //:license-check (182 packages loaded, 9889 targets configured)

Analyzing: target //:license-check (182 packages loaded, 9889 targets configured)

Analyzing: target //:license-check (182 packages loaded, 9889 targets configured)

Analyzing: target //:license-check (182 packages loaded, 9889 targets configured)

INFO: Analyzed target //:license-check (183 packages loaded, 11824 targets configured).
[8 / 13] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[10 / 13] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
[11 / 13] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 221.408s, Critical Path: 2.52s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@jorgecasal jorgecasal force-pushed the feature/96545-requirements-docs-as-code branch from 8037e1c to f925305 Compare March 4, 2026 12:01
Introduce a three-level requirements hierarchy for the SOME/IP Gateway:

- docs/requirements/index.rst: conventions reference (folder structure,
  component names, identifier scheme, mandatory attributes)
- docs/requirements/stakeholder.rst: stakeholder requirements
- docs/requirements/feature/index.rst: feature requirements skeleton
- docs/requirements/component/index.rst: component requirements skeleton
- docs/tc8_conformance/: TC8 SOME/IP conformance test requirements

Move the placeholder stakeholder requirement from docs/index.rst into
the dedicated stakeholder.rst file and wire the requirements section
into the main documentation toctree.

Fix pip requirements lock file path in MODULE.bazel to match the actual
filename.
@jorgecasal jorgecasal force-pushed the feature/96545-requirements-docs-as-code branch 2 times, most recently from 1ff90de to e1e4803 Compare March 4, 2026 12:26
@github-actions
Copy link

github-actions bot commented Mar 4, 2026

The created documentation from the pull request is available at: docu-html

@jorgecasal jorgecasal force-pushed the feature/96545-requirements-docs-as-code branch from e1e4803 to 5c0a925 Compare March 4, 2026 12:52
@jorgecasal jorgecasal force-pushed the feature/96545-requirements-docs-as-code branch from 5c0a925 to 4c1c643 Compare March 4, 2026 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant