Skip to content

docs: add stp and rtm documents#1210

Open
Ron (rjaegers) wants to merge 14 commits intomainfrom
docs/add-stp-and-rtm-documents
Open

docs: add stp and rtm documents#1210
Ron (rjaegers) wants to merge 14 commits intomainfrom
docs/add-stp-and-rtm-documents

Conversation

@rjaegers
Copy link
Copy Markdown
Member

@rjaegers Ron (rjaegers) commented Mar 20, 2026

🚀 Hey, I have created a Pull Request

Description of changes

This pull request introduces significant improvements to the documentation generation workflow and formalizes requirements traceability for the project. It adds new document templates for the Software Test Plan (STP) and Requirements Traceability Matrix (RTM), enhances metadata and traceability in generated documents, and updates the GitHub Actions workflows to support these changes. Additionally, it improves test-to-requirement mapping in integration tests.

Documentation generation and traceability improvements:

  • Added new templates for the Software Test Plan (software-test-plan.md.j2) and Requirements Traceability Matrix (requirements-traceability-matrix.md.j2), providing formalized, automatically generated documentation for test planning and requirements coverage. [1] [2]
  • Enhanced the Software Requirements Specification template (software-requirements-specification.md.j2) with dynamic metadata (generation date, version, git revision), document control, scope, and references sections. Also added a watermark for non-release builds and improved footer information. [1] [2] [3]

Workflow and automation updates:

  • Updated the documentation generation workflow (wc-document-generation.yml) to accept an is-release input, generate all three document types (SRS, STP, RTM) in both Markdown and PDF, and include a document control SBDL aspect for traceability metadata. [1] [2]
  • Modified the release build workflow (release-build.yml) to pass the is-release: true flag and ensure all generated .pdf and .sbdl files are uploaded to the release. [1] [2]

Test traceability enhancements:

  • Annotated integration tests in integration-tests.bats with SBDL comments to map each test to its corresponding requirement, enabling automated traceability in the generated RTM and STP documents. [1] [2] [3] [4] [5]

✔️ Checklist

  • I have followed the contribution guidelines for this repository
  • I have added tests for new behavior, and have not broken any existing tests
  • I have added or updated relevant documentation
  • I have verified that all added components are accounted for in the SBOM

@rjaegers Ron (rjaegers) requested a review from a team as a code owner March 20, 2026 11:20
Copilot AI review requested due to automatic review settings March 20, 2026 11:20
@rjaegers Ron (rjaegers) marked this pull request as draft March 20, 2026 11:20
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 20, 2026

⚠️MegaLinter analysis: Success with warnings

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ ACTION actionlint 23 0 0 0.27s
✅ DOCKERFILE hadolint 3 0 0 0.3s
✅ JSON npm-package-json-lint yes no no 0.58s
✅ JSON prettier 21 4 0 0 0.76s
✅ JSON v8r 21 0 0 10.07s
✅ MARKDOWN markdownlint 12 0 0 0 1.16s
✅ MARKDOWN markdown-table-formatter 12 0 0 0 0.55s
✅ REPOSITORY checkov yes no no 26.94s
✅ REPOSITORY gitleaks yes no no 1.25s
✅ REPOSITORY git_diff yes no no 0.01s
✅ REPOSITORY grype yes no no 43.52s
✅ REPOSITORY secretlint yes no no 2.41s
✅ REPOSITORY syft yes no no 2.26s
✅ REPOSITORY trivy yes no no 14.07s
✅ REPOSITORY trivy-sbom yes no no 0.57s
✅ REPOSITORY trufflehog yes no no 6.58s
⚠️ SPELL lychee 83 1 0 10.44s
✅ YAML prettier 31 0 0 0 1.18s
✅ YAML v8r 31 0 0 11.72s
✅ YAML yamllint 31 0 0 1.5s

Detailed Issues

⚠️ SPELL / lychee - 1 error
[IGNORED] docker://pandoc/extra:3.9.0.0-ubuntu@sha256:72afa9c8d3300e5f10c9c4330e101725687f2179bffd912fb859c6d2ae85de62 | Unsupported: Error creating request client: builder error for url (docker://pandoc/extra:3.9.0.0-ubuntu@sha256:72afa9c8d3300e5f10c9c4330e101725687f2179bffd912fb859c6d2ae85de62)
[403] https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads | Network error: Forbidden
[IGNORED] https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/philips-software/amp-devcontainer | Unsupported: Error creating request client: builder error for url (vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/philips-software/amp-devcontainer)
📝 Summary
---------------------
🔍 Total..........126
✅ Successful.....123
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
❓ Unknown..........0
🚫 Errors...........1

Errors in .github/TOOL_VERSION_ISSUE_TEMPLATE.md
[403] https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads | Network error: Forbidden

