Skip to content

fist draft - Verification report#540

Draft
FScholPer wants to merge 2 commits into
mainfrom
verification_report_schema_ext
Draft

fist draft - Verification report#540
FScholPer wants to merge 2 commits into
mainfrom
verification_report_schema_ext

Conversation

@FScholPer

@FScholPer FScholPer commented May 19, 2026

Copy link
Copy Markdown
Contributor

📌 Description

Implements:
eclipse-score/process_description#686 & #538

Potiential next steps:

  1. Enforce that contract with Sphinx-Needs schema validation
    In process_description conf, define:
    needs_fields for those fields
    needs_schema_definitions_from_json for strict checks (required fields, enums, allowed sections)
    CI runs sphinx with -W, so description/section drift becomes a failing warning/error
  2. Export validated model as needs.json
    Turn on needs_build_json in process_description build.
    Gives a validated, typed, machine-readable contract artifact.
  3. Consume in docs-as-code and generate schema descriptions
    In docs-as-code, import process contract via needimport or needs_external_needs.
    Generate/refresh JSON schema description texts from imported need items.
    Keep structure in your existing schema files, but descriptions come from validated needs data.
  4. Add a drift gate
    Compare generated schema fragments against checked-in schema files.
    If process description text changes and schema wasn’t regenerated, CI fails.

🚨 Impact Analysis

  • This change does not violate any tool requirements and is covered by existing tool requirements
  • This change does not violate any design decisions
  • Otherwise I have created a ticket for new tool qualification

✅ Checklist

  • Added/updated documentation for new or changed features
  • Added/updated tests to cover the changes
  • Followed project coding standards and guidelines

Frank Scholter Peres frank.scholter_peres@mercedes-benz.com, Mercedes-Benz Tech Innovation GmbH
Provider Information

@github-actions

github-actions Bot commented May 19, 2026

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //src: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: 79155e9a-3727-4612-8cb9-2618ee674c02
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
WARNING: Target pattern parsing failed.
ERROR: Skipping '//src:license-check': no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
ERROR: no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
INFO: Elapsed time: 5.486s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@FScholPer FScholPer linked an issue May 19, 2026 that may be closed by this pull request
@FScholPer FScholPer changed the title fist draft fist draft - Verification report May 19, 2026


def _load_json(path: Path) -> dict:
return json.loads(path.read_text(encoding="utf-8"))
process_template = _resolve_path(args.process_template)
report_schema = _resolve_path(args.report_schema)

if not process_template.exists():
if not process_template.exists():
print(f"Error: process template not found: {process_template}", file=sys.stderr)
return 1
if not report_schema.exists():
print(f"Error: report schema not found: {report_schema}", file=sys.stderr)
return 1

template_text = process_template.read_text(encoding="utf-8")
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Thanks for the pull request. This thread has been quiet for 30 days, so we are marking it as stale for now. Please take a quick look and let us know whether it is still up to date, still relevant, needs review, or is ready to merge. Any new activity will remove the stale label automatically. If nothing changes in the next 10 days, we will close it to keep the backlog current.

@github-actions github-actions Bot added the stale label Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: No status

2 participants