Skip to content

feat: add opt-in cross-module compatibility warnings - #676

Merged
AlexanderLanin merged 4 commits into
eclipse-score:mainfrom
etas-contrib:errors
Aug 5, 2026
Merged

feat: add opt-in cross-module compatibility warnings#676
AlexanderLanin merged 4 commits into
eclipse-score:mainfrom
etas-contrib:errors

Conversation

@AlexanderLanin

@AlexanderLanin AlexanderLanin commented Jul 31, 2026

Copy link
Copy Markdown
Member

Summary

Today, any validation mismatch in an integrated documentation build aborts the build. This is correct and safe, but it prevents integration entirely until every participating module is perfectly aligned.

This feature allows integration to proceed during temporary version skew, but only for explicitly enabled, well-defined cross-module compatibility cases. It does not suppress arbitrary validation failures: local findings and every non-enabled category remain fatal.

Enabled compatibility findings stay highly visible: they are emitted in the build output, shown prominently on the generated documentation start page, and written to JSON and HTML reports for CI follow-up.

Supported opt-in cases

  • missing mandatory attributes in mounted or imported documentation modules
  • missing mandatory links in mounted or imported documentation modules
  • version mismatches in need links when at least one endpoint is external

Refs #674

Refs eclipse-score#674

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

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: 9f73e60c-b0ec-44e1-94b4-e5b016b07092
Computing main repo mapping: 
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: 6.129s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@AlexanderLanin AlexanderLanin changed the title feat: report cross-module compatibility findings feat: add opt-in cross-module compatibility warnings Jul 31, 2026
@github-actions

Copy link
Copy Markdown
Contributor

The created documentation from the pull request is available at: docu-html

# Conflicts:
#	bzl/mount_rules.bzl
#	src/extensions/score_mounts/_resolver.py
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-676: https://eclipse-score.github.io/docs-as-code/pr-676/

# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Cross-Module Compatibility Findings

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is not a how-to. This belongs under docs/concept/.

@AlexanderLanin
AlexanderLanin merged commit 718c908 into eclipse-score:main Aug 5, 2026
17 checks passed
@AlexanderLanin
AlexanderLanin deleted the errors branch August 5, 2026 15:16
a-zw added a commit to etas-contrib/score_docs-as-code that referenced this pull request Aug 6, 2026
AlexanderLanin pushed a commit that referenced this pull request Aug 6, 2026
* chore: update to process 2.0.3

* fix: integration race between PRs #684 and #676
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Development

Successfully merging this pull request may close these issues.

3 participants