-
Notifications
You must be signed in to change notification settings - Fork 86
demo: render module verification report via score_module_verification_report (tracks docs-as-code#730) #491
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
e4aa503
105de4a
01c79ae
afbc6a8
1425e3d
c5f6614
8603356
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
| name: Docs and Test | ||
| permissions: | ||
| contents: read | ||
| actions: write | ||
| on: | ||
| pull_request: | ||
| types: [opened, reopened, synchronize] | ||
| push: | ||
| branches: | ||
| - main | ||
| merge_group: | ||
| types: [checks_requested] | ||
| workflow_call: | ||
| jobs: | ||
| docs-and-test: | ||
| runs-on: ubuntu-24.04 | ||
| steps: | ||
| - uses: eclipse-score/more-disk-space@6a3b48901846bf7f8cc985925157d71a8973e61f # v1 | ||
| with: | ||
| level: 4 | ||
| - name: Checkout Repository | ||
| uses: actions/checkout@v6 | ||
| - name: Install Graphviz | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y graphviz | ||
| - name: Setup Bazel Cache | ||
| uses: eclipse-score/cicd-actions/setup-bazel-cache@659dcbed63f6b7fbde88c7850125ea0a0a92f939 | ||
| with: | ||
| unique-cache-name: ${{ github.workflow }}-${{ github.job }} | ||
| - name: Run docs_and_test (module verification report) | ||
| run: | | ||
| bazel run //:module_verification_report -- --test-flag=--config=bl-x86_64-linux | ||
| - name: Upload Module Verification Report | ||
| uses: actions/upload-artifact@v6 | ||
| with: | ||
| name: ${{ github.event.repository.name }}_module_verification_report | ||
| path: _build/ | ||
| include-hidden-files: true | ||
| retention-days: 10 |
Large diffs are not rendered by default.
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The document which is the rendered HTML of this rst file looks different to the structure of the module verification report template. This is already existing. In other words, this document https://eclipse-score.github.io/baselibs/pr-491/reporting/module_verification_report.html does not match the structure existing in the module and process definition like here: https://eclipse-score.github.io/baselibs/pr-491/verification_report/module_verification_report.html This relate to the following file as well: https://github.com/eclipse-score/docs-as-code/pull/730/changes#diff-476160124f11cd0e0a38c257375ef66bd5d406a587ce15f92986546948400e32 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| .. | ||
| ****************************************************************************** | ||
| Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
|
|
||
| See the NOTICE file(s) distributed with this work for additional | ||
| information regarding copyright ownership. | ||
|
|
||
| This program and the accompanying materials are made available under the | ||
| terms of the Apache License Version 2.0 which is available at | ||
| https://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| SPDX-License-Identifier: Apache-2.0 | ||
| ****************************************************************************** | ||
|
|
||
| Module Verification Report | ||
| ========================== | ||
|
|
||
| .. document:: Module Verification Report | ||
| :id: doc__baselibs_module_verification_report | ||
| :status: valid | ||
| :safety: QM | ||
| :security: YES | ||
| :version: 1 | ||
| :realizes: wp__feature_arch[version==1] | ||
|
|
||
| This document provides a verification report of the Baselibs feature and its | ||
| associated components. | ||
|
|
||
| .. module-verification-report:: | ||
| :module-id: mod__baselibs | ||
| :feature-id: feat__baselibs | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :status: valid | ||
| :verification-method: test_and_inspection | ||
| :components: comp__baselibs_json, | ||
| comp__baselibs_memory_shared, | ||
| comp__baselibs_result, | ||
| comp__baselibs_bit_manipulation, | ||
| comp__baselibs_containers, | ||
| comp__baselibs_filesystem, | ||
| comp__baselibs_concurrency, | ||
| comp__baselibs_safecpp, | ||
| comp__baselibs_static_reflection, | ||
| comp__baselibs_hash, | ||
| comp__baselibs_flatbuffers, | ||
| comp__baselibs_abi_compatible_data_types |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I imagine different test targets might require different configurations e.g. ITF vs UT. How this can be handled when we have a single target to execute everything in one place?
Can we leave
test_targetsempty if we want to handle execution of tests ourselves and just use it for rendering module verification?