Skip to content

fist draft - Verification report#540

Draft
FScholPer wants to merge 1 commit into
mainfrom
verification_report_schema_ext
Draft

fist draft - Verification report#540
FScholPer wants to merge 1 commit into
mainfrom
verification_report_schema_ext

Conversation

@FScholPer
Copy link
Copy Markdown
Contributor

@FScholPer FScholPer commented May 19, 2026

📌 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
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.4.2) and connecting to it...
INFO: Invocation ID: 8b60fadd-7e11-43c7-bd36-d8a5863c5d00
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
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: 4.589s
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

1 participant