See detailed reports in MegaLinter artifacts

You could have the same capabilities but better runtime performances if you use a MegaLinter flavor:

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

  • Documentation: Custom Flavors
  • Command: npx mega-linter-runner@9.4.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,DOCKERFILE_HADOLINT,JSON_V8R,JSON_PRETTIER,JSON_NPM_PACKAGE_JSON_LINT,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_GITLEAKS,REPOSITORY_GRYPE,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 20, 2026

📦 Container Size Analysis

Note

Comparing ghcr.io/philips-software/amp-devcontainer-base:edgeghcr.io/philips-software/amp-devcontainer-base:pr-1210

📈 Size Comparison Table

OS/Platform Previous Current Change Trend
linux/amd64 145.22 MB 145.22 MB 630 B (0%) 🔽
linux/arm64 137.54 MB 137.54 MB 211 B (0%) 🔽

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds generated quality-system documentation (STP + RTM) alongside the existing SRS, and updates the document-generation workflow to build these documents from the SBDL model (now including BATS integration tests).

Changes:

  • Add Jinja2 templates for a Software Test Plan (STP) and Requirements Traceability Matrix (RTM).
  • Extend the SRS template with Scope/References/Document Control content.
  • Update the reusable document-generation workflow to compile an SBDL model from both Gherkin features and a BATS test file, then render SRS/STP/RTM PDFs.

Reviewed changes

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

Show a summary per file
File Description
test/cpp/integration-tests.bats Adds an inline SBDL test trace annotation for a BATS test.
docs/templates/software-test-plan.md.j2 New STP template rendering tests traced to requirements.
docs/templates/software-requirements-specification.md.j2 Adds scope + document control sections to the generated SRS.
docs/templates/requirements-traceability-matrix.md.j2 New RTM template mapping requirements to tests and computing coverage summary.
.github/workflows/wc-document-generation.yml Generates STP/RTM markdown + PDFs and compiles the SBDL model from features + BATS.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 20, 2026

Test Results

 13 files  ±0   13 suites  ±0   19m 10s ⏱️ +54s
 33 tests ±0   33 ✅ ±0  0 💤 ±0  0 ❌ ±0 
137 runs  ±0  137 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 43e71f4. ± Comparison against base commit 574dd85.

♻️ This comment has been updated with latest results.

Ron (rjaegers) and others added 2 commits March 31, 2026 16:49
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Ron <45816308+rjaegers@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 31, 2026

📦 Container Size Analysis

Note

Comparing ghcr.io/philips-software/amp-devcontainer-rust:edgeghcr.io/philips-software/amp-devcontainer-rust:pr-1210

📈 Size Comparison Table

OS/Platform Previous Current Change Trend
linux/amd64 455.71 MB 455.71 MB 658 B (0%) 🔽
linux/arm64 408.89 MB 408.89 MB +683 B (+0%) 🔼

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 31, 2026

📦 Container Size Analysis

Note

Comparing ghcr.io/philips-software/amp-devcontainer-cpp:edgeghcr.io/philips-software/amp-devcontainer-cpp:pr-1210

📈 Size Comparison Table

OS/Platform Previous Current Change Trend
linux/amd64 544.28 MB 544.28 MB 726 B (0%) 🔽
linux/arm64 525.77 MB 525.77 MB 197 B (0%) 🔽

@rjaegers Ron (rjaegers) temporarily deployed to acceptance-testing April 1, 2026 14:41 — with GitHub Actions Inactive
@rjaegers Ron (rjaegers) temporarily deployed to acceptance-testing April 1, 2026 15:25 — with GitHub Actions Inactive
@rjaegers Ron (rjaegers) temporarily deployed to acceptance-testing April 1, 2026 18:32 — with GitHub Actions Inactive
@rjaegers Ron (rjaegers) temporarily deployed to acceptance-testing April 1, 2026 19:12 — with GitHub Actions Inactive
@rjaegers Ron (rjaegers) temporarily deployed to acceptance-testing April 2, 2026 08:22 — with GitHub Actions Inactive
@rjaegers Ron (rjaegers) temporarily deployed to acceptance-testing April 2, 2026 10:13 — with GitHub Actions Inactive
@rjaegers Ron (rjaegers) temporarily deployed to acceptance-testing April 2, 2026 12:35 — with GitHub Actions Inactive
@rjaegers Ron (rjaegers) marked this pull request as ready for review April 2, 2026 13:05
Copilot AI review requested due to automatic review settings April 2, 2026 13:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@rjaegers Ron (rjaegers) enabled auto-merge April 2, 2026 13:24
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 2, 2026

@rjaegers Ron (rjaegers) deployed to acceptance-testing April 2, 2026 18:04 — with GitHub Actions Active
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.

3 participants