Skip to content

Add ts client component requirements - #149

Draft
ryan-steel wants to merge 11 commits into
eclipse-score:mainfrom
etas-contrib:add-ts_client-component-requirements
Draft

Add ts client component requirements#149
ryan-steel wants to merge 11 commits into
eclipse-score:mainfrom
etas-contrib:add-ts_client-component-requirements

Conversation

@ryan-steel

@ryan-steel ryan-steel commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Adds component requirements documentation for ts_client following S-CORE requirements engineering process and module_template.

Note: Component definition (comp__time_ts_client) and architecture documentation not yet complete, so satisfied_by fields will create docs build errors if these docs are included at the moment.

Note, this doesn't include the changes required to include these docs in the docs build. Those changes are handled in #148 already and would rather avoid conflicts.

Changes:

  • Updated docs/index.rst with proper "Time Sync Client" component name and requirements links
  • Added docs/requirements/requirements.rst with 6 component requirements following template structure

Requirements follow QM safety level and NO security classification to match feature requirements. All requirements use time_ts_client module_component naming pattern.

Related ticket

Addresses part of #97

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

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]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 1615ae8e-a118-4fbb-9506-c0ee26bdaf4c
Computing main repo mapping: 
WARNING: /home/runner/work/time/time/MODULE.bazel:13:7: The attribute 'compatibility_level' in module() is a no-op and will be removed in a future Bazel release. Please remove it from your MODULE.bazel file.
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 3 packages loaded
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

Analyzing: target //:license-check (40 packages loaded, 10 targets configured)

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

Analyzing: target //:license-check (144 packages loaded, 3098 targets configured)

Analyzing: target //:license-check (152 packages loaded, 6157 targets configured)

Analyzing: target //:license-check (157 packages loaded, 9225 targets configured)

Analyzing: target //:license-check (164 packages loaded, 9275 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (168 packages loaded, 11172 targets configured)

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

INFO: Analyzed target //:license-check (170 packages loaded, 11422 targets configured).
[6 / 15] [Prepa] Writing repo mapping manifest for //:license.check.license_check
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[14 / 16] [Prepa] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar
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: 28.339s, Critical Path: 2.53s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 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>]

@ryan-steel
ryan-steel force-pushed the add-ts_client-component-requirements branch from 2956a19 to 1daac44 Compare August 4, 2026 14:49
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

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

@ryan-steel
ryan-steel marked this pull request as ready for review August 5, 2026 08:49
@ryan-steel
ryan-steel force-pushed the add-ts_client-component-requirements branch from 21fc11f to 2641242 Compare August 6, 2026 09:53
@ryan-steel
ryan-steel requested a lite review from Copilot August 6, 2026 10:01

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds S-CORE process documentation for the score/ts_client component, primarily introducing component requirements plus the associated inspection/checklist scaffolding and initial architecture documentation structure.

Changes:

  • Added component requirements and AoU requirements for the Time Sync Client (ts_client) in Sphinx-needs format.
  • Added requirements and architecture toctrees and inspection checklist documents for ts_client.
  • Updated component doc navigation (including a change to time_slave’s docs index).

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
score/ts_client/docs/requirements/requirements.rst New component requirements and AoU requirement definitions for ts_client.
score/ts_client/docs/requirements/index.rst Requirements section toctree for the ts_client docs.
score/ts_client/docs/requirements/chklst_req_inspection.rst Requirements inspection checklist content and needtables (currently includes template placeholders).
score/ts_client/docs/index.rst Top-level ts_client component doc entry and links to requirements/architecture sections.
score/ts_client/docs/architecture/index.rst Architecture section toctree for the ts_client docs.
score/ts_client/docs/architecture/component_architecture.rst Initial component architecture document and comp / static+dynamic view needs.
score/ts_client/docs/architecture/chklst_arc_inspection.rst Architecture inspection checklist document.
score/ts_client/docs/.gitkeep Placeholder for docs directory.
score/time_slave/docs/index.rst Removes multiple toctree entries from the time_slave docs index.
Suppressed comments (3)

score/ts_client/docs/requirements/chklst_req_inspection.rst:48

  • Typo in the inspection roles list: duplicated "is" in "who is is".
- moderator: <committer explicitly named here, who is is the safety manager, security manager or quality manager initiating the inspection>

score/time_slave/docs/index.rst:22

  • This PR removes the time_slave docs toctree entries for architecture/requirements/manuals/etc., but that change isn’t mentioned in the PR description. If the intent is to temporarily omit these sections (e.g., because the pages don’t exist yet), add an explanatory note here (or move this change to a separate PR).
.. toctree::
   :maxdepth: 1

   component_classification

score/ts_client/docs/requirements/chklst_req_inspection.rst:187

  • The AoU inspection needtable still uses the template placeholder "component_name" in both the filter and tag selector, so it will never match this component’s needs.
.. needtable::
   :filter: "component_name" in docname and "requirements" in docname and docname is not None and status == "valid"
   :style: table
   :types: aou_req
   :tags: component_name

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread score/ts_client/docs/requirements/requirements.rst Outdated
Comment thread score/ts_client/docs/requirements/chklst_req_inspection.rst
Comment thread score/ts_client/docs/requirements/chklst_req_inspection.rst Outdated
Comment thread score/ts_client/docs/architecture/chklst_arc_inspection.rst Outdated
Comment thread score/ts_client/docs/architecture/component_architecture.rst Outdated
@ryan-steel
ryan-steel force-pushed the add-ts_client-component-requirements branch from ff3cbf3 to 117b34b Compare August 7, 2026 13:53
@ryan-steel
ryan-steel force-pushed the add-ts_client-component-requirements branch from 117b34b to 1e10633 Compare August 13, 2026 10:25
@ryan-steel
ryan-steel marked this pull request as draft August 13, 2026 11:58
@ryan-steel
ryan-steel force-pushed the add-ts_client-component-requirements branch from 1e10633 to 1910331 Compare August 14, 2026 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

2 participants