-
Notifications
You must be signed in to change notification settings - Fork 15
feat: Quality pack targets #277
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
Merged
lurtz
merged 13 commits into
eclipse-score:main
from
etas-contrib:feature/quality-pack-targets
Sep 10, 2026
Merged
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
97767df
docs: add component requirements for all 7 components
GabrielPinheiro7891 921722c
docs: wire quality-pack targets, code links and test links
GabrielPinheiro7891 7fc7786
Merge remote-tracking branch 'origin/main' into feature/quality-pack-…
GabrielPinheiro7891 716c734
docs: Simplify documentation and point to docs-as-code
GabrielPinheiro7891 c1f9b39
Merge remote-tracking branch 'origin/main' into feature/quality-pack-…
GabrielPinheiro7891 5f4abbf
ci: add workflow that comments traceability gate on PRs
GabrielPinheiro7891 8590671
docs: move quality pack instructions from docs/ to README
GabrielPinheiro7891 53850b1
docs: remove implementation-derived comp_req entries
GabrielPinheiro7891 f6e9d7e
Merge remote-tracking branch 'origin/main' into feature/quality-pack-…
GabrielPinheiro7891 fd12941
ci: add workflow that comments traceability gate on PRs
GabrielPinheiro7891 461ff90
ci: require quality_pack to pass before merge
GabrielPinheiro7891 775713d
Merge remote-tracking branch 'origin/main' into feature/quality-pack-…
GabrielPinheiro7891 c23da1e
ci(quality-pack): install Graphviz and fix publish workflow header
GabrielPinheiro7891 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| # Builds the docs, runs the upstream //:traceability_gate against the resulting | ||
| # _build/metrics.json, and posts (or edits) a sticky PR comment with the gate | ||
| # output and pass/fail status. | ||
| # | ||
| # The comment step is best-effort: PRs from forks get a read-only GITHUB_TOKEN | ||
| # and the sticky-comment action will fail with 403 — marked continue-on-error | ||
| # so those PRs still surface the numbers via the job log and artifact. | ||
|
|
||
| name: Quality pack coverage comment | ||
|
|
||
| on: | ||
| workflow_call: | ||
|
|
||
| jobs: | ||
| quality-pack-comment: | ||
| runs-on: ubuntu-24.04 | ||
| steps: | ||
| - uses: eclipse-score/more-disk-space@v1 | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v7 | ||
| - name: Create Bazel output base directory | ||
| run: | | ||
| sudo mkdir -p /mnt/.bazel | ||
| sudo chown -R $USER:$USER /mnt/.bazel | ||
| - name: Create config indicator file | ||
| run: echo "host" > .bazel_config | ||
| - name: Setup Bazel | ||
| uses: eclipse-score/cicd-actions/setup-bazel-cache@212bbf86267e9381da9d2daf962d12f6feafbc90 # v0.0.2 | ||
| with: | ||
| unique-cache-name: ${{ github.job }} | ||
| - name: Allow linux-sandbox | ||
| uses: eclipse-score/cicd-actions/unblock-user-namespace-for-linux-sandbox@212bbf86267e9381da9d2daf962d12f6feafbc90 # v0.0.2 | ||
| - name: Build unit + component tests (needed for test links) | ||
| run: bazel test //:unit_tests //:component_tests | ||
| - name: Build docs | ||
| run: bazel run //:docs | ||
| # Thresholds default to 0 while comp_req coverage is being (re-)built up | ||
| # against the SOME/IP protocol spec. Raise the --min-* flags as | ||
| # links land, so the gate never regresses without a follow-up ticket. | ||
| - name: Run traceability gate | ||
| id: gate | ||
| continue-on-error: true | ||
| run: | | ||
| mkdir -p .llm_tmp | ||
|
lurtz marked this conversation as resolved.
Outdated
|
||
| # --need-type=comp_req scopes the gate to component requirements; | ||
| # feat_req / stkh_req live upstream in eclipse-score/score and would | ||
| # otherwise pull the numbers to zero and flap the gate. | ||
| bazel run //:traceability_gate -- \ | ||
| --metrics-json "$PWD/_build/metrics.json" \ | ||
| --need-type=comp_req \ | ||
| > .llm_tmp/gate.txt | ||
| - name: Render sticky comment body | ||
| run: | | ||
| if [ "${{ steps.gate.outcome }}" = "success" ]; then | ||
| status="**PASS**" | ||
| else | ||
| status="**FAIL**" | ||
| fi | ||
| { | ||
| echo '<!-- quality-pack-coverage -->' | ||
| echo "### Quality pack traceability — gate: $status" | ||
| echo | ||
| echo '```text' | ||
| cat .llm_tmp/gate.txt | ||
| echo '```' | ||
| echo | ||
| echo "<sub>Produced by \`//:traceability_gate\` against \`_build/metrics.json\`.</sub>" | ||
| } > .llm_tmp/comment.md | ||
| cat .llm_tmp/comment.md | ||
| - name: Upload metrics + gate output | ||
| if: always() | ||
| uses: actions/upload-artifact@v7 | ||
| with: | ||
| name: quality-pack-metrics | ||
| path: | | ||
| _build/metrics.json | ||
| .llm_tmp/gate.txt | ||
| .llm_tmp/comment.md | ||
| if-no-files-found: warn | ||
| retention-days: 14 | ||
| - name: Post sticky PR comment | ||
| if: github.event_name == 'pull_request' | ||
| continue-on-error: true | ||
| uses: marocchino/sticky-pull-request-comment@52423e01640425a022ef5fd42c6fb5f633a02728 # v2.9.1 | ||
|
lurtz marked this conversation as resolved.
Outdated
|
||
| with: | ||
| header: quality-pack-coverage | ||
| path: .llm_tmp/comment.md | ||
|
lurtz marked this conversation as resolved.
Outdated
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| load("@score_docs_as_code//:docs.bzl", "docs_bundle") | ||
|
|
||
| # Docs bundle for this component. Kept in its own package so the parent | ||
| # BUILD does not need to load @score_docs_as_code. | ||
| docs_bundle( | ||
| name = "docs_bundle", | ||
| source_dir = "", | ||
| visibility = ["//visibility:public"], | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| .. _config: | ||
|
|
||
| Config | ||
| ###### | ||
|
|
||
| .. comp:: Config | ||
| :id: comp__config | ||
| :security: NO | ||
| :safety: QM | ||
| :status: valid | ||
| :version: 1 | ||
| :belongs_to: feat__someip_gateway | ||
|
|
||
| Abstract | ||
| ======== | ||
|
|
||
| Provides the FlatBuffers schema (mw_someip_config.fbs) and JSON schema used to define and validate gateway configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| load("@score_docs_as_code//:docs.bzl", "docs_bundle") | ||
|
|
||
| # Docs bundle for this component. Kept in its own package so the parent | ||
| # BUILD does not need to load @score_docs_as_code. | ||
| docs_bundle( | ||
| name = "docs_bundle", | ||
| source_dir = "", | ||
| visibility = ["//visibility:public"], | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| .. _gatewayd: | ||
|
|
||
| gatewayd | ||
| ######## | ||
|
|
||
| Abstract | ||
| ======== | ||
|
|
||
| The gateway daemon. Bridges local IPC service instances with remote SOME/IP service instances across the ASIL boundary, handling service offers, requests, event subscriptions, and payload transfer. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| load("@score_docs_as_code//:docs.bzl", "docs_bundle") | ||
|
|
||
| # Docs bundle for this component. Kept in its own package so the parent | ||
| # BUILD does not need to load @score_docs_as_code. | ||
| docs_bundle( | ||
| name = "docs_bundle", | ||
| source_dir = "", | ||
| visibility = ["//visibility:public"], | ||
| ) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.